Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / discovery_v1.apis.html
blob: c388d81a355022c0e801f860bbee997b0841acda [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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)</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.
98 "a_key": { # An individual method description.
99 "scopes": [ # OAuth 2.0 scopes applicable to this method.
100 "A String",
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 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
118 "map": [ # The map of discriminant value to schema to use for parsing..
119 {
120 "type_value": "A String",
121 "$ref": "A String",
122 },
123 ],
124 "discriminant": "A String", # The name of the type discriminant property.
125 },
126 "maximum": "A String", # The maximum value of this parameter.
127 "id": "A String", # Unique identifier for this schema.
128 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
129 "A String",
130 ],
131 "minimum": "A String", # The minimum value of this parameter.
132 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
133 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
134 "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
135 "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.
136 "repeated": True or False, # Whether this parameter may appear multiple times.
137 "annotations": { # Additional information about this property.
138 "required": [ # A list of methods for which this property is required on requests.
139 "A String",
140 ],
141 },
142 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
143 },
144 },
145 "supportsMediaUpload": True or False, # Whether this method supports media uploads.
146 "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
147 "mediaUpload": { # Media upload parameters.
148 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
149 "protocols": { # Supported upload protocols.
150 "simple": { # Supports uploading as a single HTTP request.
151 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
152 "multipart": true, # True if this endpoint supports upload multipart media.
153 },
154 "resumable": { # Supports the Resumable Media Upload protocol.
155 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
156 "multipart": true, # True if this endpoint supports uploading multipart media.
157 },
158 },
159 "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
160 "A String",
161 ],
162 },
163 "request": { # The schema for the request.
164 "parameterName": "A String", # parameter name.
165 "$ref": "A String", # Schema ID for the request schema.
166 },
167 "response": { # The schema for the response.
168 "$ref": "A String", # Schema ID for the response schema.
169 },
170 "httpMethod": "A String", # HTTP method used by this method.
171 "supportsSubscription": True or False, # Whether this method supports subscriptions.
172 "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.
173 "A String",
174 ],
175 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]176 "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
178 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
179 },
180 },
181 "labels": [ # Labels for the status of this API, such as labs or deprecated.
182 "A String",
183 ],
184 "ownerName": "A String", # The name of the owner of this API. See ownerDomain.
185 "batchPath": "batch", # The path for REST batch requests.
186 "id": "A String", # The ID of this API.
187 "features": [ # A list of supported features for this API.
188 "A String",
189 ],
190 "ownerDomain": "A String", # The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.
191 "rootUrl": "A String", # The root URL under which all API services live.
192 "parameters": { # Common parameters that apply across all apis.
193 "a_key": { # Description of a single parameter.
194 "properties": { # If this is a schema for an object, list the schema for each property of this object.
195 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
196 },
197 "required": True or False, # Whether the parameter is required.
198 "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
199 "description": "A String", # A description of this object.
200 "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
201 "default": "A String", # The default value of this property (if one exists).
202 "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.
203 "enum": [ # Values this parameter may take (if it is an enum).
204 "A String",
205 ],
206 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
207 "map": [ # The map of discriminant value to schema to use for parsing..
208 {
209 "type_value": "A String",
210 "$ref": "A String",
211 },
212 ],
213 "discriminant": "A String", # The name of the type discriminant property.
214 },
215 "maximum": "A String", # The maximum value of this parameter.
216 "id": "A String", # Unique identifier for this schema.
217 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
218 "A String",
219 ],
220 "minimum": "A String", # The minimum value of this parameter.
221 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
222 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
223 "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
224 "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.
225 "repeated": True or False, # Whether this parameter may appear multiple times.
226 "annotations": { # Additional information about this property.
227 "required": [ # A list of methods for which this property is required on requests.
228 "A String",
229 ],
230 },
231 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
232 },
233 },
234 "icons": { # Links to 16x16 and 32x32 icons representing the API.
235 "x32": "A String", # The URL of the 32x32 icon.
236 "x16": "A String", # The URL of the 16x16 icon.
237 },
238 "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.
239 "etag": "A String", # The ETag for this response.
240 "version": "A String", # The version of this API.
241 "servicePath": "A String", # The base path for all REST requests.
242 "schemas": { # The schemas for this API.
243 "a_key": { # An individual schema description.
244 "properties": { # If this is a schema for an object, list the schema for each property of this object.
245 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
246 },
247 "required": True or False, # Whether the parameter is required.
248 "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
249 "description": "A String", # A description of this object.
250 "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
251 "default": "A String", # The default value of this property (if one exists).
252 "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.
253 "enum": [ # Values this parameter may take (if it is an enum).
254 "A String",
255 ],
256 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
257 "map": [ # The map of discriminant value to schema to use for parsing..
258 {
259 "type_value": "A String",
260 "$ref": "A String",
261 },
262 ],
263 "discriminant": "A String", # The name of the type discriminant property.
264 },
265 "maximum": "A String", # The maximum value of this parameter.
266 "id": "A String", # Unique identifier for this schema.
267 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
268 "A String",
269 ],
270 "minimum": "A String", # The minimum value of this parameter.
271 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
272 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
273 "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
274 "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.
275 "repeated": True or False, # Whether this parameter may appear multiple times.
276 "annotations": { # Additional information about this property.
277 "required": [ # A list of methods for which this property is required on requests.
278 "A String",
279 ],
280 },
281 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
282 },
283 },
284 "resources": { # The resources in this API.
285 "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource.
286 "methods": { # Methods on this resource.
287 "a_key": { # Description for any methods on this resource.
288 "scopes": [ # OAuth 2.0 scopes applicable to this method.
289 "A String",
290 ],
291 "description": "A String", # Description of this method.
292 "parameters": { # Details for all parameters in this method.
293 "a_key": { # Details for a single parameter in this method.
294 "properties": { # If this is a schema for an object, list the schema for each property of this object.
295 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
296 },
297 "required": True or False, # Whether the parameter is required.
298 "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
299 "description": "A String", # A description of this object.
300 "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
301 "default": "A String", # The default value of this property (if one exists).
302 "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.
303 "enum": [ # Values this parameter may take (if it is an enum).
304 "A String",
305 ],
306 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
307 "map": [ # The map of discriminant value to schema to use for parsing..
308 {
309 "type_value": "A String",
310 "$ref": "A String",
311 },
312 ],
313 "discriminant": "A String", # The name of the type discriminant property.
314 },
315 "maximum": "A String", # The maximum value of this parameter.
316 "id": "A String", # Unique identifier for this schema.
317 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
318 "A String",
319 ],
320 "minimum": "A String", # The minimum value of this parameter.
321 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
322 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
323 "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
324 "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.
325 "repeated": True or False, # Whether this parameter may appear multiple times.
326 "annotations": { # Additional information about this property.
327 "required": [ # A list of methods for which this property is required on requests.
328 "A String",
329 ],
330 },
331 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
332 },
333 },
334 "supportsMediaUpload": True or False, # Whether this method supports media uploads.
335 "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
336 "mediaUpload": { # Media upload parameters.
337 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
338 "protocols": { # Supported upload protocols.
339 "simple": { # Supports uploading as a single HTTP request.
340 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
341 "multipart": true, # True if this endpoint supports upload multipart media.
342 },
343 "resumable": { # Supports the Resumable Media Upload protocol.
344 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
345 "multipart": true, # True if this endpoint supports uploading multipart media.
346 },
347 },
348 "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
349 "A String",
350 ],
351 },
352 "request": { # The schema for the request.
353 "parameterName": "A String", # parameter name.
354 "$ref": "A String", # Schema ID for the request schema.
355 },
356 "response": { # The schema for the response.
357 "$ref": "A String", # Schema ID for the response schema.
358 },
359 "httpMethod": "A String", # HTTP method used by this method.
360 "supportsSubscription": True or False, # Whether this method supports subscriptions.
361 "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.
362 "A String",
363 ],
364 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]365 "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]366 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
367 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
368 },
369 },
370 "resources": { # Sub-resources on this resource.
371 "a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource.
372 },
373 },
374 },
375 "revision": "A String", # The version of this API.
376 "description": "A String", # The description of this API.
377 "canonicalName": "A String", # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
378 "auth": { # Authentication information.
379 "oauth2": { # OAuth 2.0 authentication information.
380 "scopes": { # Available OAuth 2.0 scopes.
381 "a_key": { # The scope value.
382 "description": "A String", # Description of scope.
383 },
384 },
385 },
386 },
387 "packagePath": "A String", # The package of the owner of this API. See ownerDomain.
388 "kind": "discovery#restDescription", # The kind for this response.
389 "name": "A String", # The name of this API.
390 "basePath": "A String", # [DEPRECATED] The base path for REST requests.
391 "title": "A String", # The title of this API.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]392 "exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]393 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]394 "version_module": True or False,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]395 "documentationLink": "A String", # A link to human readable documentation for the API.
396 }</pre>
397</div>
398
399<div class="method">
400 <code class="details" id="list">list(name=None, preferred=None)</code>
401 <pre>Retrieve the list of APIs supported at this endpoint.
402
403Args:
404 name: string, Only include APIs with the given name.
405 preferred: boolean, Return only the preferred version of an API.
406
407Returns:
408 An object of the form:
409
410 {
411 "items": [ # The individual directory entries. One entry per api/version pair.
412 {
413 "kind": "discovery#directoryItem", # The kind for this response.
414 "labels": [ # Labels for the status of this API, such as labs or deprecated.
415 "A String",
416 ],
417 "description": "A String", # The description of this API.
418 "icons": { # Links to 16x16 and 32x32 icons representing the API.
419 "x32": "A String", # The URL of the 32x32 icon.
420 "x16": "A String", # The URL of the 16x16 icon.
421 },
422 "discoveryRestUrl": "A String", # The URL for the discovery REST document.
423 "preferred": True or False, # True if this version is the preferred version to use.
424 "name": "A String", # The name of the API.
425 "discoveryLink": "A String", # A link to the discovery document.
426 "version": "A String", # The version of the API.
427 "title": "A String", # The title of this API.
428 "id": "A String", # The id of this API.
429 "documentationLink": "A String", # A link to human readable documentation for the API.
430 },
431 ],
432 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
433 "kind": "discovery#directoryList", # The kind for this response.
434 }</pre>
435</div>
436
437</body></html>