खोज से जुड़ा दस्तावेज़

ज़्यादातर एपीआई के कुछ वर्शन के लिए, जानकारी देने वाले दस्तावेज़ उपलब्ध होते हैं. हर एपीआई के जानकारी देने वाले दस्तावेज़ में, एपीआई के बारे में जानकारी दी जाती है. इसमें यह बताया जाता है कि एपीआई को कैसे ऐक्सेस किया जा सकता है और एपीआई के अनुरोध और जवाब किस तरह से स्ट्रक्चर किए जाते हैं. जानकारी देने वाले दस्तावेज़ में, एपीआई-लेवल की प्रॉपर्टी शामिल होती हैं. जैसे, एपीआई का ब्यौरा, संसाधन स्कीमा, पुष्टि करने के स्कोप, और तरीके.

तरीके

डिस्कवरी दस्तावेज़ में, एपीआई को शुरू करने के RESTful तरीके पर फ़ोकस किया जाता है.  discovery.apis.list मेथड, Google APIs Discovery Service के साथ काम करने वाले सभी एपीआई की सूची दिखाता है. इसमें REST पर आधारित खोज से जुड़े दस्तावेज़ों को वापस पाने के लिए यूआरएल भी शामिल होते हैं.

list
इस एंडपॉइंट पर काम करने वाले एपीआई की सूची पाएं.

संसाधन के बारे में जानकारी

{
  "kind": "discovery#restDescription",
  "discoveryVersion": "v1",
  "id": string,
  "name": string,
  "canonicalName": string,
  "version": string,
  "revision": string,
  "title": string,
  "description": string,
  "icons": {
    "x16": string,
    "x32": string
  },
  "documentationLink": string,
  "labels": [
    string
  ],
  "protocol": "rest",
  "baseUrl": string,
  "basePath": string,
  "rootUrl": string,
  "servicePath": string,
  "batchPath": "batch",
  "endpoints": [
    {
      "endpointUrl": string,
      "location": string,
      "deprecated": boolean,
      "description": string
    }
  ],
  "parameters": {
    (key): {
      "id": string,
      "type": string,
      "$ref": string,
      "description": string,
      "default": string,
      "required": boolean,
      "format": string,
      "pattern": string,
      "minimum": string,
      "maximum": string,
      "enum": [
        string
      ],
      "enumDescriptions": [
        string
      ],
      "repeated": boolean,
      "location": string,
      "properties": {
        (key): (JsonSchema)
      },
      "additionalProperties": (JsonSchema),
      "items": (JsonSchema),
      "annotations": {
        "required": [
          string
        ]
      }
    }
  },
  "auth": {
    "oauth2": {
      "scopes": {
        (key): {
          "description": string
        }
      }
    }
  },
  "features": [
    string
  ],
  "schemas": {
    (key): {
      "id": string,
      "type": string,
      "$ref": string,
      "description": string,
      "default": string,
      "required": boolean,
      "deprecated": boolean,
      "format": string,
      "pattern": string,
      "minimum": string,
      "maximum": string,
      "enum": [
        string
      ],
      "enumDescriptions": [
        string
      ],
      "enumDeprecated": [
        boolean
      ],
      "repeated": boolean,
      "location": string,
      "properties": {
        (key): (JsonSchema)
      },
      "additionalProperties": (JsonSchema),
      "items": (JsonSchema),
      "annotations": {
        "required": [
          string
        ]
      }
    }
  },
  "methods": {
    (key): {
      "id": string,
      "path": string,
      "httpMethod": string,
      "description": string,
      "deprecated": boolean,
      "parameters": {
        (key): {
          "id": string,
          "type": string,
          "$ref": string,
          "description": string,
          "default": string,
          "required": boolean,
          "deprecated": boolean,
          "format": string,
          "pattern": string,
          "minimum": string,
          "maximum": string,
          "enum": [
            string
          ],
          "enumDescriptions": [
            string
          ],
          "enumDeprecated": [
            boolean
          ],
          "repeated": boolean,
          "location": string,
          "properties": {
            (key): (JsonSchema)
          },
          "additionalProperties": (JsonSchema),
          "items": (JsonSchema),
          "annotations": {
            "required": [
              string
            ]
          }
        }
      },
      "parameterOrder": [
        string
      ],
      "request": {
        "$ref": string
      },
      "response": {
        "$ref": string
      },
      "scopes": [
        (value)
      ],
      "supportsMediaDownload": boolean,
      "supportsMediaUpload": boolean,
      "mediaUpload": {
        "accept": [
          string
        ],
        "maxSize": string,
        "protocols": {
          "simple": {
            "multipart": true,
            "path": string
          },
          "resumable": {
            "multipart": true,
            "path": string
          }
        }
      },
      "supportsSubscription": boolean
    }
  },
  "resources": {
    (key): {
      "methods": {
        (key): {
          "id": string,
          "path": string,
          "httpMethod": string,
          "description": string,
          "deprecated": boolean,
          "parameters": {
            (key): {
              "id": string,
              "type": string,
              "$ref": string,
              "description": string,
              "default": string,
              "required": boolean,
              "deprecated": boolean,
              "format": string,
              "pattern": string,
              "minimum": string,
              "maximum": string,
              "enum": [
                string
              ],
              "enumDescriptions": [
                string
              ],
              "enumDeprecated": [
                boolean
              ],
              "repeated": boolean,
              "location": string,
              "properties": {
                (key): (JsonSchema)
              },
              "additionalProperties": (JsonSchema),
              "items": (JsonSchema),
              "annotations": {
                "required": [
                  string
                ]
              }
            }
          },
          "parameterOrder": [
            string
          ],
          "request": {
            "$ref": string
          },
          "response": {
            "$ref": string
          },
          "scopes": [
            (value)
          ],
          "supportsMediaDownload": boolean,
          "supportsMediaUpload": boolean,
          "mediaUpload": {
            "accept": [
              string
            ],
            "maxSize": string,
            "protocols": {
              "simple": {
                "multipart": true,
                "path": string
              },
              "resumable": {
                "multipart": true,
                "path": string
              }
            }
          },
          "supportsSubscription": boolean
        }
      },
      "deprecated": boolean,
      "resources": {
        (key): (RestResource)
      }
    }
  }
}
प्रॉपर्टी का नाम मान ब्यौरा
kind string इस जवाब का टाइप. तय की गई स्ट्रिंग discovery#restDescription.
discoveryVersion string इस दस्तावेज़ को जनरेट करने के लिए, Discovery API के जिस वर्शन का इस्तेमाल किया गया है उसके बारे में बताएं.
id string एपीआई के लिए, खोज से जुड़े दस्तावेज़ का आईडी. उदाहरण के लिए, urlshortener:v1.
name string एपीआई का नाम. उदाहरण के लिए, urlshortener.
canonicalName string एपीआई का कैननिकल नाम. उदाहरण के लिए, Url Shortener.
version string एपीआई का वर्शन. उदाहरण के लिए, v1.
revision string एपीआई का वर्शन.
title string एपीआई का टाइटल. उदाहरण के लिए, "Google Url Shortener API".
description string इस एपीआई की जानकारी.
icons object एपीआई को दिखाने वाले 16x16 और 32x32 आइकॉन के लिंक.
icons.x16 string 16x16 आइकॉन का यूआरएल.
icons.x32 string 32x32 आइकॉन का यूआरएल.
labels[] list इस एपीआई की स्थिति के लिए लेबल. मान्य वैल्यू में limited_availability या deprecated शामिल हैं.
protocol string दस्तावेज़ में बताया गया प्रोटोकॉल. उदाहरण के लिए, REST.
rootUrl string यह रूट यूआरएल है, जिसके तहत सभी एपीआई सेवाएं काम करती हैं.
endpoints[] list इस एपीआई के लिए, जगह के हिसाब से एंडपॉइंट ऑब्जेक्ट की सूची. हर ऑब्जेक्ट में एंडपॉइंट यूआरएल, जगह, ब्यौरा, और बंद होने की स्थिति शामिल होती है.
endpoints[].endpointUrl string एंडपॉइंट टारगेट होस्ट का यूआरएल.
endpoints[].location string एंडपॉइंट की जगह.
endpoints[].description string यह स्ट्रिंग, यूआरएल से तय किए गए होस्ट के बारे में बताती है.
endpoints[].deprecated boolean यह एंडपॉइंट अब काम नहीं करता है या नहीं.
parameters object सामान्य पैरामीटर, जो सभी एपीआई पर लागू होते हैं.
parameters.(key) nested object किसी एक पैरामीटर की जानकारी.
parameters.(key).id string इस स्कीमा के लिए यूनीक आइडेंटिफ़ायर.
parameters.(key).type string इस स्कीमा के लिए वैल्यू का टाइप. वैल्यू की सूची, JSON स्कीमा के"type" सेक्शन में देखी जा सकती है.
parameters.(key).$ref string किसी दूसरे स्कीमा का रेफ़रंस. इस प्रॉपर्टी की वैल्यू, किसी दूसरे स्कीमा का आईडी होती है.
parameters.(key).description string इस ऑब्जेक्ट की जानकारी.
parameters.(key).default string इस प्रॉपर्टी की डिफ़ॉल्ट वैल्यू (अगर कोई मौजूद है).
parameters.(key).required boolean पैरामीटर ज़रूरी है या नहीं.
parameters.(key).format string एक अतिरिक्त रेगुलर एक्सप्रेशन या कुंजी, जो वैल्यू को सीमित करने में मदद करती है. ज़्यादा जानकारी के लिए, टाइप और फ़ॉर्मैट की खास जानकारी देखें.
parameters.(key).pattern string यह पैरामीटर, इस रेगुलर एक्सप्रेशन के मुताबिक होना चाहिए.
parameters.(key).minimum string इस पैरामीटर की कम से कम वैल्यू.
parameters.(key).maximum string इस पैरामीटर की ज़्यादा से ज़्यादा वैल्यू.
parameters.(key).enum[] list अगर यह एक enum है, तो इस पैरामीटर की वैल्यू.
parameters.(key).enumDescriptions[] list इनम के लिए जानकारी. हर पोज़िशन, enum ऐरे में मौजूद वैल्यू से मैप होती है.
parameters.(key).repeated boolean क्या यह पैरामीटर एक से ज़्यादा बार दिख सकता है.
parameters.(key).location string यह पैरामीटर, REST अनुरोधों के लिए क्वेरी या पाथ में जाता है या नहीं.
parameters.(key).properties object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो इस ऑब्जेक्ट की हर प्रॉपर्टी के लिए स्कीमा की सूची बनाएं.
parameters.(key).properties.(key) nested object इस ऑब्जेक्ट की एक प्रॉपर्टी. यह वैल्यू, JSON स्कीमा ऑब्जेक्ट है. इससे इस प्रॉपर्टी के बारे में पता चलता है.
parameters.(key).additionalProperties nested object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो यह प्रॉपर्टी इस ऑब्जेक्ट पर डाइनैमिक कुंजियों वाली किसी भी अतिरिक्त प्रॉपर्टी का स्कीमा है.
parameters.(key).items nested object अगर यह किसी ऐरे का स्कीमा है, तो यह प्रॉपर्टी ऐरे के हर एलिमेंट का स्कीमा होती है.
parameters.(key).annotations object इस प्रॉपर्टी के बारे में ज़्यादा जानकारी.
parameters.(key).annotations.required[] list उन तरीकों की सूची जिनके लिए अनुरोधों पर इस प्रॉपर्टी की ज़रूरत होती है.
auth object पुष्टि करने की जानकारी.
auth.oauth2 object OAuth 2.0 की पुष्टि करने की जानकारी.
auth.oauth2.scopes object OAuth 2.0 के उपलब्ध स्कोप.
auth.oauth2.scopes.(key) object स्कोप की वैल्यू.
auth.oauth2.scopes.(key).description string स्कोप के बारे में जानकारी.
features[] list इस एपीआई के साथ काम करने वाली सुविधाओं की सूची.
schemas object इस एपीआई के लिए स्कीमा.
schemas.(key) nested object किसी स्कीमा के बारे में जानकारी.
schemas.(key).id string इस स्कीमा के लिए यूनीक आइडेंटिफ़ायर. उदाहरण: URL
schemas.(key).type string इस स्कीमा के लिए वैल्यू का टाइप. वैल्यू की सूची, JSON स्कीमा के "type" सेक्शन में देखी जा सकती है.
schemas.(key).$ref string किसी दूसरे स्कीमा का रेफ़रंस. इस प्रॉपर्टी की वैल्यू, किसी दूसरे स्कीमा का आईडी होती है.
schemas.(key).description string इस ऑब्जेक्ट की जानकारी.
schemas.(key).default string इस प्रॉपर्टी की डिफ़ॉल्ट वैल्यू (अगर कोई मौजूद है).
schemas.(key).required boolean पैरामीटर ज़रूरी है या नहीं.
schemas.(key).deprecated boolean यह स्कीमा हटा दिया गया है या नहीं.
schemas.(key).format string एक अतिरिक्त रेगुलर एक्सप्रेशन या कुंजी, जो वैल्यू को सीमित करने में मदद करती है. ज़्यादा जानकारी के लिए, टाइप और फ़ॉर्मैट की खास जानकारी देखें.
schemas.(key).pattern string यह पैरामीटर, इस रेगुलर एक्सप्रेशन के मुताबिक होना चाहिए.
schemas.(key).minimum string इस पैरामीटर की कम से कम वैल्यू.
schemas.(key).maximum string इस पैरामीटर की ज़्यादा से ज़्यादा वैल्यू.
schemas.(key).enum[] list अगर यह एक enum है, तो इस पैरामीटर की वैल्यू.
schemas.(key).enumDescriptions[] list इनम के लिए जानकारी. हर पोज़िशन, enum कलेक्शन में मौजूद वैल्यू से मैप होती है.
schemas.(key).enumDeprecated[] list इनम के लिए, बंद होने की स्थिति. हर पोज़िशन, enum कलेक्शन में मौजूद वैल्यू से मैप होती है.
schemas.(key).repeated boolean क्या यह पैरामीटर एक से ज़्यादा बार दिख सकता है.
schemas.(key).location string यह पैरामीटर, REST अनुरोधों के लिए क्वेरी या पाथ में जाता है या नहीं.
schemas.(key).properties object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो इस ऑब्जेक्ट की हर प्रॉपर्टी के लिए स्कीमा की सूची बनाएं.
schemas.(key).properties.(key) nested object इस ऑब्जेक्ट की एक प्रॉपर्टी. यह वैल्यू, JSON स्कीमा ऑब्जेक्ट है. इससे इस प्रॉपर्टी के बारे में पता चलता है.
schemas.(key).additionalProperties nested object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो यह प्रॉपर्टी इस ऑब्जेक्ट पर डाइनैमिक कुंजियों वाली किसी भी अतिरिक्त प्रॉपर्टी का स्कीमा है.
schemas.(key).items nested object अगर यह किसी ऐरे का स्कीमा है, तो यह प्रॉपर्टी ऐरे के हर एलिमेंट का स्कीमा होती है.
schemas.(key).annotations object इस प्रॉपर्टी के बारे में ज़्यादा जानकारी.
schemas.(key).annotations.required[] list उन तरीकों की सूची जिनके लिए अनुरोधों पर इस प्रॉपर्टी की ज़रूरत होती है.
methods object इस एपीआई के लिए एपीआई-लेवल के तरीके.
methods.(key) nested object किसी एक तरीके के बारे में जानकारी.
methods.(key).id string इस तरीके के लिए यूनीक आईडी. इस प्रॉपर्टी का इस्तेमाल, डिस्कवरी के अलग-अलग वर्शन के बीच तरीकों को मैच करने के लिए किया जा सकता है.
methods.(key).description string इस तरीके के बारे में जानकारी.
methods.(key).deprecated boolean यह तरीका बंद कर दिया गया है या नहीं.
methods.(key).parameters object इस तरीके में मौजूद सभी पैरामीटर की जानकारी.
methods.(key).parameters.(key) nested object इस तरीके में मौजूद किसी एक पैरामीटर के बारे में जानकारी.
methods.(key).parameters.(key).id string इस स्कीमा के लिए यूनीक आइडेंटिफ़ायर.
methods.(key).parameters.(key).type string इस स्कीमा के लिए वैल्यू का टाइप.   वैल्यू की सूची, JSON स्कीमा में "type" सेक्शन में देखी जा सकती है.
methods.(key).parameters.(key).$ref string किसी दूसरे स्कीमा का रेफ़रंस. इस प्रॉपर्टी की वैल्यू, किसी दूसरे स्कीमा का आईडी होती है.
methods.(key).parameters.(key).description string इस ऑब्जेक्ट की जानकारी.
methods.(key).parameters.(key).default string इस प्रॉपर्टी की डिफ़ॉल्ट वैल्यू (अगर कोई मौजूद है).
methods.(key).parameters.(key).required boolean पैरामीटर ज़रूरी है या नहीं.
methods.(key).parameters.(key).deprecated boolean पैरामीटर का इस्तेमाल बंद कर दिया गया है या नहीं.
methods.(key).parameters.(key).format string एक अतिरिक्त रेगुलर एक्सप्रेशन या कुंजी, जो वैल्यू को सीमित करने में मदद करती है. ज़्यादा जानकारी के लिए, टाइप और फ़ॉर्मैट की खास जानकारी देखें.
methods.(key).parameters.(key).pattern string यह पैरामीटर, इस रेगुलर एक्सप्रेशन के मुताबिक होना चाहिए.
methods.(key).parameters.(key).minimum string इस पैरामीटर की कम से कम वैल्यू.
methods.(key).parameters.(key).maximum string इस पैरामीटर की ज़्यादा से ज़्यादा वैल्यू.
methods.(key).parameters.(key).enum[] list अगर यह एक enum है, तो इस पैरामीटर की वैल्यू.
methods.(key).parameters.(key).enumDescriptions[] list इनम के लिए जानकारी. हर पोज़िशन, enum कलेक्शन में मौजूद वैल्यू से मैप होती है.
methods.(key).parameters.(key).enumDeprecated[] list इनम के लिए, बंद होने की स्थिति. हर पोज़िशन, enum कलेक्शन में मौजूद वैल्यू से मैप होती है.
methods.(key).parameters.(key).repeated boolean क्या यह पैरामीटर एक से ज़्यादा बार दिख सकता है.
methods.(key).parameters.(key).location string यह पैरामीटर, REST अनुरोधों के लिए क्वेरी या पाथ में जाता है या नहीं.
methods.(key).parameters.(key).properties object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो इस ऑब्जेक्ट की हर प्रॉपर्टी के लिए स्कीमा की सूची बनाएं.
methods.(key).parameters.(key).properties.(key) nested object इस ऑब्जेक्ट की एक प्रॉपर्टी. यह वैल्यू, JSON स्कीमा ऑब्जेक्ट है. इससे इस प्रॉपर्टी के बारे में पता चलता है.
methods.(key).parameters.(key).additionalProperties nested object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो यह प्रॉपर्टी इस ऑब्जेक्ट पर डाइनैमिक कुंजियों वाली किसी भी अतिरिक्त प्रॉपर्टी का स्कीमा है.
methods.(key).parameters.(key).items nested object अगर यह किसी ऐरे का स्कीमा है, तो यह प्रॉपर्टी ऐरे के हर एलिमेंट का स्कीमा होती है.
methods.(key).parameters.(key).annotations object इस प्रॉपर्टी के बारे में ज़्यादा जानकारी.
methods.(key).parameters.(key).annotations.required[] list उन तरीकों की सूची जिनके लिए अनुरोधों में इस प्रॉपर्टी का इस्तेमाल करना ज़रूरी है.
methods.(key).parameterOrder[] list ज़रूरी पैरामीटर की क्रम से लगाई गई सूची. इससे क्लाइंट को यह जानकारी मिलती है कि वे अपने तरीके के सिग्नेचर कैसे बनाएं. ऐरे को इस तरह से क्रम में लगाया जाता है कि सबसे अहम पैरामीटर पहले दिखे.
methods.(key).scopes[] list इस तरीके पर लागू होने वाले OAuth 2.0 स्कोप.
methods.(key).supportsMediaDownload boolean इस तरीके से मीडिया डाउनलोड किया जा सकता है या नहीं.
methods.(key).supportsMediaUpload boolean क्या इस तरीके से मीडिया अपलोड किया जा सकता है.
methods.(key).mediaUpload object मीडिया अपलोड करने के पैरामीटर.
methods.(key).mediaUpload.accept[] list इस तरीके से मीडिया अपलोड करने के लिए, स्वीकार किए जाने वाले MIME मीडिया रेंज.
methods.(key).mediaUpload.maxSize string अपलोड किए जाने वाले मीडिया का ज़्यादा से ज़्यादा साइज़, जैसे कि "1MB", "2GB" या "3TB".
methods.(key).supportsSubscription boolean यह तरीका, सदस्यताएं लेने के लिए इस्तेमाल किया जा सकता है या नहीं.
baseUrl string [DEPRECATED] REST अनुरोधों के लिए बेस यूआरएल.
basePath string [DEPRECATED] REST अनुरोधों के लिए बेस पाथ.
servicePath string सभी REST अनुरोधों के लिए बेस पाथ.
batchPath string REST बैच अनुरोधों के लिए पाथ.
methods.(key).path string इस REST तरीके का यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर servicePath प्रॉपर्टी के साथ किया जाना चाहिए.
methods.(key).httpMethod string इस तरीके में इस्तेमाल किया गया एचटीटीपी मेथड.
methods.(key).request object अनुरोध का स्कीमा.
methods.(key).request.$ref string अनुरोध स्कीमा के लिए स्कीमा आईडी.
methods.(key).request.parameterName string [DEPRECATED] कुछ एपीआई में, पहले के वर्शन के साथ काम करने की सुविधा देने के लिए यह फ़ील्ड होता है. इसे अनदेखा किया जा सकता है.
methods.(key).response object जवाब का स्कीमा.
methods.(key).response.$ref string जवाब के स्कीमा का स्कीमा आईडी.
methods.(key).mediaUpload.protocols object अपलोड करने के लिए इस्तेमाल किए जा सकने वाले प्रोटोकॉल.
methods.(key).mediaUpload.protocols.simple object एक एचटीटीपी अनुरोध के तौर पर अपलोड करने की सुविधा देता है.
methods.(key).mediaUpload.protocols.simple.multipart boolean अगर यह एंडपॉइंट, मल्टीपार्ट मीडिया अपलोड करने की सुविधा के साथ काम करता है, तो यह वैल्यू सही होती है.
methods.(key).mediaUpload.protocols.simple.path string अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल, एपीआई लेवल पर rootURL प्रॉपर्टी के साथ किया जाना चाहिए.
methods.(key).mediaUpload.protocols.resumable object यह Resumable Media Upload प्रोटोकॉल के साथ काम करता है.
methods.(key).mediaUpload.protocols.resumable.multipart boolean true अगर यह एंडपॉइंट, मल्टीपार्ट मीडिया अपलोड करने की सुविधा के साथ काम करता है.
methods.(key).mediaUpload.protocols.resumable.path string अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर rootURL प्रॉपर्टी के साथ किया जाना चाहिए.
resources object इस एपीआई में मौजूद संसाधन.
resources.(key) nested object किसी संसाधन के बारे में जानकारी. इसमें इस संसाधन से जुड़े तरीके और उप-संसाधन शामिल होते हैं.
resources.(key).methods object इस संसाधन पर उपलब्ध तरीके.
resources.(key).methods.(key) nested object इस संसाधन पर मौजूद किसी भी तरीके के बारे में जानकारी.
resources.(key).methods.(key).id string इस तरीके के लिए यूनीक आईडी. इस प्रॉपर्टी का इस्तेमाल, डिस्कवरी के अलग-अलग वर्शन के बीच तरीकों को मैच करने के लिए किया जा सकता है.
resources.(key).methods.(key).path string इस REST तरीके का यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर servicePath प्रॉपर्टी के साथ किया जाना चाहिए.
resources.(key).methods.(key).flatPath string लेवल 2 की सुविधाओं ({+var}) के बिना, RFC 6570 फ़ॉर्मैट में इस REST तरीके का यूआरआई पाथ. path प्रॉपर्टी के साथ इस्तेमाल की जाती है.
resources.(key).methods.(key).httpMethod string इस तरीके में इस्तेमाल किया गया एचटीटीपी मेथड.
resources.(key).methods.(key).description string इस तरीके के बारे में जानकारी.
resources.(key).methods.(key).deprecated boolean यह तरीका बंद कर दिया गया है या नहीं.
resources.(key).methods.(key).parameters object इस तरीके में मौजूद सभी पैरामीटर की जानकारी.
resources.(key).methods.(key).parameters.(key) nested object इस तरीके में मौजूद किसी एक पैरामीटर के बारे में जानकारी.
resources.(key).methods.(key).parameters.(key).id string इस स्कीमा के लिए यूनीक आइडेंटिफ़ायर.
resources.(key).methods.(key).parameters.(key).type string इस स्कीमा के लिए वैल्यू का टाइप.  वैल्यू की सूची, JSON स्कीमा में "type" सेक्शन में देखी जा सकती है.
resources.(key).methods.(key).parameters.(key).$ref string किसी दूसरे स्कीमा का रेफ़रंस. इस प्रॉपर्टी की वैल्यू, किसी अन्य स्कीमा का "आईडी" होती है.
resources.(key).methods.(key).parameters.(key).description string इस ऑब्जेक्ट की जानकारी.
resources.(key).methods.(key).parameters.(key).default string इस प्रॉपर्टी की डिफ़ॉल्ट वैल्यू (अगर कोई मौजूद है).
resources.(key).methods.(key).parameters.(key).required boolean पैरामीटर ज़रूरी है या नहीं.
resources.(key).methods.(key).parameters.(key).deprecated boolean पैरामीटर का इस्तेमाल बंद कर दिया गया है या नहीं.
resources.(key).methods.(key).parameters.(key).format string एक अतिरिक्त रेगुलर एक्सप्रेशन या कुंजी, जो वैल्यू को सीमित करने में मदद करती है. ज़्यादा जानकारी के लिए, टाइप और फ़ॉर्मैट की खास जानकारी देखें.
resources.(key).methods.(key).parameters.(key).pattern string यह पैरामीटर, इस रेगुलर एक्सप्रेशन के मुताबिक होना चाहिए.
resources.(key).methods.(key).parameters.(key).minimum string इस पैरामीटर की कम से कम वैल्यू.
resources.(key).methods.(key).parameters.(key).maximum string इस पैरामीटर की ज़्यादा से ज़्यादा वैल्यू.
resources.(key).methods.(key).parameters.(key).enum[] list अगर यह एक enum है, तो इस पैरामीटर की वैल्यू.
resources.(key).methods.(key).parameters.(key).enumDescriptions[] list इनम के लिए जानकारी. हर पोज़िशन, enum कलेक्शन में मौजूद वैल्यू से मैप होती है.
resources.(key).methods.(key).parameters.(key).enumDeprecated[] list इनम के लिए, बंद होने की स्थिति. हर पोज़िशन, enum कलेक्शन में मौजूद वैल्यू से मैप होती है.
resources.(key).methods.(key).parameters.(key).repeated boolean क्या यह पैरामीटर एक से ज़्यादा बार दिख सकता है.
resources.(key).methods.(key).parameters.(key).location string यह पैरामीटर, REST अनुरोधों के लिए क्वेरी या पाथ में जाता है या नहीं.
resources.(key).methods.(key).parameters.(key).properties object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो इस ऑब्जेक्ट की हर प्रॉपर्टी के लिए स्कीमा की सूची बनाएं.
resources.(key).methods.(key).parameters.(key).properties.(key) nested object इस ऑब्जेक्ट की एक प्रॉपर्टी. यह वैल्यू, JSON स्कीमा ऑब्जेक्ट है. इससे इस प्रॉपर्टी के बारे में पता चलता है.
resources.(key).methods.(key).parameters.(key).additionalProperties nested object अगर यह किसी ऑब्जेक्ट का स्कीमा है, तो यह प्रॉपर्टी इस ऑब्जेक्ट पर डाइनैमिक कुंजियों वाली किसी भी अतिरिक्त प्रॉपर्टी का स्कीमा है.
resources.(key).methods.(key).parameters.(key).items nested object अगर यह किसी ऐरे का स्कीमा है, तो यह प्रॉपर्टी ऐरे के हर एलिमेंट का स्कीमा होती है.
resources.(key).methods.(key).parameters.(key).annotations object इस प्रॉपर्टी के बारे में ज़्यादा जानकारी.
resources.(key).methods.(key).parameters.(key).annotations.required[] list उन तरीकों की सूची जिनके लिए अनुरोधों पर इस प्रॉपर्टी की ज़रूरत होती है.
resources.(key).methods.(key).parameterOrder[] list ज़रूरी पैरामीटर की क्रम से लगाई गई सूची. इससे क्लाइंट को यह जानकारी मिलती है कि वे अपने तरीके के सिग्नेचर कैसे बनाएं. ऐरे को इस तरह से क्रम में लगाया जाता है कि सबसे अहम पैरामीटर पहले दिखे.
resources.(key).methods.(key).request object अनुरोध का स्कीमा.
resources.(key).methods.(key).request.$ref string अनुरोध स्कीमा के लिए स्कीमा आईडी.
resources.(key).methods.(key).response object जवाब का स्कीमा.
resources.(key).methods.(key).response.$ref string जवाब के स्कीमा का स्कीमा आईडी.
resources.(key).methods.(key).scopes[] list इस तरीके पर लागू होने वाले OAuth 2.0 स्कोप.
resources.(key).methods.(key).supportsMediaDownload boolean इस तरीके से मीडिया डाउनलोड किया जा सकता है या नहीं.
resources.(key).methods.(key).supportsMediaUpload boolean क्या इस तरीके से मीडिया अपलोड किया जा सकता है.
resources.(key).methods.(key).mediaUpload object मीडिया अपलोड करने के पैरामीटर.
resources.(key).methods.(key).mediaUpload.accept[] list इस तरीके से मीडिया अपलोड करने के लिए, स्वीकार किए जाने वाले MIME मीडिया रेंज.
resources.(key).methods.(key).mediaUpload.maxSize string अपलोड किए जाने वाले मीडिया का ज़्यादा से ज़्यादा साइज़, जैसे कि "1MB", "2GB" या "3TB".
resources.(key).methods.(key).mediaUpload.protocols object अपलोड करने के लिए इस्तेमाल किए जा सकने वाले प्रोटोकॉल.
resources.(key).methods.(key).mediaUpload.protocols.simple object एक एचटीटीपी अनुरोध के तौर पर अपलोड करने की सुविधा देता है.
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart boolean true अगर यह एंडपॉइंट, मल्टीपार्ट मीडिया अपलोड करने की सुविधा के साथ काम करता है.
resources.(key).methods.(key).mediaUpload.protocols.simple.path string अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर rootURL प्रॉपर्टी के साथ किया जाना चाहिए.
resources.(key).methods.(key).mediaUpload.protocols.resumable object यह Resumable Media Upload प्रोटोकॉल के साथ काम करता है.
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart boolean true अगर यह एंडपॉइंट, मल्टीपार्ट मीडिया अपलोड करने की सुविधा के साथ काम करता है.
resources.(key).methods.(key).mediaUpload.protocols.resumable.path string अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर rootURL प्रॉपर्टी के साथ किया जाना चाहिए.
resources.(key).methods.(key).supportsSubscription boolean यह तरीका, सदस्यताएं लेने के लिए इस्तेमाल किया जा सकता है या नहीं.
resources.(key).deprecated boolean यह संसाधन अब काम नहीं करता है या नहीं.
resources.(key).resources object इस संसाधन पर मौजूद उप-संसाधन.
resources.(key).resources.(key) nested object इस संसाधन पर मौजूद किसी भी उप-संसाधन के बारे में जानकारी.