আবিষ্কার নথি

বেশিরভাগ API-এর নির্দিষ্ট সংস্করণের জন্য আবিষ্কারের নথি পাওয়া যায়। প্রতিটি API এর ডিসকভারি ডকুমেন্ট API এর সারফেস বর্ণনা করে, কিভাবে API অ্যাক্সেস করতে হয় এবং কিভাবে API অনুরোধ এবং প্রতিক্রিয়াগুলি গঠন করা হয়। আবিষ্কার নথি দ্বারা প্রদত্ত তথ্যে API-স্তরের বৈশিষ্ট্যগুলি অন্তর্ভুক্ত থাকে যেমন একটি API বিবরণ, সংস্থান স্কিমা, প্রমাণীকরণের সুযোগ এবং পদ্ধতি।

পদ্ধতি

ডিসকভারি ডকুমেন্ট একটি এপিআই চালু করার RESTful পদ্ধতির উপর ফোকাস করে। Discovery.apis.list পদ্ধতিটি REST-ভিত্তিক আবিষ্কার নথিগুলি পুনরুদ্ধার করার জন্য url সহ Google APIs আবিষ্কার পরিষেবা দ্বারা সমর্থিত সমস্ত APIগুলির তালিকা প্রদান করে৷

তালিকা
এই এন্ডপয়েন্টে সমর্থিত API-এর তালিকা পুনরুদ্ধার করুন।

সম্পদ প্রতিনিধিত্ব

{
  "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 API-এর জন্য আবিষ্কার নথির ID। উদাহরণস্বরূপ, urlshortener:v1 ।
name string API এর নাম। উদাহরণস্বরূপ, urlshortener ।
canonicalName string API-এর ক্যানোনিকাল নাম। উদাহরণস্বরূপ, Url Shortener ।
version string API এর সংস্করণ। উদাহরণস্বরূপ, v1 ।
revision string API এর সংশোধন।
title string API এর শিরোনাম। যেমন, "Google Url Shortener API"।
description string এই API এর বর্ণনা।
icons object API প্রতিনিধিত্বকারী 16x16 এবং 32x32 আইকনের লিঙ্ক।
icons. x16 string 16x16 আইকনের URL।
icons. x32 string 32x32 আইকনের URL।
labels[] list এই API-এর স্থিতির জন্য লেবেল। বৈধ মান limited_availability বা deprecated অন্তর্ভুক্ত।
protocol string নথি দ্বারা বর্ণিত প্রোটোকল. উদাহরণস্বরূপ, REST।
rootUrl string রুট ইউআরএল যার অধীনে সমস্ত API পরিষেবা থাকে৷
endpoints[] list এই API-এর জন্য অবস্থান-ভিত্তিক এন্ডপয়েন্ট অবজেক্টের একটি তালিকা। প্রতিটি বস্তুর এন্ডপয়েন্ট URL, অবস্থান, বর্ণনা এবং অবচয় অবস্থা রয়েছে।
endpoints[]. endpointUrl string এন্ডপয়েন্ট টার্গেট হোস্টের URL।
endpoints[]. location string শেষ বিন্দুর অবস্থান।
endpoints[]. description string URL দ্বারা মনোনীত হোস্টের বর্ণনাকারী একটি স্ট্রিং৷
endpoints[]. deprecated boolean এই এন্ডপয়েন্টটি অবহেলিত কিনা।
parameters object সাধারণ পরামিতি যা সমস্ত apis জুড়ে প্রযোজ্য।
parameters. (key) nested object একটি একক প্যারামিটারের বর্ণনা।
parameters.(key). id string এই স্কিমার জন্য অনন্য শনাক্তকারী।
parameters.(key). type string এই স্কিমার মান প্রকার। মানগুলির একটি তালিকা JSON স্কিমার "টাইপ" বিভাগে পাওয়া যাবে।
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 enums জন্য বর্ণনা. প্রতিটি অবস্থান 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 এই API এর জন্য সমর্থিত বৈশিষ্ট্যগুলির একটি তালিকা৷
schemas object এই API-এর স্কিমা।
schemas. (key) nested object একটি পৃথক স্কিমার বিবরণ।
schemas.(key). id string এই স্কিমার জন্য অনন্য শনাক্তকারী। উদাহরণ: URL
schemas.(key). type string এই স্কিমার মান প্রকার। মানগুলির একটি তালিকা JSON স্কিমার "টাইপ" বিভাগে পাওয়া যাবে ।
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 enums জন্য বর্ণনা. প্রতিটি অবস্থান enum অ্যারে সংশ্লিষ্ট মান মানচিত্র.
schemas.(key). enumDeprecated[] list enums জন্য অবচয় অবস্থা. প্রতিটি অবস্থান 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 এই API-এর জন্য API-স্তরের পদ্ধতি।
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 স্কিমার "টাইপ" বিভাগে পাওয়া যাবে ।
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 enums জন্য বর্ণনা. প্রতিটি অবস্থান enum অ্যারে সংশ্লিষ্ট মান মানচিত্র.
methods.(key).parameters.(key). enumDeprecated[] list enums জন্য অবচয় অবস্থা. প্রতিটি অবস্থান 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 [অপ্রচলিত] REST অনুরোধের ভিত্তি URL।
basePath string [অপ্রচলিত] REST অনুরোধের ভিত্তি পথ।
servicePath string সমস্ত REST অনুরোধের জন্য ভিত্তি পথ।
batchPath string REST ব্যাচের অনুরোধের পথ।
methods.(key). path string এই REST পদ্ধতির URI পাথ। API-স্তরে servicePath সম্পত্তির সাথে একত্রে ব্যবহার করা উচিত।
methods.(key). httpMethod string HTTP পদ্ধতি এই পদ্ধতি দ্বারা ব্যবহৃত.
methods.(key). request object অনুরোধের স্কিমা।
methods.(key).request. $ref string অনুরোধ স্কিমার জন্য স্কিমা আইডি।
methods.(key).request. parameterName string [অপ্রচলিত] কিছু API-এর পশ্চাদগামী-সামঞ্জস্যতার কারণে এই ক্ষেত্রটি রয়েছে৷ এটা নিরাপদে উপেক্ষা করা যেতে পারে.
methods.(key). response object প্রতিক্রিয়া জন্য স্কিমা.
methods.(key).response. $ref string প্রতিক্রিয়া স্কিমার জন্য স্কিমা আইডি।
methods.(key).mediaUpload. protocols object সমর্থিত আপলোড প্রোটোকল.
methods.(key).mediaUpload.protocols. simple object একটি একক HTTP অনুরোধ হিসাবে আপলোড সমর্থন করে।
methods.(key).mediaUpload.protocols.simple. multipart boolean সত্য যদি এই এন্ডপয়েন্ট মাল্টিপার্ট মিডিয়া আপলোড সমর্থন করে।
methods.(key).mediaUpload.protocols.simple. path string আপলোডের জন্য ইউআরআই পাথ ব্যবহার করা হবে। এপিআই-লেভেলে rootURL প্রপার্টির সাথে একত্রে ব্যবহার করা উচিত।
methods.(key).mediaUpload.protocols. resumable object রিজুমেবল মিডিয়া আপলোড প্রোটোকল সমর্থন করে।
methods.(key).mediaUpload.protocols.resumable. multipart boolean true যদি এই এন্ডপয়েন্ট মাল্টিপার্ট মিডিয়া আপলোড সমর্থন করে।
methods.(key).mediaUpload.protocols.resumable. path string আপলোডের জন্য ইউআরআই পাথ ব্যবহার করা হবে। API-স্তরে rootURL বৈশিষ্ট্যের সাথে একত্রে ব্যবহার করা উচিত।
resources object এই API এর মধ্যে সম্পদ.
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 পদ্ধতির URI পাথ। API-স্তরে servicePath সম্পত্তির সাথে একত্রে ব্যবহার করা উচিত।
resources.(key).methods.(key). flatPath string লেভেল 2 বৈশিষ্ট্য ({+var}) ছাড়াই (RFC 6570) বিন্যাসে এই REST পদ্ধতির URI পাথ। path সম্পত্তি সম্পূরক.
resources.(key).methods.(key). httpMethod string HTTP পদ্ধতি এই পদ্ধতি দ্বারা ব্যবহৃত.
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 স্কিমার "টাইপ" বিভাগে পাওয়া যাবে ।
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 enums জন্য বর্ণনা. প্রতিটি অবস্থান enum অ্যারে সংশ্লিষ্ট মান মানচিত্র.
resources.(key).methods.(key).parameters.(key). enumDeprecated[] list enums জন্য অবচয় অবস্থা. প্রতিটি অবস্থান 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 একটি একক HTTP অনুরোধ হিসাবে আপলোড সমর্থন করে।
resources.(key).methods.(key).mediaUpload.protocols.simple. multipart boolean true যদি এই এন্ডপয়েন্ট মাল্টিপার্ট মিডিয়া আপলোড সমর্থন করে।
resources.(key).methods.(key).mediaUpload.protocols.simple. path string আপলোডের জন্য ইউআরআই পাথ ব্যবহার করা হবে। API-স্তরে rootURL বৈশিষ্ট্যের সাথে একত্রে ব্যবহার করা উচিত।
resources.(key).methods.(key).mediaUpload.protocols. resumable object রিজুমেবল মিডিয়া আপলোড প্রোটোকল সমর্থন করে।
resources.(key).methods.(key).mediaUpload.protocols.resumable. multipart boolean true যদি এই এন্ডপয়েন্ট মাল্টিপার্ট মিডিয়া আপলোড সমর্থন করে।
resources.(key).methods.(key).mediaUpload.protocols.resumable. path string আপলোডের জন্য ইউআরআই পাথ ব্যবহার করা হবে। API-স্তরে rootURL বৈশিষ্ট্যের সাথে একত্রে ব্যবহার করা উচিত।
resources.(key).methods.(key). supportsSubscription boolean এই পদ্ধতিটি সদস্যতা সমর্থন করে কিনা।
resources.(key). deprecated boolean এই সম্পদটি অবমূল্যায়ন করা হয়েছে কিনা।
resources.(key). resources object এই সম্পদের উপর উপ-সম্পদ।
resources.(key).resources. (key) nested object এই সম্পদের যেকোন সাব-রিসোর্সের জন্য বর্ণনা।