Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e912d185eef03392f095881d407c0c78f7633d5e / . / docs / dyn / discovery_v1.apis.html
blob: 280e3486a3ca3949f9765a51ea5f92d504ecb803 [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.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]123 "readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]124 "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]125 "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]126 "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.
127 "repeated": True or False, # Whether this parameter may appear multiple times.
128 "annotations": { # Additional information about this property.
129 "required": [ # A list of methods for which this property is required on requests.
130 "A String",
131 ],
132 },
133 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
134 },
135 },
136 "supportsMediaUpload": True or False, # Whether this method supports media uploads.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]137 "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.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]138 "mediaUpload": { # Media upload parameters.
139 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
140 "protocols": { # Supported upload protocols.
141 "simple": { # Supports uploading as a single HTTP request.
142 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
143 "multipart": true, # True if this endpoint supports upload multipart media.
144 },
145 "resumable": { # Supports the Resumable Media Upload protocol.
146 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
147 "multipart": true, # True if this endpoint supports uploading multipart media.
148 },
149 },
150 "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
151 "A String",
152 ],
153 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]154 "request": { # The schema for the request.
155 "$ref": "A String", # Schema ID for the request schema.
156 },
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]157 "response": { # The schema for the response.
158 "$ref": "A String", # Schema ID for the response schema.
159 },
160 "httpMethod": "A String", # HTTP method used by this method.
161 "supportsSubscription": True or False, # Whether this method supports subscriptions.
162 "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.
163 "A String",
164 ],
165 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
166 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
167 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
168 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]169 },
170 "labels": [ # Labels for the status of this API, such as labs or deprecated.
171 "A String",
172 ],
173 "batchPath": "batch", # The path for REST batch requests.
174 "id": "A String", # The id of this API.
175 "schemas": { # The schemas for this API.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]176 "a_key": { # An individual schema description.
177 "properties": { # If this is a schema for an object, list the schema for each property of this object.
178 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
179 },
180 "required": True or False, # Whether the parameter is required.
181 "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
182 "description": "A String", # A description of this object.
183 "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
184 "default": "A String", # The default value of this property (if one exists).
185 "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.
186 "enum": [ # Values this parameter may take (if it is an enum).
187 "A String",
188 ],
189 "maximum": "A String", # The maximum value of this parameter.
190 "id": "A String", # Unique identifier for this schema.
191 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
192 "A String",
193 ],
194 "minimum": "A String", # The minimum value of this parameter.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]195 "readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]196 "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]197 "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]198 "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.
199 "repeated": True or False, # Whether this parameter may appear multiple times.
200 "annotations": { # Additional information about this property.
201 "required": [ # A list of methods for which this property is required on requests.
202 "A String",
203 ],
204 },
205 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
206 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]207 },
208 "rootUrl": "A String", # The root url under which all API services live.
209 "parameters": { # Common parameters that apply across all apis.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]210 "a_key": { # Description of a single parameter.
211 "properties": { # If this is a schema for an object, list the schema for each property of this object.
212 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
213 },
214 "required": True or False, # Whether the parameter is required.
215 "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
216 "description": "A String", # A description of this object.
217 "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
218 "default": "A String", # The default value of this property (if one exists).
219 "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.
220 "enum": [ # Values this parameter may take (if it is an enum).
221 "A String",
222 ],
223 "maximum": "A String", # The maximum value of this parameter.
224 "id": "A String", # Unique identifier for this schema.
225 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
226 "A String",
227 ],
228 "minimum": "A String", # The minimum value of this parameter.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]229 "readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]230 "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]231 "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]232 "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.
233 "repeated": True or False, # Whether this parameter may appear multiple times.
234 "annotations": { # Additional information about this property.
235 "required": [ # A list of methods for which this property is required on requests.
236 "A String",
237 ],
238 },
239 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
240 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]241 },
242 "icons": { # Links to 16x16 and 32x32 icons representing the API.
243 "x32": "A String", # The url of the 32x32 icon.
244 "x16": "A String", # The url of the 16x16 icon.
245 },
246 "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]247 "etag": "A String", # The etag for this response.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]248 "features": [ # A list of supported features for this API.
249 "A String",
250 ],
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]251 "version": "A String", # The version of this API.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]252 "servicePath": "A String", # The base path for all REST requests.
253 "resources": { # The resources in this API.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]254 "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource.
255 "methods": { # Methods on this resource.
256 "a_key": { # Description for any methods on this resource.
257 "scopes": [ # OAuth 2.0 scopes applicable to this method.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]258 "A String",
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]259 ],
260 "description": "A String", # Description of this method.
261 "parameters": { # Details for all parameters in this method.
262 "a_key": { # Details for a single parameter in this method.
263 "properties": { # If this is a schema for an object, list the schema for each property of this object.
264 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
265 },
266 "required": True or False, # Whether the parameter is required.
267 "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
268 "description": "A String", # A description of this object.
269 "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
270 "default": "A String", # The default value of this property (if one exists).
271 "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.
272 "enum": [ # Values this parameter may take (if it is an enum).
273 "A String",
274 ],
275 "maximum": "A String", # The maximum value of this parameter.
276 "id": "A String", # Unique identifier for this schema.
277 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
278 "A String",
279 ],
280 "minimum": "A String", # The minimum value of this parameter.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]281 "readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]282 "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]283 "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]284 "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.
285 "repeated": True or False, # Whether this parameter may appear multiple times.
286 "annotations": { # Additional information about this property.
287 "required": [ # A list of methods for which this property is required on requests.
288 "A String",
289 ],
290 },
291 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
292 },
293 },
294 "supportsMediaUpload": True or False, # Whether this method supports media uploads.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]295 "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.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]296 "mediaUpload": { # Media upload parameters.
297 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
298 "protocols": { # Supported upload protocols.
299 "simple": { # Supports uploading as a single HTTP request.
300 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
301 "multipart": true, # True if this endpoint supports upload multipart media.
302 },
303 "resumable": { # Supports the Resumable Media Upload protocol.
304 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
305 "multipart": true, # True if this endpoint supports uploading multipart media.
306 },
307 },
308 "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
309 "A String",
310 ],
311 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]312 "request": { # The schema for the request.
313 "$ref": "A String", # Schema ID for the request schema.
314 },
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]315 "response": { # The schema for the response.
316 "$ref": "A String", # Schema ID for the response schema.
317 },
318 "httpMethod": "A String", # HTTP method used by this method.
319 "supportsSubscription": True or False, # Whether this method supports subscriptions.
320 "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.
321 "A String",
322 ],
323 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
324 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
325 "supportsMediaDownload": True or False, # Whether this method supports media downloads.
326 },
327 },
328 "resources": { # Sub-resources on this resource.
329 "a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource.
330 },
331 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]332 },
333 "revision": "A String", # The version of this API.
334 "description": "A String", # The description of this API.
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]335 "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]336 "auth": { # Authentication information.
337 "oauth2": { # OAuth 2.0 authentication information.
338 "scopes": { # Available OAuth 2.0 scopes.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]339 "a_key": { # The scope value.
340 "description": "A String", # Description of scope.
341 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]342 },
343 },
344 },
345 "kind": "discovery#restDescription", # The kind for this response.
346 "name": "A String", # The name of this API.
347 "basePath": "A String", # [DEPRECATED] The base path for REST requests.
348 "title": "A String", # The title of this API.
349 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
350 "documentationLink": "A String", # A link to human readable documentation for the API.
351 }</pre>
352</div>
353
354<div class="method">
355 <code class="details" id="list">list(name=None, preferred=None, label=None)</code>
356 <pre>Retrieve the list of APIs supported at this endpoint.
357
358Args:
359 name: string, Only include APIs with the given name.
360 preferred: boolean, Return only the preferred version of an API.
361 label: string, Only include APIs with a matching label, such as 'graduated' or 'labs'.
362 Allowed values
363 deprecated - APIs that have been deprecated.
364 graduated - Supported APIs that have graduated from labs.
365 labs - APIs that are experimental
366
367Returns:
368 An object of the form:
369
370 {
371 "items": [ # The individual directory entries. One entry per api/version pair.
372 {
373 "kind": "discovery#directoryItem", # The kind for this response.
374 "labels": [ # Labels for the status of this API, such as labs or deprecated.
375 "A String",
376 ],
377 "description": "A String", # The description of this API.
378 "icons": { # Links to 16x16 and 32x32 icons representing the API.
379 "x32": "A String", # The url of the 32x32 icon.
380 "x16": "A String", # The url of the 16x16 icon.
381 },
382 "discoveryRestUrl": "A String", # The url for the discovery REST document.
383 "preferred": True or False, # True if this version is the preferred version to use.
384 "name": "A String", # The name of the API.
385 "discoveryLink": "A String", # A link to the discovery document.
386 "version": "A String", # The version of the API.
387 "title": "A String", # The title of this API.
388 "id": "A String", # The id of this API.
389 "documentationLink": "A String", # A link to human readable documentation for the API.
390 },
391 ],
392 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
393 "kind": "discovery#directoryList", # The kind for this response.
394 }</pre>
395</div>
396
397</body></html>