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