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