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