Debian Codegraph @

docs/dyn/discovery_v1.apis.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">API 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="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
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">
84 <code><a href="#list">list(name=None, preferred=None)</a></code></p>
85 <p class="firstline">Retrieve the list of APIs supported at this endpoint.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="getRest">getRest(api, version)</code>
94 <pre>Retrieve the description of a particular version of an api.
95
96 Args:
97 api: string, The name of the API. (required)
98 version: string, The version of the API. (required)
99
100 Returns:
101 An object of the form:
102
103 {
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.
109 },
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;endpoints&quot;: [ # A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status.
121 { # A single endpoint object
122 &quot;deprecated&quot;: True or False, # Whether this endpoint is deprecated
123 &quot;description&quot;: &quot;A String&quot;, # A string describing the host designated by the URL
124 &quot;endpointUrl&quot;: &quot;A String&quot;, # The URL of the endpoint target host
125 &quot;location&quot;: &quot;A String&quot;, # The location of the endpoint
126 },
127 ],
128 &quot;etag&quot;: &quot;A String&quot;, # The ETag for this response.
129 &quot;exponentialBackoffDefault&quot;: True or False, # Enable exponential backoff for suitable methods in the generated clients.
130 &quot;features&quot;: [ # A list of supported features for this API.
131 &quot;A String&quot;,
132 ],
133 &quot;icons&quot;: { # Links to 16x16 and 32x32 icons representing the API.
134 &quot;x16&quot;: &quot;A String&quot;, # The URL of the 16x16 icon.
135 &quot;x32&quot;: &quot;A String&quot;, # The URL of the 32x32 icon.
136 },
137 &quot;id&quot;: &quot;A String&quot;, # The ID of this API.
138 &quot;kind&quot;: &quot;discovery#restDescription&quot;, # The kind for this response.
139 &quot;labels&quot;: [ # Labels for the status of this API, such as labs or deprecated.
140 &quot;A String&quot;,
141 ],
142 &quot;methods&quot;: { # API-level methods for this API.
143 &quot;a_key&quot;: { # An individual method description.
144 &quot;apiVersion&quot;: &quot;A String&quot;, # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter.
145 &quot;deprecated&quot;: True or False, # Whether this method is deprecated.
146 &quot;description&quot;: &quot;A String&quot;, # Description of this method.
147 &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.
148 &quot;flatPath&quot;: &quot;A String&quot;, # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property.
149 &quot;httpMethod&quot;: &quot;A String&quot;, # HTTP method used by this method.
150 &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.
151 &quot;mediaUpload&quot;: { # Media upload parameters.
152 &quot;accept&quot;: [ # MIME Media Ranges for acceptable media uploads to this method.
153 &quot;A String&quot;,
154 ],
155 &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;.
156 &quot;protocols&quot;: { # Supported upload protocols.
157 &quot;resumable&quot;: { # Supports the Resumable Media Upload protocol.
158 &quot;multipart&quot;: true, # True if this endpoint supports uploading multipart media.
159 &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.
160 },
161 &quot;simple&quot;: { # Supports uploading as a single HTTP request.
162 &quot;multipart&quot;: true, # True if this endpoint supports upload multipart media.
163 &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.
164 },
165 },
166 },
167 &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.
168 &quot;A String&quot;,
169 ],
170 &quot;parameters&quot;: { # Details for all parameters in this method.
171 &quot;a_key&quot;: { # Details for a single parameter in this method.
172 &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.
173 &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.
174 &quot;annotations&quot;: { # Additional information about this property.
175 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
176 &quot;A String&quot;,
177 ],
178 },
179 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
180 &quot;deprecated&quot;: True or False, # Whether the parameter is deprecated.
181 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
182 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
183 &quot;A String&quot;,
184 ],
185 &quot;enumDeprecated&quot;: [ # The deprecation status for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
186 True or False,
187 ],
188 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
189 &quot;A String&quot;,
190 ],
191 &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
192 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
193 &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.
194 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
195 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
196 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
197 &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
198 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
199 &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.
200 },
201 &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.
202 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
203 &quot;required&quot;: True or False, # Whether the parameter is required.
204 &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
205 &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.
206 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
207 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
208 {
209 &quot;$ref&quot;: &quot;A String&quot;,
210 &quot;type_value&quot;: &quot;A String&quot;,
211 },
212 ],
213 },
214 },
215 },
216 &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.
217 &quot;request&quot;: { # The schema for the request.
218 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the request schema.
219 &quot;parameterName&quot;: &quot;A String&quot;, # parameter name.
220 },
221 &quot;response&quot;: { # The schema for the response.
222 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the response schema.
223 },
224 &quot;scopes&quot;: [ # OAuth 2.0 scopes applicable to this method.
225 &quot;A String&quot;,
226 ],
227 &quot;supportsMediaDownload&quot;: True or False, # Whether this method supports media downloads.
228 &quot;supportsMediaUpload&quot;: True or False, # Whether this method supports media uploads.
229 &quot;supportsSubscription&quot;: True or False, # Whether this method supports subscriptions.
230 &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.
231 },
232 },
233 &quot;name&quot;: &quot;A String&quot;, # The name of this API.
234 &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.
235 &quot;ownerName&quot;: &quot;A String&quot;, # The name of the owner of this API. See ownerDomain.
236 &quot;packagePath&quot;: &quot;A String&quot;, # The package of the owner of this API. See ownerDomain.
237 &quot;parameters&quot;: { # Common parameters that apply across all apis.
238 &quot;a_key&quot;: { # Description of a single parameter.
239 &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.
240 &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.
241 &quot;annotations&quot;: { # Additional information about this property.
242 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
243 &quot;A String&quot;,
244 ],
245 },
246 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
247 &quot;deprecated&quot;: True or False, # Whether the parameter is deprecated.
248 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
249 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
250 &quot;A String&quot;,
251 ],
252 &quot;enumDeprecated&quot;: [ # The deprecation status for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
253 True or False,
254 ],
255 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
256 &quot;A String&quot;,
257 ],
258 &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
259 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
260 &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.
261 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
262 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
263 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
264 &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
265 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
266 &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.
267 },
268 &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.
269 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
270 &quot;required&quot;: True or False, # Whether the parameter is required.
271 &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
272 &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.
273 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
274 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
275 {
276 &quot;$ref&quot;: &quot;A String&quot;,
277 &quot;type_value&quot;: &quot;A String&quot;,
278 },
279 ],
280 },
281 },
282 },
283 &quot;protocol&quot;: &quot;rest&quot;, # The protocol described by this document.
284 &quot;resources&quot;: { # The resources in this API.
285 &quot;a_key&quot;: { # An individual resource description. Contains methods and sub-resources related to this resource.
286 &quot;deprecated&quot;: True or False, # Whether this resource is deprecated.
287 &quot;methods&quot;: { # Methods on this resource.
288 &quot;a_key&quot;: { # Description for any methods on this resource.
289 &quot;apiVersion&quot;: &quot;A String&quot;, # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter.
290 &quot;deprecated&quot;: True or False, # Whether this method is deprecated.
291 &quot;description&quot;: &quot;A String&quot;, # Description of this method.
292 &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.
293 &quot;flatPath&quot;: &quot;A String&quot;, # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property.
294 &quot;httpMethod&quot;: &quot;A String&quot;, # HTTP method used by this method.
295 &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.
296 &quot;mediaUpload&quot;: { # Media upload parameters.
297 &quot;accept&quot;: [ # MIME Media Ranges for acceptable media uploads to this method.
298 &quot;A String&quot;,
299 ],
300 &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;.
301 &quot;protocols&quot;: { # Supported upload protocols.
302 &quot;resumable&quot;: { # Supports the Resumable Media Upload protocol.
303 &quot;multipart&quot;: true, # True if this endpoint supports uploading multipart media.
304 &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.
305 },
306 &quot;simple&quot;: { # Supports uploading as a single HTTP request.
307 &quot;multipart&quot;: true, # True if this endpoint supports upload multipart media.
308 &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.
309 },
310 },
311 },
312 &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.
313 &quot;A String&quot;,
314 ],
315 &quot;parameters&quot;: { # Details for all parameters in this method.
316 &quot;a_key&quot;: { # Details for a single parameter in this method.
317 &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.
318 &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.
319 &quot;annotations&quot;: { # Additional information about this property.
320 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
321 &quot;A String&quot;,
322 ],
323 },
324 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
325 &quot;deprecated&quot;: True or False, # Whether the parameter is deprecated.
326 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
327 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
328 &quot;A String&quot;,
329 ],
330 &quot;enumDeprecated&quot;: [ # The deprecation status for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
331 True or False,
332 ],
333 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
334 &quot;A String&quot;,
335 ],
336 &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
337 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
338 &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.
339 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
340 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
341 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
342 &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
343 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
344 &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.
345 },
346 &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.
347 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
348 &quot;required&quot;: True or False, # Whether the parameter is required.
349 &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
350 &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.
351 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
352 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
353 {
354 &quot;$ref&quot;: &quot;A String&quot;,
355 &quot;type_value&quot;: &quot;A String&quot;,
356 },
357 ],
358 },
359 },
360 },
361 &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.
362 &quot;request&quot;: { # The schema for the request.
363 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the request schema.
364 &quot;parameterName&quot;: &quot;A String&quot;, # parameter name.
365 },
366 &quot;response&quot;: { # The schema for the response.
367 &quot;$ref&quot;: &quot;A String&quot;, # Schema ID for the response schema.
368 },
369 &quot;scopes&quot;: [ # OAuth 2.0 scopes applicable to this method.
370 &quot;A String&quot;,
371 ],
372 &quot;supportsMediaDownload&quot;: True or False, # Whether this method supports media downloads.
373 &quot;supportsMediaUpload&quot;: True or False, # Whether this method supports media uploads.
374 &quot;supportsSubscription&quot;: True or False, # Whether this method supports subscriptions.
375 &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.
376 },
377 },
378 &quot;resources&quot;: { # Sub-resources on this resource.
379 &quot;a_key&quot;: # Object with schema name: RestResource # Description for any sub-resources on this resource.
380 },
381 },
382 },
383 &quot;revision&quot;: &quot;A String&quot;, # The version of this API.
384 &quot;rootUrl&quot;: &quot;A String&quot;, # The root URL under which all API services live.
385 &quot;schemas&quot;: { # The schemas for this API.
386 &quot;a_key&quot;: { # An individual schema description.
387 &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.
388 &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.
389 &quot;annotations&quot;: { # Additional information about this property.
390 &quot;required&quot;: [ # A list of methods for which this property is required on requests.
391 &quot;A String&quot;,
392 ],
393 },
394 &quot;default&quot;: &quot;A String&quot;, # The default value of this property (if one exists).
395 &quot;deprecated&quot;: True or False, # Whether the parameter is deprecated.
396 &quot;description&quot;: &quot;A String&quot;, # A description of this object.
397 &quot;enum&quot;: [ # Values this parameter may take (if it is an enum).
398 &quot;A String&quot;,
399 ],
400 &quot;enumDeprecated&quot;: [ # The deprecation status for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
401 True or False,
402 ],
403 &quot;enumDescriptions&quot;: [ # The descriptions for the enums. Each position maps to the corresponding value in the &quot;enum&quot; array.
404 &quot;A String&quot;,
405 ],
406 &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
407 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for this schema.
408 &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.
409 &quot;location&quot;: &quot;A String&quot;, # Whether this parameter goes in the query or the path for REST requests.
410 &quot;maximum&quot;: &quot;A String&quot;, # The maximum value of this parameter.
411 &quot;minimum&quot;: &quot;A String&quot;, # The minimum value of this parameter.
412 &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
413 &quot;properties&quot;: { # If this is a schema for an object, list the schema for each property of this object.
414 &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.
415 },
416 &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.
417 &quot;repeated&quot;: True or False, # Whether this parameter may appear multiple times.
418 &quot;required&quot;: True or False, # Whether the parameter is required.
419 &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
420 &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.
421 &quot;discriminant&quot;: &quot;A String&quot;, # The name of the type discriminant property.
422 &quot;map&quot;: [ # The map of discriminant value to schema to use for parsing..
423 {
424 &quot;$ref&quot;: &quot;A String&quot;,
425 &quot;type_value&quot;: &quot;A String&quot;,
426 },
427 ],
428 },
429 },
430 },
431 &quot;servicePath&quot;: &quot;A String&quot;, # The base path for all REST requests.
432 &quot;title&quot;: &quot;A String&quot;, # The title of this API.
433 &quot;version&quot;: &quot;A String&quot;, # The version of this API.
434 &quot;version_module&quot;: True or False,
435 }</pre>
436 </div>
437
438 <div class="method">
439 <code class="details" id="list">list(name=None, preferred=None)</code>
440 <pre>Retrieve the list of APIs supported at this endpoint.
441
442 Args:
443 name: string, Only include APIs with the given name.
444 preferred: boolean, Return only the preferred version of an API.
445
446 Returns:
447 An object of the form:
448
449 {
450 &quot;discoveryVersion&quot;: &quot;v1&quot;, # Indicate the version of the Discovery API used to generate this doc.
451 &quot;items&quot;: [ # The individual directory entries. One entry per api/version pair.
452 {
453 &quot;description&quot;: &quot;A String&quot;, # The description of this API.
454 &quot;discoveryLink&quot;: &quot;A String&quot;, # A link to the discovery document.
455 &quot;discoveryRestUrl&quot;: &quot;A String&quot;, # The URL for the discovery REST document.
456 &quot;documentationLink&quot;: &quot;A String&quot;, # A link to human readable documentation for the API.
457 &quot;icons&quot;: { # Links to 16x16 and 32x32 icons representing the API.
458 &quot;x16&quot;: &quot;A String&quot;, # The URL of the 16x16 icon.
459 &quot;x32&quot;: &quot;A String&quot;, # The URL of the 32x32 icon.
460 },
461 &quot;id&quot;: &quot;A String&quot;, # The id of this API.
462 &quot;kind&quot;: &quot;discovery#directoryItem&quot;, # The kind for this response.
463 &quot;labels&quot;: [ # Labels for the status of this API, such as labs or deprecated.
464 &quot;A String&quot;,
465 ],
466 &quot;name&quot;: &quot;A String&quot;, # The name of the API.
467 &quot;preferred&quot;: True or False, # True if this version is the preferred version to use.
468 &quot;title&quot;: &quot;A String&quot;, # The title of this API.
469 &quot;version&quot;: &quot;A String&quot;, # The version of the API.
470 },
471 ],
472 &quot;kind&quot;: &quot;discovery#directoryList&quot;, # The kind for this response.
473 }</pre>
474 </div>
475
476 </body></html>