Index: docs/epy/apiclient.schema-module.html |
=================================================================== |
new file mode 100644 |
--- /dev/null |
+++ b/docs/epy/apiclient.schema-module.html |
@@ -0,0 +1,208 @@ |
+<?xml version="1.0" encoding="ascii"?> |
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
+ "DTD/xhtml1-transitional.dtd"> |
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
+<head> |
+ <title>apiclient.schema</title> |
+ <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
+ <script type="text/javascript" src="epydoc.js"></script> |
+</head> |
+ |
+<body bgcolor="white" text="black" link="blue" vlink="#204080" |
+ alink="#204080"> |
+<!-- ==================== NAVIGATION BAR ==================== --> |
+<table class="navbar" border="0" width="100%" cellpadding="0" |
+ bgcolor="#a0c0ff" cellspacing="0"> |
+ <tr valign="middle"> |
+ |
+ <!-- Tree link --> |
+ <th> <a |
+ href="module-tree.html">Trees</a> </th> |
+ |
+ <!-- Index link --> |
+ <th> <a |
+ href="identifier-index.html">Indices</a> </th> |
+ |
+ <!-- Help link --> |
+ <th> <a |
+ href="help.html">Help</a> </th> |
+ |
+ <th class="navbar" width="100%"></th> |
+ </tr> |
+</table> |
+<table width="100%" cellpadding="0" cellspacing="0"> |
+ <tr valign="top"> |
+ <td width="100%"> |
+ <span class="breadcrumbs"> |
+ <a href="apiclient-module.html">Package apiclient</a> :: |
+ Module schema |
+ </span> |
+ </td> |
+ <td> |
+ <table cellpadding="0" cellspacing="0"> |
+ <!-- hide/show private --> |
+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
+ onclick="toggle_private();">hide private</a>]</span></td></tr> |
+ <tr><td align="right"><span class="options" |
+ >[<a href="frames.html" target="_top">frames</a |
+ >] | <a href="apiclient.schema-module.html" |
+ target="_top">no frames</a>]</span></td></tr> |
+ </table> |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== MODULE DESCRIPTION ==================== --> |
+<h1 class="epydoc">Module schema</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.schema-pysrc.html">source code</a></span></p> |
+<pre class="literalblock"> |
+Schema processing for discovery based APIs |
+ |
+Schemas holds an APIs discovery schemas. It can return those schema as |
+deserialized JSON objects, or pretty print them as prototype objects that |
+conform to the schema. |
+ |
+For example, given the schema: |
+ |
+ schema = """{ |
+ "Foo": { |
+ "type": "object", |
+ "properties": { |
+ "etag": { |
+ "type": "string", |
+ "description": "ETag of the collection." |
+ }, |
+ "kind": { |
+ "type": "string", |
+ "description": "Type of the collection ('calendar#acl').", |
+ "default": "calendar#acl" |
+ }, |
+ "nextPageToken": { |
+ "type": "string", |
+ "description": "Token used to access the next |
+ page of this result. Omitted if no further results are available." |
+ } |
+ } |
+ } |
+ }""" |
+ |
+ s = Schemas(schema) |
+ print s.prettyPrintByName('Foo') |
+ |
+ Produces the following output: |
+ |
+ { |
+ "nextPageToken": "A String", # Token used to access the |
+ # next page of this result. Omitted if no further results are available. |
+ "kind": "A String", # Type of the collection ('calendar#acl'). |
+ "etag": "A String", # ETag of the collection. |
+ }, |
+ |
+The constructor takes a discovery document in which to look up named schema. |
+ |
+</pre> |
+ |
+<hr /> |
+<div class="fields"> <p><strong>Author:</strong> |
+ jcgregorio@google.com (Joe Gregorio) |
+ </p> |
+</div><!-- ==================== CLASSES ==================== --> |
+<a name="section-Classes"></a> |
+<table class="summary" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Classes</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-Classes" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a href="apiclient.schema.Schemas-class.html" class="summary-name">Schemas</a><br /> |
+ Schemas for an API. |
+ </td> |
+ </tr> |
+<tr class="private"> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a href="apiclient.schema._SchemaToStruct-class.html" class="summary-name" onclick="show_private();">_SchemaToStruct</a><br /> |
+ Convert schema to a prototype object. |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== VARIABLES ==================== --> |
+<a name="section-Variables"></a> |
+<table class="summary" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Variables</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-Variables" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'apiclient'"><code class="variable-quote">'</code><code class="variable-string">apiclient</code><code class="variable-quote">'</code></code> |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== NAVIGATION BAR ==================== --> |
+<table class="navbar" border="0" width="100%" cellpadding="0" |
+ bgcolor="#a0c0ff" cellspacing="0"> |
+ <tr valign="middle"> |
+ |
+ <!-- Tree link --> |
+ <th> <a |
+ href="module-tree.html">Trees</a> </th> |
+ |
+ <!-- Index link --> |
+ <th> <a |
+ href="identifier-index.html">Indices</a> </th> |
+ |
+ <!-- Help link --> |
+ <th> <a |
+ href="help.html">Help</a> </th> |
+ |
+ <th class="navbar" width="100%"></th> |
+ </tr> |
+</table> |
+<table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
+ <tr> |
+ <td align="left" class="footer"> |
+ Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 |
+ </td> |
+ <td align="right" class="footer"> |
+ <a target="mainFrame" href="http://epydoc.sourceforge.net" |
+ >http://epydoc.sourceforge.net</a> |
+ </td> |
+ </tr> |
+</table> |
+ |
+<script type="text/javascript"> |
+ <!-- |
+ // Private objects are initially displayed (because if |
+ // javascript is turned off then we want them to be |
+ // visible); but by default, we want to hide them. So hide |
+ // them unless we have a cookie that says to show them. |
+ checkCookie(); |
+ // --> |
+</script> |
+</body> |
+</html> |