Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c9b6cec70b2162b98d836f8100bc039f19fe23cb / . / docs / dyn / discovery_v1.apis.html
blob: 57d39b30ddfd0375641abd7aa86d7d6feec17095 [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.
176 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
177 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
178 },
179 },
180 "labels": [ # Labels for the status of this API, such as labs or deprecated.
181 "A String",
182 ],
183 "ownerName": "A String", # The name of the owner of this API. See ownerDomain.
184 "batchPath": "batch", # The path for REST batch requests.
185 "id": "A String", # The ID of this API.
186 "features": [ # A list of supported features for this API.
187 "A String",
188 ],
189 "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.
190 "rootUrl": "A String", # The root URL under which all API services live.
191 "parameters": { # Common parameters that apply across all apis.
192 "a_key": { # Description of a single parameter.
193 "properties": { # If this is a schema for an object, list the schema for each property of this object.
194 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
195 },
196 "required": True or False, # Whether the parameter is required.
197 "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
198 "description": "A String", # A description of this object.
199 "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
200 "default": "A String", # The default value of this property (if one exists).
201 "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.
202 "enum": [ # Values this parameter may take (if it is an enum).
203 "A String",
204 ],
205 "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.
206 "map": [ # The map of discriminant value to schema to use for parsing..
207 {
208 "type_value": "A String",
209 "$ref": "A String",
210 },
211 ],
212 "discriminant": "A String", # The name of the type discriminant property.
213 },
214 "maximum": "A String", # The maximum value of this parameter.
215 "id": "A String", # Unique identifier for this schema.
216 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
217 "A String",
218 ],
219 "minimum": "A String", # The minimum value of this parameter.
220 "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.
221 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
222 "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
223 "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.
224 "repeated": True or False, # Whether this parameter may appear multiple times.
225 "annotations": { # Additional information about this property.
226 "required": [ # A list of methods for which this property is required on requests.
227 "A String",
228 ],
229 },
230 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
231 },
232 },
233 "icons": { # Links to 16x16 and 32x32 icons representing the API.
234 "x32": "A String", # The URL of the 32x32 icon.
235 "x16": "A String", # The URL of the 16x16 icon.
236 },
237 "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.
238 "etag": "A String", # The ETag for this response.
239 "version": "A String", # The version of this API.
240 "servicePath": "A String", # The base path for all REST requests.
241 "schemas": { # The schemas for this API.
242 "a_key": { # An individual schema description.
243 "properties": { # If this is a schema for an object, list the schema for each property of this object.
244 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
245 },
246 "required": True or False, # Whether the parameter is required.
247 "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
248 "description": "A String", # A description of this object.
249 "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
250 "default": "A String", # The default value of this property (if one exists).
251 "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.
252 "enum": [ # Values this parameter may take (if it is an enum).
253 "A String",
254 ],
255 "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.
256 "map": [ # The map of discriminant value to schema to use for parsing..
257 {
258 "type_value": "A String",
259 "$ref": "A String",
260 },
261 ],
262 "discriminant": "A String", # The name of the type discriminant property.
263 },
264 "maximum": "A String", # The maximum value of this parameter.
265 "id": "A String", # Unique identifier for this schema.
266 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
267 "A String",
268 ],
269 "minimum": "A String", # The minimum value of this parameter.
270 "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.
271 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
272 "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
273 "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.
274 "repeated": True or False, # Whether this parameter may appear multiple times.
275 "annotations": { # Additional information about this property.
276 "required": [ # A list of methods for which this property is required on requests.
277 "A String",
278 ],
279 },
280 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
281 },
282 },
283 "resources": { # The resources in this API.
284 "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource.
285 "methods": { # Methods on this resource.
286 "a_key": { # Description for any methods on this resource.
287 "scopes": [ # OAuth 2.0 scopes applicable to this method.
288 "A String",
289 ],
290 "description": "A String", # Description of this method.
291 "parameters": { # Details for all parameters in this method.
292 "a_key": { # Details for a single parameter in this method.
293 "properties": { # If this is a schema for an object, list the schema for each property of this object.
294 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
295 },
296 "required": True or False, # Whether the parameter is required.
297 "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
298 "description": "A String", # A description of this object.
299 "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
300 "default": "A String", # The default value of this property (if one exists).
301 "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.
302 "enum": [ # Values this parameter may take (if it is an enum).
303 "A String",
304 ],
305 "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.
306 "map": [ # The map of discriminant value to schema to use for parsing..
307 {
308 "type_value": "A String",
309 "$ref": "A String",
310 },
311 ],
312 "discriminant": "A String", # The name of the type discriminant property.
313 },
314 "maximum": "A String", # The maximum value of this parameter.
315 "id": "A String", # Unique identifier for this schema.
316 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
317 "A String",
318 ],
319 "minimum": "A String", # The minimum value of this parameter.
320 "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.
321 "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
322 "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
323 "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.
324 "repeated": True or False, # Whether this parameter may appear multiple times.
325 "annotations": { # Additional information about this property.
326 "required": [ # A list of methods for which this property is required on requests.
327 "A String",
328 ],
329 },
330 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
331 },
332 },
333 "supportsMediaUpload": True or False, # Whether this method supports media uploads.
334 "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.
335 "mediaUpload": { # Media upload parameters.
336 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
337 "protocols": { # Supported upload protocols.
338 "simple": { # Supports uploading as a single HTTP request.
339 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
340 "multipart": true, # True if this endpoint supports upload multipart media.
341 },
342 "resumable": { # Supports the Resumable Media Upload protocol.
343 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
344 "multipart": true, # True if this endpoint supports uploading multipart media.
345 },
346 },
347 "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
348 "A String",
349 ],
350 },
351 "request": { # The schema for the request.
352 "parameterName": "A String", # parameter name.
353 "$ref": "A String", # Schema ID for the request schema.
354 },
355 "response": { # The schema for the response.
356 "$ref": "A String", # Schema ID for the response schema.
357 },
358 "httpMethod": "A String", # HTTP method used by this method.
359 "supportsSubscription": True or False, # Whether this method supports subscriptions.
360 "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.
361 "A String",
362 ],
363 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
364 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
365 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
366 },
367 },
368 "resources": { # Sub-resources on this resource.
369 "a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource.
370 },
371 },
372 },
373 "revision": "A String", # The version of this API.
374 "description": "A String", # The description of this API.
375 "canonicalName": "A String", # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
376 "auth": { # Authentication information.
377 "oauth2": { # OAuth 2.0 authentication information.
378 "scopes": { # Available OAuth 2.0 scopes.
379 "a_key": { # The scope value.
380 "description": "A String", # Description of scope.
381 },
382 },
383 },
384 },
385 "packagePath": "A String", # The package of the owner of this API. See ownerDomain.
386 "kind": "discovery#restDescription", # The kind for this response.
387 "name": "A String", # The name of this API.
388 "basePath": "A String", # [DEPRECATED] The base path for REST requests.
389 "title": "A String", # The title of this API.
390 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
391 "documentationLink": "A String", # A link to human readable documentation for the API.
392 }</pre>
393</div>
394
395<div class="method">
396 <code class="details" id="list">list(name=None, preferred=None)</code>
397 <pre>Retrieve the list of APIs supported at this endpoint.
398
399Args:
400 name: string, Only include APIs with the given name.
401 preferred: boolean, Return only the preferred version of an API.
402
403Returns:
404 An object of the form:
405
406 {
407 "items": [ # The individual directory entries. One entry per api/version pair.
408 {
409 "kind": "discovery#directoryItem", # The kind for this response.
410 "labels": [ # Labels for the status of this API, such as labs or deprecated.
411 "A String",
412 ],
413 "description": "A String", # The description of this API.
414 "icons": { # Links to 16x16 and 32x32 icons representing the API.
415 "x32": "A String", # The URL of the 32x32 icon.
416 "x16": "A String", # The URL of the 16x16 icon.
417 },
418 "discoveryRestUrl": "A String", # The URL for the discovery REST document.
419 "preferred": True or False, # True if this version is the preferred version to use.
420 "name": "A String", # The name of the API.
421 "discoveryLink": "A String", # A link to the discovery document.
422 "version": "A String", # The version of the API.
423 "title": "A String", # The title of this API.
424 "id": "A String", # The id of this API.
425 "documentationLink": "A String", # A link to human readable documentation for the API.
426 },
427 ],
428 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
429 "kind": "discovery#directoryList", # The kind for this response.
430 }</pre>
431</div>
432
433</body></html>