Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d67010d98769c7f0b7792ce26b8ca7527dd3561c / . / docs / dyn / discovery_v1.apis.html
blob: 160f3bccfb512127aaf0c4559ad867f25e368774 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="discovery_v1.html">APIs Discovery Service</a> . <a href="discovery_v1.apis.html">apis</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#getRest">getRest(api, version)</a></code></p>
79<p class="firstline">Retrieve the description of a particular version of an api.</p>
80<p class="toc_element">
81 <code><a href="#list">list(name=None, preferred=None, label=None)</a></code></p>
82<p class="firstline">Retrieve the list of APIs supported at this endpoint.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="getRest">getRest(api, version)</code>
86 <pre>Retrieve the description of a particular version of an api.
87
88Args:
89 api: string, The name of the API. (required)
90 version: string, The version of the API. (required)
91
92Returns:
93 An object of the form:
94
95 {
96 "protocol": "rest", # The protocol described by this document.
97 "methods": { # API-level methods for this API.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]98 "a_key": { # An individual method description.
99 "scopes": [ # OAuth 2.0 scopes applicable to this method.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame^]100 "A String",
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]101 ],
102 "description": "A String", # Description of this method.
103 "parameters": { # Details for all parameters in this method.
104 "a_key": { # Details for a single parameter in this method.
105 "properties": { # If this is a schema for an object, list the schema for each property of this object.
106 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
107 },
108 "required": True or False, # Whether the parameter is required.
109 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
110 "description": "A String", # A description of this object.
111 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
112 "default": "A String", # The default value of this property (if one exists).
113 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
114 "enum": [ # Values this parameter may take (if it is an enum).
115 "A String",
116 ],
117 "maximum": "A String", # The maximum value of this parameter.
118 "id": "A String", # Unique identifier for this schema.
119 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
120 "A String",
121 ],
122 "minimum": "A String", # The minimum value of this parameter.
123 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]124 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]125 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
126 "repeated": True or False, # Whether this parameter may appear multiple times.
127 "annotations": { # Additional information about this property.
128 "required": [ # A list of methods for which this property is required on requests.
129 "A String",
130 ],
131 },
132 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
133 },
134 },
135 "supportsMediaUpload": True or False, # Whether this method supports media uploads.
136 "request": { # The schema for the request.
137 "$ref": "A String", # Schema ID for the request schema.
138 },
139 "mediaUpload": { # Media upload parameters.
140 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
141 "protocols": { # Supported upload protocols.
142 "simple": { # Supports uploading as a single HTTP request.
143 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
144 "multipart": true, # True if this endpoint supports upload multipart media.
145 },
146 "resumable": { # Supports the Resumable Media Upload protocol.
147 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
148 "multipart": true, # True if this endpoint supports uploading multipart media.
149 },
150 },
151 "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
152 "A String",
153 ],
154 },
155 "response": { # The schema for the response.
156 "$ref": "A String", # Schema ID for the response schema.
157 },
158 "httpMethod": "A String", # HTTP method used by this method.
159 "supportsSubscription": True or False, # Whether this method supports subscriptions.
160 "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.
161 "A String",
162 ],
163 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
164 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
165 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
166 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]167 },
168 "labels": [ # Labels for the status of this API, such as labs or deprecated.
169 "A String",
170 ],
171 "batchPath": "batch", # The path for REST batch requests.
172 "id": "A String", # The id of this API.
173 "schemas": { # The schemas for this API.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]174 "a_key": { # An individual schema description.
175 "properties": { # If this is a schema for an object, list the schema for each property of this object.
176 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
177 },
178 "required": True or False, # Whether the parameter is required.
179 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
180 "description": "A String", # A description of this object.
181 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
182 "default": "A String", # The default value of this property (if one exists).
183 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
184 "enum": [ # Values this parameter may take (if it is an enum).
185 "A String",
186 ],
187 "maximum": "A String", # The maximum value of this parameter.
188 "id": "A String", # Unique identifier for this schema.
189 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
190 "A String",
191 ],
192 "minimum": "A String", # The minimum value of this parameter.
193 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]194 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]195 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
196 "repeated": True or False, # Whether this parameter may appear multiple times.
197 "annotations": { # Additional information about this property.
198 "required": [ # A list of methods for which this property is required on requests.
199 "A String",
200 ],
201 },
202 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
203 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]204 },
205 "rootUrl": "A String", # The root url under which all API services live.
206 "parameters": { # Common parameters that apply across all apis.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]207 "a_key": { # Description of a single parameter.
208 "properties": { # If this is a schema for an object, list the schema for each property of this object.
209 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
210 },
211 "required": True or False, # Whether the parameter is required.
212 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
213 "description": "A String", # A description of this object.
214 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
215 "default": "A String", # The default value of this property (if one exists).
216 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
217 "enum": [ # Values this parameter may take (if it is an enum).
218 "A String",
219 ],
220 "maximum": "A String", # The maximum value of this parameter.
221 "id": "A String", # Unique identifier for this schema.
222 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
223 "A String",
224 ],
225 "minimum": "A String", # The minimum value of this parameter.
226 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]227 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]228 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
229 "repeated": True or False, # Whether this parameter may appear multiple times.
230 "annotations": { # Additional information about this property.
231 "required": [ # A list of methods for which this property is required on requests.
232 "A String",
233 ],
234 },
235 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
236 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]237 },
238 "icons": { # Links to 16x16 and 32x32 icons representing the API.
239 "x32": "A String", # The url of the 32x32 icon.
240 "x16": "A String", # The url of the 16x16 icon.
241 },
242 "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame^]243 "etag": "A String", # The etag for this response.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]244 "features": [ # A list of supported features for this API.
245 "A String",
246 ],
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame^]247 "version": "A String", # The version of this API.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]248 "servicePath": "A String", # The base path for all REST requests.
249 "resources": { # The resources in this API.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]250 "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource.
251 "methods": { # Methods on this resource.
252 "a_key": { # Description for any methods on this resource.
253 "scopes": [ # OAuth 2.0 scopes applicable to this method.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame^]254 "A String",
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]255 ],
256 "description": "A String", # Description of this method.
257 "parameters": { # Details for all parameters in this method.
258 "a_key": { # Details for a single parameter in this method.
259 "properties": { # If this is a schema for an object, list the schema for each property of this object.
260 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
261 },
262 "required": True or False, # Whether the parameter is required.
263 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
264 "description": "A String", # A description of this object.
265 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
266 "default": "A String", # The default value of this property (if one exists).
267 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
268 "enum": [ # Values this parameter may take (if it is an enum).
269 "A String",
270 ],
271 "maximum": "A String", # The maximum value of this parameter.
272 "id": "A String", # Unique identifier for this schema.
273 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
274 "A String",
275 ],
276 "minimum": "A String", # The minimum value of this parameter.
277 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]278 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]279 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
280 "repeated": True or False, # Whether this parameter may appear multiple times.
281 "annotations": { # Additional information about this property.
282 "required": [ # A list of methods for which this property is required on requests.
283 "A String",
284 ],
285 },
286 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
287 },
288 },
289 "supportsMediaUpload": True or False, # Whether this method supports media uploads.
290 "request": { # The schema for the request.
291 "$ref": "A String", # Schema ID for the request schema.
292 },
293 "mediaUpload": { # Media upload parameters.
294 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
295 "protocols": { # Supported upload protocols.
296 "simple": { # Supports uploading as a single HTTP request.
297 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
298 "multipart": true, # True if this endpoint supports upload multipart media.
299 },
300 "resumable": { # Supports the Resumable Media Upload protocol.
301 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
302 "multipart": true, # True if this endpoint supports uploading multipart media.
303 },
304 },
305 "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
306 "A String",
307 ],
308 },
309 "response": { # The schema for the response.
310 "$ref": "A String", # Schema ID for the response schema.
311 },
312 "httpMethod": "A String", # HTTP method used by this method.
313 "supportsSubscription": True or False, # Whether this method supports subscriptions.
314 "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.
315 "A String",
316 ],
317 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
318 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
319 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
320 },
321 },
322 "resources": { # Sub-resources on this resource.
323 "a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource.
324 },
325 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]326 },
327 "revision": "A String", # The version of this API.
328 "description": "A String", # The description of this API.
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]329 "canonicalName": "A String", # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]330 "auth": { # Authentication information.
331 "oauth2": { # OAuth 2.0 authentication information.
332 "scopes": { # Available OAuth 2.0 scopes.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]333 "a_key": { # The scope value.
334 "description": "A String", # Description of scope.
335 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]336 },
337 },
338 },
339 "kind": "discovery#restDescription", # The kind for this response.
340 "name": "A String", # The name of this API.
341 "basePath": "A String", # [DEPRECATED] The base path for REST requests.
342 "title": "A String", # The title of this API.
343 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
344 "documentationLink": "A String", # A link to human readable documentation for the API.
345 }</pre>
346</div>
347
348<div class="method">
349 <code class="details" id="list">list(name=None, preferred=None, label=None)</code>
350 <pre>Retrieve the list of APIs supported at this endpoint.
351
352Args:
353 name: string, Only include APIs with the given name.
354 preferred: boolean, Return only the preferred version of an API.
355 label: string, Only include APIs with a matching label, such as 'graduated' or 'labs'.
356 Allowed values
357 deprecated - APIs that have been deprecated.
358 graduated - Supported APIs that have graduated from labs.
359 labs - APIs that are experimental
360
361Returns:
362 An object of the form:
363
364 {
365 "items": [ # The individual directory entries. One entry per api/version pair.
366 {
367 "kind": "discovery#directoryItem", # The kind for this response.
368 "labels": [ # Labels for the status of this API, such as labs or deprecated.
369 "A String",
370 ],
371 "description": "A String", # The description of this API.
372 "icons": { # Links to 16x16 and 32x32 icons representing the API.
373 "x32": "A String", # The url of the 32x32 icon.
374 "x16": "A String", # The url of the 16x16 icon.
375 },
376 "discoveryRestUrl": "A String", # The url for the discovery REST document.
377 "preferred": True or False, # True if this version is the preferred version to use.
378 "name": "A String", # The name of the API.
379 "discoveryLink": "A String", # A link to the discovery document.
380 "version": "A String", # The version of the API.
381 "title": "A String", # The title of this API.
382 "id": "A String", # The id of this API.
383 "documentationLink": "A String", # A link to human readable documentation for the API.
384 },
385 ],
386 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
387 "kind": "discovery#directoryList", # The kind for this response.
388 }</pre>
389</div>
390
391</body></html>