OLD | NEW |
(Empty) | |
| 1 { |
| 2 "basePath": "/discovery/v1/", |
| 3 "baseUrl": "https://www.googleapis.com/discovery/v1/", |
| 4 "batchPath": "batch", |
| 5 "description": "Lets you discover 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": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/UNFMI_ENJ3hAFRWSi4GLSerTeFg\"", |
| 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 par
tial response.", |
| 33 "location": "query", |
| 34 "type": "string" |
| 35 }, |
| 36 "key": { |
| 37 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 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": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
| 57 "userIp": { |
| 58 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 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 ver
sion 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 nam
e.", |
| 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 "rootUrl": "https://www.googleapis.com/", |
| 120 "schemas": { |
| 121 "DirectoryList": { |
| 122 "id": "DirectoryList", |
| 123 "properties": { |
| 124 "discoveryVersion": { |
| 125 "default": "v1", |
| 126 "description": "Indicate the version of the Discovery API us
ed to generate this doc.", |
| 127 "type": "string" |
| 128 }, |
| 129 "items": { |
| 130 "description": "The individual directory entries. One entry
per api/version pair.", |
| 131 "items": { |
| 132 "properties": { |
| 133 "description": { |
| 134 "description": "The description of this API.", |
| 135 "type": "string" |
| 136 }, |
| 137 "discoveryLink": { |
| 138 "description": "A link to the discovery document
.", |
| 139 "type": "string" |
| 140 }, |
| 141 "discoveryRestUrl": { |
| 142 "description": "The URL for the discovery REST d
ocument.", |
| 143 "type": "string" |
| 144 }, |
| 145 "documentationLink": { |
| 146 "description": "A link to human readable documen
tation for the API.", |
| 147 "type": "string" |
| 148 }, |
| 149 "icons": { |
| 150 "description": "Links to 16x16 and 32x32 icons r
epresenting the API.", |
| 151 "properties": { |
| 152 "x16": { |
| 153 "description": "The URL of the 16x16 ico
n.", |
| 154 "type": "string" |
| 155 }, |
| 156 "x32": { |
| 157 "description": "The URL of the 32x32 ico
n.", |
| 158 "type": "string" |
| 159 } |
| 160 }, |
| 161 "type": "object" |
| 162 }, |
| 163 "id": { |
| 164 "description": "The id of this API.", |
| 165 "type": "string" |
| 166 }, |
| 167 "kind": { |
| 168 "default": "discovery#directoryItem", |
| 169 "description": "The kind for this response.", |
| 170 "type": "string" |
| 171 }, |
| 172 "labels": { |
| 173 "description": "Labels for the status of this AP
I, such as labs or deprecated.", |
| 174 "items": { |
| 175 "type": "string" |
| 176 }, |
| 177 "type": "array" |
| 178 }, |
| 179 "name": { |
| 180 "description": "The name of the API.", |
| 181 "type": "string" |
| 182 }, |
| 183 "preferred": { |
| 184 "description": "True if this version is the pref
erred version to use.", |
| 185 "type": "boolean" |
| 186 }, |
| 187 "title": { |
| 188 "description": "The title of this API.", |
| 189 "type": "string" |
| 190 }, |
| 191 "version": { |
| 192 "description": "The version of the API.", |
| 193 "type": "string" |
| 194 } |
| 195 }, |
| 196 "type": "object" |
| 197 }, |
| 198 "type": "array" |
| 199 }, |
| 200 "kind": { |
| 201 "default": "discovery#directoryList", |
| 202 "description": "The kind for this response.", |
| 203 "type": "string" |
| 204 } |
| 205 }, |
| 206 "type": "object" |
| 207 }, |
| 208 "JsonSchema": { |
| 209 "id": "JsonSchema", |
| 210 "properties": { |
| 211 "$ref": { |
| 212 "description": "A reference to another schema. The value of
this property is the \"id\" of another schema.", |
| 213 "type": "string" |
| 214 }, |
| 215 "additionalProperties": { |
| 216 "$ref": "JsonSchema", |
| 217 "description": "If this is a schema for an object, this prop
erty is the schema for any additional properties with dynamic keys on this objec
t." |
| 218 }, |
| 219 "annotations": { |
| 220 "description": "Additional information about this property."
, |
| 221 "properties": { |
| 222 "required": { |
| 223 "description": "A list of methods for which this pro
perty is required on requests.", |
| 224 "items": { |
| 225 "type": "string" |
| 226 }, |
| 227 "type": "array" |
| 228 } |
| 229 }, |
| 230 "type": "object" |
| 231 }, |
| 232 "default": { |
| 233 "description": "The default value of this property (if one e
xists).", |
| 234 "type": "string" |
| 235 }, |
| 236 "description": { |
| 237 "description": "A description of this object.", |
| 238 "type": "string" |
| 239 }, |
| 240 "enum": { |
| 241 "description": "Values this parameter may take (if it is an
enum).", |
| 242 "items": { |
| 243 "type": "string" |
| 244 }, |
| 245 "type": "array" |
| 246 }, |
| 247 "enumDescriptions": { |
| 248 "description": "The descriptions for the enums. Each positio
n maps to the corresponding value in the \"enum\" array.", |
| 249 "items": { |
| 250 "type": "string" |
| 251 }, |
| 252 "type": "array" |
| 253 }, |
| 254 "format": { |
| 255 "description": "An additional regular expression or key that
helps constrain the value. For more details see: http://tools.ietf.org/html/dra
ft-zyp-json-schema-03#section-5.23", |
| 256 "type": "string" |
| 257 }, |
| 258 "id": { |
| 259 "description": "Unique identifier for this schema.", |
| 260 "type": "string" |
| 261 }, |
| 262 "items": { |
| 263 "$ref": "JsonSchema", |
| 264 "description": "If this is a schema for an array, this prope
rty is the schema for each element in the array." |
| 265 }, |
| 266 "location": { |
| 267 "description": "Whether this parameter goes in the query or
the path for REST requests.", |
| 268 "type": "string" |
| 269 }, |
| 270 "maximum": { |
| 271 "description": "The maximum value of this parameter.", |
| 272 "type": "string" |
| 273 }, |
| 274 "minimum": { |
| 275 "description": "The minimum value of this parameter.", |
| 276 "type": "string" |
| 277 }, |
| 278 "pattern": { |
| 279 "description": "The regular expression this parameter must c
onform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/ja
va/util/regex/Pattern.html", |
| 280 "type": "string" |
| 281 }, |
| 282 "properties": { |
| 283 "additionalProperties": { |
| 284 "$ref": "JsonSchema", |
| 285 "description": "A single property of this object. The va
lue is itself a JSON Schema object describing this property." |
| 286 }, |
| 287 "description": "If this is a schema for an object, list the
schema for each property of this object.", |
| 288 "type": "object" |
| 289 }, |
| 290 "readOnly": { |
| 291 "description": "The value is read-only, generated by the ser
vice. 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.", |
| 292 "type": "boolean" |
| 293 }, |
| 294 "repeated": { |
| 295 "description": "Whether this parameter may appear multiple t
imes.", |
| 296 "type": "boolean" |
| 297 }, |
| 298 "required": { |
| 299 "description": "Whether the parameter is required.", |
| 300 "type": "boolean" |
| 301 }, |
| 302 "type": { |
| 303 "description": "The value type for this schema. A list of va
lues can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#sect
ion-5.1", |
| 304 "type": "string" |
| 305 }, |
| 306 "variant": { |
| 307 "description": "In a variant data type, the value of one pro
perty is used to determine how to interpret the entire entity. Its value must ex
ist in a map of descriminant values to schema names.", |
| 308 "properties": { |
| 309 "discriminant": { |
| 310 "description": "The name of the type discriminant pr
operty.", |
| 311 "type": "string" |
| 312 }, |
| 313 "map": { |
| 314 "description": "The map of discriminant value to sch
ema to use for parsing..", |
| 315 "items": { |
| 316 "properties": { |
| 317 "$ref": { |
| 318 "type": "string" |
| 319 }, |
| 320 "type_value": { |
| 321 "type": "string" |
| 322 } |
| 323 }, |
| 324 "type": "object" |
| 325 }, |
| 326 "type": "array" |
| 327 } |
| 328 }, |
| 329 "type": "object" |
| 330 } |
| 331 }, |
| 332 "type": "object" |
| 333 }, |
| 334 "RestDescription": { |
| 335 "id": "RestDescription", |
| 336 "properties": { |
| 337 "auth": { |
| 338 "description": "Authentication information.", |
| 339 "properties": { |
| 340 "oauth2": { |
| 341 "description": "OAuth 2.0 authentication information
.", |
| 342 "properties": { |
| 343 "scopes": { |
| 344 "additionalProperties": { |
| 345 "description": "The scope value.", |
| 346 "properties": { |
| 347 "description": { |
| 348 "description": "Description of s
cope.", |
| 349 "type": "string" |
| 350 } |
| 351 }, |
| 352 "type": "object" |
| 353 }, |
| 354 "description": "Available OAuth 2.0 scopes."
, |
| 355 "type": "object" |
| 356 } |
| 357 }, |
| 358 "type": "object" |
| 359 } |
| 360 }, |
| 361 "type": "object" |
| 362 }, |
| 363 "basePath": { |
| 364 "description": "[DEPRECATED] The base path for REST requests
.", |
| 365 "type": "string" |
| 366 }, |
| 367 "baseUrl": { |
| 368 "description": "[DEPRECATED] The base URL for REST requests.
", |
| 369 "type": "string" |
| 370 }, |
| 371 "batchPath": { |
| 372 "default": "batch", |
| 373 "description": "The path for REST batch requests.", |
| 374 "type": "string" |
| 375 }, |
| 376 "canonicalName": { |
| 377 "description": "Indicates how the API name should be capital
ized and split into various parts. Useful for generating pretty class names.", |
| 378 "type": "string" |
| 379 }, |
| 380 "description": { |
| 381 "description": "The description of this API.", |
| 382 "type": "string" |
| 383 }, |
| 384 "discoveryVersion": { |
| 385 "default": "v1", |
| 386 "description": "Indicate the version of the Discovery API us
ed to generate this doc.", |
| 387 "type": "string" |
| 388 }, |
| 389 "documentationLink": { |
| 390 "description": "A link to human readable documentation for t
he API.", |
| 391 "type": "string" |
| 392 }, |
| 393 "etag": { |
| 394 "description": "The ETag for this response.", |
| 395 "readOnly": true, |
| 396 "type": "string" |
| 397 }, |
| 398 "features": { |
| 399 "description": "A list of supported features for this API.", |
| 400 "items": { |
| 401 "type": "string" |
| 402 }, |
| 403 "type": "array" |
| 404 }, |
| 405 "icons": { |
| 406 "description": "Links to 16x16 and 32x32 icons representing
the API.", |
| 407 "properties": { |
| 408 "x16": { |
| 409 "description": "The URL of the 16x16 icon.", |
| 410 "type": "string" |
| 411 }, |
| 412 "x32": { |
| 413 "description": "The URL of the 32x32 icon.", |
| 414 "type": "string" |
| 415 } |
| 416 }, |
| 417 "type": "object" |
| 418 }, |
| 419 "id": { |
| 420 "description": "The ID of this API.", |
| 421 "type": "string" |
| 422 }, |
| 423 "kind": { |
| 424 "default": "discovery#restDescription", |
| 425 "description": "The kind for this response.", |
| 426 "type": "string" |
| 427 }, |
| 428 "labels": { |
| 429 "description": "Labels for the status of this API, such as l
abs or deprecated.", |
| 430 "items": { |
| 431 "type": "string" |
| 432 }, |
| 433 "type": "array" |
| 434 }, |
| 435 "methods": { |
| 436 "additionalProperties": { |
| 437 "$ref": "RestMethod", |
| 438 "description": "An individual method description." |
| 439 }, |
| 440 "description": "API-level methods for this API.", |
| 441 "type": "object" |
| 442 }, |
| 443 "name": { |
| 444 "description": "The name of this API.", |
| 445 "type": "string" |
| 446 }, |
| 447 "ownerDomain": { |
| 448 "description": "The domain of the owner of this API. Togethe
r with the ownerName and a packagePath values, this can be used to generate a li
brary for this API which would have a unique fully qualified name.", |
| 449 "type": "string" |
| 450 }, |
| 451 "ownerName": { |
| 452 "description": "The name of the owner of this API. See owner
Domain.", |
| 453 "type": "string" |
| 454 }, |
| 455 "packagePath": { |
| 456 "description": "The package of the owner of this API. See ow
nerDomain.", |
| 457 "type": "string" |
| 458 }, |
| 459 "parameters": { |
| 460 "additionalProperties": { |
| 461 "$ref": "JsonSchema", |
| 462 "description": "Description of a single parameter." |
| 463 }, |
| 464 "description": "Common parameters that apply across all apis
.", |
| 465 "type": "object" |
| 466 }, |
| 467 "protocol": { |
| 468 "default": "rest", |
| 469 "description": "The protocol described by this document.", |
| 470 "type": "string" |
| 471 }, |
| 472 "resources": { |
| 473 "additionalProperties": { |
| 474 "$ref": "RestResource", |
| 475 "description": "An individual resource description. Cont
ains methods and sub-resources related to this resource." |
| 476 }, |
| 477 "description": "The resources in this API.", |
| 478 "type": "object" |
| 479 }, |
| 480 "revision": { |
| 481 "description": "The version of this API.", |
| 482 "type": "string" |
| 483 }, |
| 484 "rootUrl": { |
| 485 "description": "The root URL under which all API services li
ve.", |
| 486 "type": "string" |
| 487 }, |
| 488 "schemas": { |
| 489 "additionalProperties": { |
| 490 "$ref": "JsonSchema", |
| 491 "description": "An individual schema description." |
| 492 }, |
| 493 "description": "The schemas for this API.", |
| 494 "type": "object" |
| 495 }, |
| 496 "servicePath": { |
| 497 "description": "The base path for all REST requests.", |
| 498 "type": "string" |
| 499 }, |
| 500 "title": { |
| 501 "description": "The title of this API.", |
| 502 "type": "string" |
| 503 }, |
| 504 "version": { |
| 505 "description": "The version of this API.", |
| 506 "type": "string" |
| 507 } |
| 508 }, |
| 509 "type": "object" |
| 510 }, |
| 511 "RestMethod": { |
| 512 "id": "RestMethod", |
| 513 "properties": { |
| 514 "description": { |
| 515 "description": "Description of this method.", |
| 516 "type": "string" |
| 517 }, |
| 518 "etagRequired": { |
| 519 "description": "Whether this method requires an ETag to be s
pecified. The ETag is sent as an HTTP If-Match or If-None-Match header.", |
| 520 "type": "boolean" |
| 521 }, |
| 522 "httpMethod": { |
| 523 "description": "HTTP method used by this method.", |
| 524 "type": "string" |
| 525 }, |
| 526 "id": { |
| 527 "description": "A unique ID for this method. This property c
an be used to match methods between different versions of Discovery.", |
| 528 "type": "string" |
| 529 }, |
| 530 "mediaUpload": { |
| 531 "description": "Media upload parameters.", |
| 532 "properties": { |
| 533 "accept": { |
| 534 "description": "MIME Media Ranges for acceptable med
ia uploads to this method.", |
| 535 "items": { |
| 536 "type": "string" |
| 537 }, |
| 538 "type": "array" |
| 539 }, |
| 540 "maxSize": { |
| 541 "description": "Maximum size of a media upload, such
as \"1MB\", \"2GB\" or \"3TB\".", |
| 542 "type": "string" |
| 543 }, |
| 544 "protocols": { |
| 545 "description": "Supported upload protocols.", |
| 546 "properties": { |
| 547 "resumable": { |
| 548 "description": "Supports the Resumable Media
Upload protocol.", |
| 549 "properties": { |
| 550 "multipart": { |
| 551 "default": "true", |
| 552 "description": "True if this endpoin
t supports uploading multipart media.", |
| 553 "type": "boolean" |
| 554 }, |
| 555 "path": { |
| 556 "description": "The URI path to be u
sed for upload. Should be used in conjunction with the basePath property at the
api-level.", |
| 557 "type": "string" |
| 558 } |
| 559 }, |
| 560 "type": "object" |
| 561 }, |
| 562 "simple": { |
| 563 "description": "Supports uploading as a sing
le HTTP request.", |
| 564 "properties": { |
| 565 "multipart": { |
| 566 "default": "true", |
| 567 "description": "True if this endpoin
t supports upload multipart media.", |
| 568 "type": "boolean" |
| 569 }, |
| 570 "path": { |
| 571 "description": "The URI path to be u
sed for upload. Should be used in conjunction with the basePath property at the
api-level.", |
| 572 "type": "string" |
| 573 } |
| 574 }, |
| 575 "type": "object" |
| 576 } |
| 577 }, |
| 578 "type": "object" |
| 579 } |
| 580 }, |
| 581 "type": "object" |
| 582 }, |
| 583 "parameterOrder": { |
| 584 "description": "Ordered list of required parameters, serves
as a hint to clients on how to structure their method signatures. The array is o
rdered such that the \"most-significant\" parameter appears first.", |
| 585 "items": { |
| 586 "type": "string" |
| 587 }, |
| 588 "type": "array" |
| 589 }, |
| 590 "parameters": { |
| 591 "additionalProperties": { |
| 592 "$ref": "JsonSchema", |
| 593 "description": "Details for a single parameter in this m
ethod." |
| 594 }, |
| 595 "description": "Details for all parameters in this method.", |
| 596 "type": "object" |
| 597 }, |
| 598 "path": { |
| 599 "description": "The URI path of this REST method. Should be
used in conjunction with the basePath property at the api-level.", |
| 600 "type": "string" |
| 601 }, |
| 602 "request": { |
| 603 "description": "The schema for the request.", |
| 604 "properties": { |
| 605 "$ref": { |
| 606 "description": "Schema ID for the request schema.", |
| 607 "type": "string" |
| 608 }, |
| 609 "parameterName": { |
| 610 "description": "parameter name.", |
| 611 "type": "string" |
| 612 } |
| 613 }, |
| 614 "type": "object" |
| 615 }, |
| 616 "response": { |
| 617 "description": "The schema for the response.", |
| 618 "properties": { |
| 619 "$ref": { |
| 620 "description": "Schema ID for the response schema.", |
| 621 "type": "string" |
| 622 } |
| 623 }, |
| 624 "type": "object" |
| 625 }, |
| 626 "scopes": { |
| 627 "description": "OAuth 2.0 scopes applicable to this method."
, |
| 628 "items": { |
| 629 "type": "string" |
| 630 }, |
| 631 "type": "array" |
| 632 }, |
| 633 "supportsMediaDownload": { |
| 634 "description": "Whether this method supports media downloads
.", |
| 635 "type": "boolean" |
| 636 }, |
| 637 "supportsMediaUpload": { |
| 638 "description": "Whether this method supports media uploads."
, |
| 639 "type": "boolean" |
| 640 }, |
| 641 "supportsSubscription": { |
| 642 "description": "Whether this method supports subscriptions."
, |
| 643 "type": "boolean" |
| 644 } |
| 645 }, |
| 646 "type": "object" |
| 647 }, |
| 648 "RestResource": { |
| 649 "id": "RestResource", |
| 650 "properties": { |
| 651 "methods": { |
| 652 "additionalProperties": { |
| 653 "$ref": "RestMethod", |
| 654 "description": "Description for any methods on this reso
urce." |
| 655 }, |
| 656 "description": "Methods on this resource.", |
| 657 "type": "object" |
| 658 }, |
| 659 "resources": { |
| 660 "additionalProperties": { |
| 661 "$ref": "RestResource", |
| 662 "description": "Description for any sub-resources on thi
s resource." |
| 663 }, |
| 664 "description": "Sub-resources on this resource.", |
| 665 "type": "object" |
| 666 } |
| 667 }, |
| 668 "type": "object" |
| 669 } |
| 670 }, |
| 671 "servicePath": "discovery/v1/", |
| 672 "title": "APIs Discovery Service", |
| 673 "version": "v1" |
| 674 } |
OLD | NEW |