1{
2 "basePath": "/discovery/v1/",
3 "baseUrl": "https://www.googleapis.com/discovery/v1/",
4 "batchPath": "batch/discovery/v1",
5 "description": "Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API.",
6 "discoveryVersion": "v1",
7 "documentationLink": "https://developers.google.com/discovery/",
8 "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/vabF8Q1ADCm_Bt9EBq9rkrRawQA\"",
9 "icons": {
10 "x16": "http://www.google.com/images/icons/feature/filing_cabinet_search-g16.png",
11 "x32": "http://www.google.com/images/icons/feature/filing_cabinet_search-g32.png"
12 },
13 "id": "discovery:v1",
14 "kind": "discovery#restDescription",
15 "name": "discovery",
16 "ownerDomain": "google.com",
17 "ownerName": "Google",
18 "parameters": {
19 "alt": {
20 "default": "json",
21 "description": "Data format for the response.",
22 "enum": [
23 "json"
24 ],
25 "enumDescriptions": [
26 "Responses with Content-Type of application/json"
27 ],
28 "location": "query",
29 "type": "string"
30 },
31 "fields": {
32 "description": "Selector specifying which fields to include in a partial response.",
33 "location": "query",
34 "type": "string"
35 },
36 "key": {
37 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
38 "location": "query",
39 "type": "string"
40 },
41 "oauth_token": {
42 "description": "OAuth 2.0 token for the current user.",
43 "location": "query",
44 "type": "string"
45 },
46 "prettyPrint": {
47 "default": "true",
48 "description": "Returns response with indentations and line breaks.",
49 "location": "query",
50 "type": "boolean"
51 },
52 "quotaUser": {
53 "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
54 "location": "query",
55 "type": "string"
56 },
57 "userIp": {
58 "description": "Deprecated. Please use quotaUser instead.",
59 "location": "query",
60 "type": "string"
61 }
62 },
63 "protocol": "rest",
64 "resources": {
65 "apis": {
66 "methods": {
67 "getRest": {
68 "description": "Retrieve the description of a particular version of an api.",
69 "httpMethod": "GET",
70 "id": "discovery.apis.getRest",
71 "parameterOrder": [
72 "api",
73 "version"
74 ],
75 "parameters": {
76 "api": {
77 "description": "The name of the API.",
78 "location": "path",
79 "required": true,
80 "type": "string"
81 },
82 "version": {
83 "description": "The version of the API.",
84 "location": "path",
85 "required": true,
86 "type": "string"
87 }
88 },
89 "path": "apis/{api}/{version}/rest",
90 "response": {
91 "$ref": "RestDescription"
92 }
93 },
94 "list": {
95 "description": "Retrieve the list of APIs supported at this endpoint.",
96 "httpMethod": "GET",
97 "id": "discovery.apis.list",
98 "parameters": {
99 "name": {
100 "description": "Only include APIs with the given name.",
101 "location": "query",
102 "type": "string"
103 },
104 "preferred": {
105 "default": "false",
106 "description": "Return only the preferred version of an API.",
107 "location": "query",
108 "type": "boolean"
109 }
110 },
111 "path": "apis",
112 "response": {
113 "$ref": "DirectoryList"
114 }
115 }
116 }
117 }
118 },
119 "revision": "20200806",
120 "rootUrl": "https://www.googleapis.com/",
121 "schemas": {
122 "DirectoryList": {
123 "id": "DirectoryList",
124 "properties": {
125 "discoveryVersion": {
126 "default": "v1",
127 "description": "Indicate the version of the Discovery API used to generate this doc.",
128 "type": "string"
129 },
130 "items": {
131 "description": "The individual directory entries. One entry per api/version pair.",
132 "items": {
133 "properties": {
134 "description": {
135 "description": "The description of this API.",
136 "type": "string"
137 },
138 "discoveryLink": {
139 "description": "A link to the discovery document.",
140 "type": "string"
141 },
142 "discoveryRestUrl": {
143 "description": "The URL for the discovery REST document.",
144 "type": "string"
145 },
146 "documentationLink": {
147 "description": "A link to human readable documentation for the API.",
148 "type": "string"
149 },
150 "icons": {
151 "description": "Links to 16x16 and 32x32 icons representing the API.",
152 "properties": {
153 "x16": {
154 "description": "The URL of the 16x16 icon.",
155 "type": "string"
156 },
157 "x32": {
158 "description": "The URL of the 32x32 icon.",
159 "type": "string"
160 }
161 },
162 "type": "object"
163 },
164 "id": {
165 "description": "The id of this API.",
166 "type": "string"
167 },
168 "kind": {
169 "default": "discovery#directoryItem",
170 "description": "The kind for this response.",
171 "type": "string"
172 },
173 "labels": {
174 "description": "Labels for the status of this API, such as labs or deprecated.",
175 "items": {
176 "type": "string"
177 },
178 "type": "array"
179 },
180 "name": {
181 "description": "The name of the API.",
182 "type": "string"
183 },
184 "preferred": {
185 "description": "True if this version is the preferred version to use.",
186 "type": "boolean"
187 },
188 "title": {
189 "description": "The title of this API.",
190 "type": "string"
191 },
192 "version": {
193 "description": "The version of the API.",
194 "type": "string"
195 }
196 },
197 "type": "object"
198 },
199 "type": "array"
200 },
201 "kind": {
202 "default": "discovery#directoryList",
203 "description": "The kind for this response.",
204 "type": "string"
205 }
206 },
207 "type": "object"
208 },
209 "JsonSchema": {
210 "id": "JsonSchema",
211 "properties": {
212 "$ref": {
213 "description": "A reference to another schema. The value of this property is the \"id\" of another schema.",
214 "type": "string"
215 },
216 "additionalProperties": {
217 "$ref": "JsonSchema",
218 "description": "If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object."
219 },
220 "annotations": {
221 "description": "Additional information about this property.",
222 "properties": {
223 "required": {
224 "description": "A list of methods for which this property is required on requests.",
225 "items": {
226 "type": "string"
227 },
228 "type": "array"
229 }
230 },
231 "type": "object"
232 },
233 "default": {
234 "description": "The default value of this property (if one exists).",
235 "type": "string"
236 },
237 "deprecated": {
238 "description": "Whether the parameter is deprecated.",
239 "type": "boolean"
240 },
241 "description": {
242 "description": "A description of this object.",
243 "type": "string"
244 },
245 "enum": {
246 "description": "Values this parameter may take (if it is an enum).",
247 "items": {
248 "type": "string"
249 },
250 "type": "array"
251 },
252 "enumDeprecated": {
253 "description": "The deprecation status for the enums. Each position maps to the corresponding value in the \"enum\" array.",
254 "items": {
255 "type": "boolean"
256 },
257 "type": "array"
258 },
259 "enumDescriptions": {
260 "description": "The descriptions for the enums. Each position maps to the corresponding value in the \"enum\" array.",
261 "items": {
262 "type": "string"
263 },
264 "type": "array"
265 },
266 "format": {
267 "description": "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",
268 "type": "string"
269 },
270 "id": {
271 "description": "Unique identifier for this schema.",
272 "type": "string"
273 },
274 "items": {
275 "$ref": "JsonSchema",
276 "description": "If this is a schema for an array, this property is the schema for each element in the array."
277 },
278 "location": {
279 "description": "Whether this parameter goes in the query or the path for REST requests.",
280 "type": "string"
281 },
282 "maximum": {
283 "description": "The maximum value of this parameter.",
284 "type": "string"
285 },
286 "minimum": {
287 "description": "The minimum value of this parameter.",
288 "type": "string"
289 },
290 "pattern": {
291 "description": "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",
292 "type": "string"
293 },
294 "properties": {
295 "additionalProperties": {
296 "$ref": "JsonSchema",
297 "description": "A single property of this object. The value is itself a JSON Schema object describing this property."
298 },
299 "description": "If this is a schema for an object, list the schema for each property of this object.",
300 "type": "object"
301 },
302 "readOnly": {
303 "description": "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.",
304 "type": "boolean"
305 },
306 "repeated": {
307 "description": "Whether this parameter may appear multiple times.",
308 "type": "boolean"
309 },
310 "required": {
311 "description": "Whether the parameter is required.",
312 "type": "boolean"
313 },
314 "type": {
315 "description": "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",
316 "type": "string"
317 },
318 "variant": {
319 "description": "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.",
320 "properties": {
321 "discriminant": {
322 "description": "The name of the type discriminant property.",
323 "type": "string"
324 },
325 "map": {
326 "description": "The map of discriminant value to schema to use for parsing..",
327 "items": {
328 "properties": {
329 "$ref": {
330 "type": "string"
331 },
332 "type_value": {
333 "type": "string"
334 }
335 },
336 "type": "object"
337 },
338 "type": "array"
339 }
340 },
341 "type": "object"
342 }
343 },
344 "type": "object"
345 },
346 "RestDescription": {
347 "id": "RestDescription",
348 "properties": {
349 "auth": {
350 "description": "Authentication information.",
351 "properties": {
352 "oauth2": {
353 "description": "OAuth 2.0 authentication information.",
354 "properties": {
355 "scopes": {
356 "additionalProperties": {
357 "description": "The scope value.",
358 "properties": {
359 "description": {
360 "description": "Description of scope.",
361 "type": "string"
362 }
363 },
364 "type": "object"
365 },
366 "description": "Available OAuth 2.0 scopes.",
367 "type": "object"
368 }
369 },
370 "type": "object"
371 }
372 },
373 "type": "object"
374 },
375 "basePath": {
376 "description": "[DEPRECATED] The base path for REST requests.",
377 "type": "string"
378 },
379 "baseUrl": {
380 "description": "[DEPRECATED] The base URL for REST requests.",
381 "type": "string"
382 },
383 "batchPath": {
384 "description": "The path for REST batch requests.",
385 "type": "string"
386 },
387 "canonicalName": {
388 "description": "Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.",
389 "type": "string"
390 },
391 "description": {
392 "description": "The description of this API.",
393 "type": "string"
394 },
395 "discoveryVersion": {
396 "default": "v1",
397 "description": "Indicate the version of the Discovery API used to generate this doc.",
398 "type": "string"
399 },
400 "documentationLink": {
401 "description": "A link to human readable documentation for the API.",
402 "type": "string"
403 },
404 "endpoints": {
405 "description": "A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status.",
406 "items": {
407 "description": "A single endpoint object",
408 "properties": {
409 "deprecated": {
410 "description": "Whether this endpoint is deprecated",
411 "type": "boolean"
412 },
413 "description": {
414 "description": "A string describing the host designated by the URL",
415 "type": "string"
416 },
417 "endpointUrl": {
418 "description": "The URL of the endpoint target host",
419 "type": "string"
420 },
421 "location": {
422 "description": "The location of the endpoint",
423 "type": "string"
424 }
425 },
426 "type": "object"
427 },
428 "type": "array"
429 },
430 "etag": {
431 "description": "The ETag for this response.",
432 "readOnly": true,
433 "type": "string"
434 },
435 "exponentialBackoffDefault": {
436 "description": "Enable exponential backoff for suitable methods in the generated clients.",
437 "type": "boolean"
438 },
439 "features": {
440 "description": "A list of supported features for this API.",
441 "items": {
442 "type": "string"
443 },
444 "type": "array"
445 },
446 "icons": {
447 "description": "Links to 16x16 and 32x32 icons representing the API.",
448 "properties": {
449 "x16": {
450 "description": "The URL of the 16x16 icon.",
451 "type": "string"
452 },
453 "x32": {
454 "description": "The URL of the 32x32 icon.",
455 "type": "string"
456 }
457 },
458 "type": "object"
459 },
460 "id": {
461 "description": "The ID of this API.",
462 "type": "string"
463 },
464 "kind": {
465 "default": "discovery#restDescription",
466 "description": "The kind for this response.",
467 "type": "string"
468 },
469 "labels": {
470 "description": "Labels for the status of this API, such as labs or deprecated.",
471 "items": {
472 "type": "string"
473 },
474 "type": "array"
475 },
476 "methods": {
477 "additionalProperties": {
478 "$ref": "RestMethod",
479 "description": "An individual method description."
480 },
481 "description": "API-level methods for this API.",
482 "type": "object"
483 },
484 "name": {
485 "description": "The name of this API.",
486 "type": "string"
487 },
488 "ownerDomain": {
489 "description": "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.",
490 "type": "string"
491 },
492 "ownerName": {
493 "description": "The name of the owner of this API. See ownerDomain.",
494 "type": "string"
495 },
496 "packagePath": {
497 "description": "The package of the owner of this API. See ownerDomain.",
498 "type": "string"
499 },
500 "parameters": {
501 "additionalProperties": {
502 "$ref": "JsonSchema",
503 "description": "Description of a single parameter."
504 },
505 "description": "Common parameters that apply across all apis.",
506 "type": "object"
507 },
508 "protocol": {
509 "default": "rest",
510 "description": "The protocol described by this document.",
511 "type": "string"
512 },
513 "resources": {
514 "additionalProperties": {
515 "$ref": "RestResource",
516 "description": "An individual resource description. Contains methods and sub-resources related to this resource."
517 },
518 "description": "The resources in this API.",
519 "type": "object"
520 },
521 "revision": {
522 "description": "The version of this API.",
523 "type": "string"
524 },
525 "rootUrl": {
526 "description": "The root URL under which all API services live.",
527 "type": "string"
528 },
529 "schemas": {
530 "additionalProperties": {
531 "$ref": "JsonSchema",
532 "description": "An individual schema description."
533 },
534 "description": "The schemas for this API.",
535 "type": "object"
536 },
537 "servicePath": {
538 "description": "The base path for all REST requests.",
539 "type": "string"
540 },
541 "title": {
542 "description": "The title of this API.",
543 "type": "string"
544 },
545 "version": {
546 "description": "The version of this API.",
547 "type": "string"
548 },
549 "version_module": {
550 "type": "boolean"
551 }
552 },
553 "type": "object"
554 },
555 "RestMethod": {
556 "id": "RestMethod",
557 "properties": {
558 "apiVersion": {
559 "description": "The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter.",
560 "type": "string"
561 },
562 "deprecated": {
563 "description": "Whether this method is deprecated.",
564 "type": "boolean"
565 },
566 "description": {
567 "description": "Description of this method.",
568 "type": "string"
569 },
570 "etagRequired": {
571 "description": "Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.",
572 "type": "boolean"
573 },
574 "flatPath": {
575 "description": "The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property.",
576 "type": "string"
577 },
578 "httpMethod": {
579 "description": "HTTP method used by this method.",
580 "type": "string"
581 },
582 "id": {
583 "description": "A unique ID for this method. This property can be used to match methods between different versions of Discovery.",
584 "type": "string"
585 },
586 "mediaUpload": {
587 "description": "Media upload parameters.",
588 "properties": {
589 "accept": {
590 "description": "MIME Media Ranges for acceptable media uploads to this method.",
591 "items": {
592 "type": "string"
593 },
594 "type": "array"
595 },
596 "maxSize": {
597 "description": "Maximum size of a media upload, such as \"1MB\", \"2GB\" or \"3TB\".",
598 "type": "string"
599 },
600 "protocols": {
601 "description": "Supported upload protocols.",
602 "properties": {
603 "resumable": {
604 "description": "Supports the Resumable Media Upload protocol.",
605 "properties": {
606 "multipart": {
607 "default": "true",
608 "description": "True if this endpoint supports uploading multipart media.",
609 "type": "boolean"
610 },
611 "path": {
612 "description": "The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.",
613 "type": "string"
614 }
615 },
616 "type": "object"
617 },
618 "simple": {
619 "description": "Supports uploading as a single HTTP request.",
620 "properties": {
621 "multipart": {
622 "default": "true",
623 "description": "True if this endpoint supports upload multipart media.",
624 "type": "boolean"
625 },
626 "path": {
627 "description": "The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.",
628 "type": "string"
629 }
630 },
631 "type": "object"
632 }
633 },
634 "type": "object"
635 }
636 },
637 "type": "object"
638 },
639 "parameterOrder": {
640 "description": "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.",
641 "items": {
642 "type": "string"
643 },
644 "type": "array"
645 },
646 "parameters": {
647 "additionalProperties": {
648 "$ref": "JsonSchema",
649 "description": "Details for a single parameter in this method."
650 },
651 "description": "Details for all parameters in this method.",
652 "type": "object"
653 },
654 "path": {
655 "description": "The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.",
656 "type": "string"
657 },
658 "request": {
659 "description": "The schema for the request.",
660 "properties": {
661 "$ref": {
662 "description": "Schema ID for the request schema.",
663 "type": "string"
664 },
665 "parameterName": {
666 "description": "parameter name.",
667 "type": "string"
668 }
669 },
670 "type": "object"
671 },
672 "response": {
673 "description": "The schema for the response.",
674 "properties": {
675 "$ref": {
676 "description": "Schema ID for the response schema.",
677 "type": "string"
678 }
679 },
680 "type": "object"
681 },
682 "scopes": {
683 "description": "OAuth 2.0 scopes applicable to this method.",
684 "items": {
685 "type": "string"
686 },
687 "type": "array"
688 },
689 "supportsMediaDownload": {
690 "description": "Whether this method supports media downloads.",
691 "type": "boolean"
692 },
693 "supportsMediaUpload": {
694 "description": "Whether this method supports media uploads.",
695 "type": "boolean"
696 },
697 "supportsSubscription": {
698 "description": "Whether this method supports subscriptions.",
699 "type": "boolean"
700 },
701 "useMediaDownloadService": {
702 "description": "Indicates that downloads from this method should use the download service URL (i.e. \"/download\"). Only applies if the method supports media download.",
703 "type": "boolean"
704 }
705 },
706 "type": "object"
707 },
708 "RestResource": {
709 "id": "RestResource",
710 "properties": {
711 "deprecated": {
712 "description": "Whether this resource is deprecated.",
713 "type": "boolean"
714 },
715 "methods": {
716 "additionalProperties": {
717 "$ref": "RestMethod",
718 "description": "Description for any methods on this resource."
719 },
720 "description": "Methods on this resource.",
721 "type": "object"
722 },
723 "resources": {
724 "additionalProperties": {
725 "$ref": "RestResource",
726 "description": "Description for any sub-resources on this resource."
727 },
728 "description": "Sub-resources on this resource.",
729 "type": "object"
730 }
731 },
732 "type": "object"
733 }
734 },
735 "servicePath": "discovery/v1/",
736 "title": "API Discovery Service",
737 "version": "v1"
738}View as plain text