You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

684 lines
23 KiB

  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": "\"Zkyw9ACJZUvcYmlFaKGChzhmtnE/qtQQ5rpiI8W_orJr-d7M5l-e3gY\"",
  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. "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 used 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 document.",
  143. "type": "string"
  144. },
  145. "documentationLink": {
  146. "description": "A link to human readable documentation for the API.",
  147. "type": "string"
  148. },
  149. "icons": {
  150. "description": "Links to 16x16 and 32x32 icons representing the API.",
  151. "properties": {
  152. "x16": {
  153. "description": "The URL of the 16x16 icon.",
  154. "type": "string"
  155. },
  156. "x32": {
  157. "description": "The URL of the 32x32 icon.",
  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 API, 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 preferred 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 property is the schema for any additional properties with dynamic keys on this object."
  218. },
  219. "annotations": {
  220. "description": "Additional information about this property.",
  221. "properties": {
  222. "required": {
  223. "description": "A list of methods for which this property 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 exists).",
  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 position 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/draft-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 property 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 conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html",
  280. "type": "string"
  281. },
  282. "properties": {
  283. "additionalProperties": {
  284. "$ref": "JsonSchema",
  285. "description": "A single property of this object. The value 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 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.",
  292. "type": "boolean"
  293. },
  294. "repeated": {
  295. "description": "Whether this parameter may appear multiple times.",
  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 values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1",
  304. "type": "string"
  305. },
  306. "variant": {
  307. "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.",
  308. "properties": {
  309. "discriminant": {
  310. "description": "The name of the type discriminant property.",
  311. "type": "string"
  312. },
  313. "map": {
  314. "description": "The map of discriminant value to schema 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 scope.",
  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. "description": "The path for REST batch requests.",
  373. "type": "string"
  374. },
  375. "canonicalName": {
  376. "description": "Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.",
  377. "type": "string"
  378. },
  379. "description": {
  380. "description": "The description of this API.",
  381. "type": "string"
  382. },
  383. "discoveryVersion": {
  384. "default": "v1",
  385. "description": "Indicate the version of the Discovery API used to generate this doc.",
  386. "type": "string"
  387. },
  388. "documentationLink": {
  389. "description": "A link to human readable documentation for the API.",
  390. "type": "string"
  391. },
  392. "etag": {
  393. "description": "The ETag for this response.",
  394. "readOnly": true,
  395. "type": "string"
  396. },
  397. "exponentialBackoffDefault": {
  398. "description": "Enable exponential backoff for suitable methods in the generated clients.",
  399. "type": "boolean"
  400. },
  401. "features": {
  402. "description": "A list of supported features for this API.",
  403. "items": {
  404. "type": "string"
  405. },
  406. "type": "array"
  407. },
  408. "icons": {
  409. "description": "Links to 16x16 and 32x32 icons representing the API.",
  410. "properties": {
  411. "x16": {
  412. "description": "The URL of the 16x16 icon.",
  413. "type": "string"
  414. },
  415. "x32": {
  416. "description": "The URL of the 32x32 icon.",
  417. "type": "string"
  418. }
  419. },
  420. "type": "object"
  421. },
  422. "id": {
  423. "description": "The ID of this API.",
  424. "type": "string"
  425. },
  426. "kind": {
  427. "default": "discovery#restDescription",
  428. "description": "The kind for this response.",
  429. "type": "string"
  430. },
  431. "labels": {
  432. "description": "Labels for the status of this API, such as labs or deprecated.",
  433. "items": {
  434. "type": "string"
  435. },
  436. "type": "array"
  437. },
  438. "methods": {
  439. "additionalProperties": {
  440. "$ref": "RestMethod",
  441. "description": "An individual method description."
  442. },
  443. "description": "API-level methods for this API.",
  444. "type": "object"
  445. },
  446. "name": {
  447. "description": "The name of this API.",
  448. "type": "string"
  449. },
  450. "ownerDomain": {
  451. "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.",
  452. "type": "string"
  453. },
  454. "ownerName": {
  455. "description": "The name of the owner of this API. See ownerDomain.",
  456. "type": "string"
  457. },
  458. "packagePath": {
  459. "description": "The package of the owner of this API. See ownerDomain.",
  460. "type": "string"
  461. },
  462. "parameters": {
  463. "additionalProperties": {
  464. "$ref": "JsonSchema",
  465. "description": "Description of a single parameter."
  466. },
  467. "description": "Common parameters that apply across all apis.",
  468. "type": "object"
  469. },
  470. "protocol": {
  471. "default": "rest",
  472. "description": "The protocol described by this document.",
  473. "type": "string"
  474. },
  475. "resources": {
  476. "additionalProperties": {
  477. "$ref": "RestResource",
  478. "description": "An individual resource description. Contains methods and sub-resources related to this resource."
  479. },
  480. "description": "The resources in this API.",
  481. "type": "object"
  482. },
  483. "revision": {
  484. "description": "The version of this API.",
  485. "type": "string"
  486. },
  487. "rootUrl": {
  488. "description": "The root URL under which all API services live.",
  489. "type": "string"
  490. },
  491. "schemas": {
  492. "additionalProperties": {
  493. "$ref": "JsonSchema",
  494. "description": "An individual schema description."
  495. },
  496. "description": "The schemas for this API.",
  497. "type": "object"
  498. },
  499. "servicePath": {
  500. "description": "The base path for all REST requests.",
  501. "type": "string"
  502. },
  503. "title": {
  504. "description": "The title of this API.",
  505. "type": "string"
  506. },
  507. "version": {
  508. "description": "The version of this API.",
  509. "type": "string"
  510. },
  511. "version_module": {
  512. "type": "boolean"
  513. }
  514. },
  515. "type": "object"
  516. },
  517. "RestMethod": {
  518. "id": "RestMethod",
  519. "properties": {
  520. "description": {
  521. "description": "Description of this method.",
  522. "type": "string"
  523. },
  524. "etagRequired": {
  525. "description": "Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.",
  526. "type": "boolean"
  527. },
  528. "httpMethod": {
  529. "description": "HTTP method used by this method.",
  530. "type": "string"
  531. },
  532. "id": {
  533. "description": "A unique ID for this method. This property can be used to match methods between different versions of Discovery.",
  534. "type": "string"
  535. },
  536. "mediaUpload": {
  537. "description": "Media upload parameters.",
  538. "properties": {
  539. "accept": {
  540. "description": "MIME Media Ranges for acceptable media uploads to this method.",
  541. "items": {
  542. "type": "string"
  543. },
  544. "type": "array"
  545. },
  546. "maxSize": {
  547. "description": "Maximum size of a media upload, such as \"1MB\", \"2GB\" or \"3TB\".",
  548. "type": "string"
  549. },
  550. "protocols": {
  551. "description": "Supported upload protocols.",
  552. "properties": {
  553. "resumable": {
  554. "description": "Supports the Resumable Media Upload protocol.",
  555. "properties": {
  556. "multipart": {
  557. "default": "true",
  558. "description": "True if this endpoint supports uploading multipart media.",
  559. "type": "boolean"
  560. },
  561. "path": {
  562. "description": "The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.",
  563. "type": "string"
  564. }
  565. },
  566. "type": "object"
  567. },
  568. "simple": {
  569. "description": "Supports uploading as a single HTTP request.",
  570. "properties": {
  571. "multipart": {
  572. "default": "true",
  573. "description": "True if this endpoint supports upload multipart media.",
  574. "type": "boolean"
  575. },
  576. "path": {
  577. "description": "The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.",
  578. "type": "string"
  579. }
  580. },
  581. "type": "object"
  582. }
  583. },
  584. "type": "object"
  585. }
  586. },
  587. "type": "object"
  588. },
  589. "parameterOrder": {
  590. "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.",
  591. "items": {
  592. "type": "string"
  593. },
  594. "type": "array"
  595. },
  596. "parameters": {
  597. "additionalProperties": {
  598. "$ref": "JsonSchema",
  599. "description": "Details for a single parameter in this method."
  600. },
  601. "description": "Details for all parameters in this method.",
  602. "type": "object"
  603. },
  604. "path": {
  605. "description": "The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.",
  606. "type": "string"
  607. },
  608. "request": {
  609. "description": "The schema for the request.",
  610. "properties": {
  611. "$ref": {
  612. "description": "Schema ID for the request schema.",
  613. "type": "string"
  614. },
  615. "parameterName": {
  616. "description": "parameter name.",
  617. "type": "string"
  618. }
  619. },
  620. "type": "object"
  621. },
  622. "response": {
  623. "description": "The schema for the response.",
  624. "properties": {
  625. "$ref": {
  626. "description": "Schema ID for the response schema.",
  627. "type": "string"
  628. }
  629. },
  630. "type": "object"
  631. },
  632. "scopes": {
  633. "description": "OAuth 2.0 scopes applicable to this method.",
  634. "items": {
  635. "type": "string"
  636. },
  637. "type": "array"
  638. },
  639. "supportsMediaDownload": {
  640. "description": "Whether this method supports media downloads.",
  641. "type": "boolean"
  642. },
  643. "supportsMediaUpload": {
  644. "description": "Whether this method supports media uploads.",
  645. "type": "boolean"
  646. },
  647. "supportsSubscription": {
  648. "description": "Whether this method supports subscriptions.",
  649. "type": "boolean"
  650. },
  651. "useMediaDownloadService": {
  652. "description": "Indicates that downloads from this method should use the download service URL (i.e. \"/download\"). Only applies if the method supports media download.",
  653. "type": "boolean"
  654. }
  655. },
  656. "type": "object"
  657. },
  658. "RestResource": {
  659. "id": "RestResource",
  660. "properties": {
  661. "methods": {
  662. "additionalProperties": {
  663. "$ref": "RestMethod",
  664. "description": "Description for any methods on this resource."
  665. },
  666. "description": "Methods on this resource.",
  667. "type": "object"
  668. },
  669. "resources": {
  670. "additionalProperties": {
  671. "$ref": "RestResource",
  672. "description": "Description for any sub-resources on this resource."
  673. },
  674. "description": "Sub-resources on this resource.",
  675. "type": "object"
  676. }
  677. },
  678. "type": "object"
  679. }
  680. },
  681. "servicePath": "discovery/v1/",
  682. "title": "APIs Discovery Service",
  683. "version": "v1"
  684. }