| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="discovery_v1.html">APIs Discovery Service</a> . <a href="discovery_v1.apis.html">apis</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#getRest">getRest(api, version)</a></code></p> |
| <p class="firstline">Retrieve the description of a particular version of an api.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(name=None, preferred=None, label=None)</a></code></p> |
| <p class="firstline">Retrieve the list of APIs supported at this endpoint.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="getRest">getRest(api, version)</code> |
| <pre>Retrieve the description of a particular version of an api. |
| |
| Args: |
| api: string, The name of the API. (required) |
| version: string, The version of the API. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "protocol": "rest", # The protocol described by this document. |
| "methods": { # API-level methods for this API. |
| }, |
| "labels": [ # Labels for the status of this API, such as labs or deprecated. |
| "A String", |
| ], |
| "batchPath": "batch", # The path for REST batch requests. |
| "id": "A String", # The id of this API. |
| "schemas": { # The schemas for this API. |
| }, |
| "rootUrl": "A String", # The root url under which all API services live. |
| "parameters": { # Common parameters that apply across all apis. |
| }, |
| "icons": { # Links to 16x16 and 32x32 icons representing the API. |
| "x32": "A String", # The url of the 32x32 icon. |
| "x16": "A String", # The url of the 16x16 icon. |
| }, |
| "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests. |
| "version": "A String", # The version of this API. |
| "features": [ # A list of supported features for this API. |
| "A String", |
| ], |
| "servicePath": "A String", # The base path for all REST requests. |
| "resources": { # The resources in this API. |
| }, |
| "revision": "A String", # The version of this API. |
| "description": "A String", # The description of this API. |
| "auth": { # Authentication information. |
| "oauth2": { # OAuth 2.0 authentication information. |
| "scopes": { # Available OAuth 2.0 scopes. |
| }, |
| }, |
| }, |
| "kind": "discovery#restDescription", # The kind for this response. |
| "name": "A String", # The name of this API. |
| "basePath": "A String", # [DEPRECATED] The base path for REST requests. |
| "title": "A String", # The title of this API. |
| "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. |
| "documentationLink": "A String", # A link to human readable documentation for the API. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name=None, preferred=None, label=None)</code> |
| <pre>Retrieve the list of APIs supported at this endpoint. |
| |
| Args: |
| name: string, Only include APIs with the given name. |
| preferred: boolean, Return only the preferred version of an API. |
| label: string, Only include APIs with a matching label, such as 'graduated' or 'labs'. |
| Allowed values |
| deprecated - APIs that have been deprecated. |
| graduated - Supported APIs that have graduated from labs. |
| labs - APIs that are experimental |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "items": [ # The individual directory entries. One entry per api/version pair. |
| { |
| "kind": "discovery#directoryItem", # The kind for this response. |
| "labels": [ # Labels for the status of this API, such as labs or deprecated. |
| "A String", |
| ], |
| "description": "A String", # The description of this API. |
| "icons": { # Links to 16x16 and 32x32 icons representing the API. |
| "x32": "A String", # The url of the 32x32 icon. |
| "x16": "A String", # The url of the 16x16 icon. |
| }, |
| "discoveryRestUrl": "A String", # The url for the discovery REST document. |
| "preferred": True or False, # True if this version is the preferred version to use. |
| "name": "A String", # The name of the API. |
| "discoveryLink": "A String", # A link to the discovery document. |
| "version": "A String", # The version of the API. |
| "title": "A String", # The title of this API. |
| "id": "A String", # The id of this API. |
| "documentationLink": "A String", # A link to human readable documentation for the API. |
| }, |
| ], |
| "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. |
| "kind": "discovery#directoryList", # The kind for this response. |
| }</pre> |
| </div> |
| |
| </body></html> |