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