Methoden
Das Discovery-Dokument konzentriert sich auf die RESTful-Methode zum Aufrufen einer API. Die Methode discovery.apis.list gibt eine Liste aller APIs zurück, die vom Google APIs Discovery Service unterstützt werden, einschließlich der URLs zum Abrufen der REST-basierten Discovery-Dokumente.
- list
- Rufen Sie die Liste der APIs ab, die an diesem Endpunkt unterstützt werden.
Ressourcendarstellungen
{ "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) } } } }
Eigenschaftsname | Wert | Beschreibung | Hinweise |
---|---|---|---|
kind |
string |
Der Typ für diese Antwort.Der feste String discovery#restDescription |
|
discoveryVersion |
string |
Geben Sie die Version der Discovery API an, die zum Generieren dieses Dokuments verwendet wurde. | |
id |
string |
Die ID des Discovery-Dokuments für die API. Beispiel: urlshortener:v1 |
|
name |
string |
Der Name der API. Beispiel: urlshortener . |
|
canonicalName |
string |
Der kanonische Name der API. Beispiel: Url Shortener . |
|
version |
string |
Die Version der API. Beispiel: v1 |
|
revision |
string |
Die Überarbeitung der API. | |
title |
string |
Der Titel der API. Beispiel: „Google Url Shortener API“. | |
description |
string |
Die Beschreibung dieser API. | |
icons |
object |
Links zu 16 x 16- und 32 x 32-Symbolen, die die API repräsentieren. | |
icons.x16 |
string |
Die URL des 16 x 16-Symbols. | |
icons.x32 |
string |
Die URL des 32x32-Symbols. | |
documentationLink |
string |
Ein Link zur menschenlesbaren Dokumentation für die API. | |
labels[] |
list |
Labels für den Status dieser API. Gültige Werte sind limited_availability und deprecated . |
|
protocol |
string |
Das im Dokument beschriebene Protokoll. Zum Beispiel REST. | |
rootUrl |
string |
Die Stamm-URL, unter der sich alle API-Dienste befinden. | |
endpoints[] |
list |
Eine Liste mit standortbasierten Endpunktobjekten für diese API. Jedes Objekt enthält die Endpunkt-URL, den Standort, eine Beschreibung und einen Status. | |
endpoints[].endpointUrl |
string |
Die URL des Zielhosts des Endpunkts. | |
endpoints[].location |
string |
Der Standort des Endpunkts. | |
endpoints[].description |
string |
Ein String, der den durch die URL festgelegten Host beschreibt. | |
endpoints[].deprecated |
boolean |
Gibt an, ob dieser Endpunkt verworfen wurde. | |
parameters |
object |
Allgemeine Parameter, die für alle APIs gelten. | |
parameters.(key) |
nested object |
Beschreibung eines einzelnen Parameters. | |
parameters.(key).id |
string |
Eindeutige Kennung für dieses Schema. | |
parameters.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im Abschnitt „Typ“ im JSON-Schema. | |
parameters.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieser Eigenschaft ist die ID eines anderen Schemas. | |
parameters.(key).description |
string |
Eine Beschreibung dieses Objekts. | |
parameters.(key).default |
string |
Der Standardwert dieser Property, sofern vorhanden. | |
parameters.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. | |
parameters.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel, der dabei hilft, den Wert einzuschränken. Weitere Informationen finden Sie unter Typ und Formatzusammenfassung. | |
parameters.(key).pattern |
string |
Der reguläre Ausdruck, mit dem dieser Parameter übereinstimmen muss. | |
parameters.(key).minimum |
string |
Der Mindestwert dieses Parameters. | |
parameters.(key).maximum |
string |
Der Höchstwert dieses Parameters. | |
parameters.(key).enum[] |
list |
Werte, die dieser Parameter annehmen kann (wenn es sich um eine Aufzählung handelt). | |
parameters.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Aufzählungen. Jede Position wird dem entsprechenden Wert im Enum-Array zugeordnet. | |
parameters.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals angezeigt werden kann. | |
parameters.(key).location |
string |
Gibt an, ob dieser Parameter in der Abfrage oder im Pfad für REST-Anfragen enthalten ist. | |
parameters.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, geben Sie das Schema für jede Eigenschaft dieses Objekts an. | |
parameters.(key).properties.(key) |
nested object |
Eine einzelne Property dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das diese Eigenschaft beschreibt. | |
parameters.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist diese Eigenschaft das Schema für alle zusätzlichen Properties mit dynamischen Schlüsseln in diesem Objekt. | |
parameters.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist diese Eigenschaft das Schema für jedes Element im Array. | |
parameters.(key).annotations |
object |
Weitere Informationen zu dieser Unterkunft. | |
parameters.(key).annotations.required[] |
list |
Eine Liste der Methoden, die diese Property bei Anfragen benötigen. | |
auth |
object |
Authentifizierungsinformationen | |
auth.oauth2 |
object |
Informationen zur OAuth 2.0-Authentifizierung | |
auth.oauth2.scopes |
object |
Verfügbare OAuth 2.0-Umfänge. | |
auth.oauth2.scopes.(key) |
object |
Umfangswert | |
auth.oauth2.scopes.(key).description |
string |
Beschreibung des Geltungsbereichs. | |
features[] |
list |
Eine Liste der unterstützten Funktionen für diese API. | |
schemas |
object |
Die Schemas für diese API. | |
schemas.(key) |
nested object |
Eine individuelle Schemabeschreibung. | |
schemas.(key).id |
string |
Eindeutige Kennung für dieses Schema. Beispiel: URL |
|
schemas.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im Abschnitt „Typ“ im JSON-Schema. | |
schemas.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieser Eigenschaft ist die ID eines anderen Schemas. | |
schemas.(key).description |
string |
Eine Beschreibung dieses Objekts. | |
schemas.(key).default |
string |
Der Standardwert dieser Property, sofern vorhanden. | |
schemas.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. | |
schemas.(key).deprecated |
boolean |
Gibt an, ob dieses Schema verworfen wurde. | |
schemas.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel, der dabei hilft, den Wert einzuschränken.Weitere Informationen finden Sie unter Zusammenfassung der Typen und Formate. | |
schemas.(key).pattern |
string |
Der reguläre Ausdruck, mit dem dieser Parameter übereinstimmen muss. | |
schemas.(key).minimum |
string |
Der Mindestwert dieses Parameters. | |
schemas.(key).maximum |
string |
Der Höchstwert dieses Parameters. | |
schemas.(key).enum[] |
list |
Werte, die dieser Parameter annehmen kann (wenn es sich um eine Aufzählung handelt). | |
schemas.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Aufzählungen. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet. |
|
schemas.(key).enumDeprecated[] |
list |
Der Einstellungsstatus der Enums. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet. |
|
schemas.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals angezeigt werden kann. | |
schemas.(key).location |
string |
Gibt an, ob dieser Parameter in der Abfrage oder im Pfad für REST-Anfragen enthalten ist. | |
schemas.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, geben Sie das Schema für jede Eigenschaft dieses Objekts an. | |
schemas.(key).properties.(key) |
nested object |
Eine einzelne Property dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das diese Eigenschaft beschreibt. | |
schemas.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist diese Eigenschaft das Schema für alle zusätzlichen Properties mit dynamischen Schlüsseln in diesem Objekt. | |
schemas.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist diese Eigenschaft das Schema für jedes Element im Array. | |
schemas.(key).annotations |
object |
Weitere Informationen zu dieser Unterkunft. | |
schemas.(key).annotations.required[] |
list |
Eine Liste der Methoden, die diese Property bei Anfragen benötigen. | |
methods |
object |
Methoden auf API-Ebene für diese API. | |
methods.(key) |
nested object |
Eine einzelne Methodenbeschreibung. | |
methods.(key).id |
string |
Eine eindeutige ID für diese Methode. Diese Property kann zum Abgleich von Methoden verschiedener Discovery-Versionen verwendet werden. | |
methods.(key).description |
string |
Beschreibung dieser Methode. | |
methods.(key).deprecated |
boolean |
Gibt an, ob diese Methode verworfen wurde. | |
methods.(key).parameters |
object |
Details zu allen Parametern in dieser Methode. | |
methods.(key).parameters.(key) |
nested object |
Details zu einem einzelnen Parameter in dieser Methode. | |
methods.(key).parameters.(key).id |
string |
Eindeutige Kennung für dieses Schema. | |
methods.(key).parameters.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im Abschnitt „Typ“ im JSON-Schema. | |
methods.(key).parameters.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieser Eigenschaft ist die ID eines anderen Schemas. | |
methods.(key).parameters.(key).description |
string |
Eine Beschreibung dieses Objekts. | |
methods.(key).parameters.(key).default |
string |
Der Standardwert dieser Property, sofern vorhanden. | |
methods.(key).parameters.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. | |
methods.(key).parameters.(key).deprecated |
boolean |
Gibt an, ob der Parameter verworfen wurde. | |
methods.(key).parameters.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel, der dabei hilft, den Wert einzuschränken.Weitere Informationen finden Sie unter Zusammenfassung der Typen und Formate. | |
methods.(key).parameters.(key).pattern |
string |
Der reguläre Ausdruck, mit dem dieser Parameter übereinstimmen muss. | |
methods.(key).parameters.(key).minimum |
string |
Der Mindestwert dieses Parameters. | |
methods.(key).parameters.(key).maximum |
string |
Der Höchstwert dieses Parameters. | |
methods.(key).parameters.(key).enum[] |
list |
Werte, die dieser Parameter annehmen kann (wenn es sich um eine Aufzählung handelt). | |
methods.(key).parameters.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Aufzählungen. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet. |
|
methods.(key).parameters.(key).enumDeprecated[] |
list |
Der Einstellungsstatus der Enums. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet. |
|
methods.(key).parameters.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals angezeigt werden kann. | |
methods.(key).parameters.(key).location |
string |
Gibt an, ob dieser Parameter in der Abfrage oder im Pfad für REST-Anfragen enthalten ist. | |
methods.(key).parameters.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, geben Sie das Schema für jede Eigenschaft dieses Objekts an. | |
methods.(key).parameters.(key).properties.(key) |
nested object |
Eine einzelne Property dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das diese Eigenschaft beschreibt. | |
methods.(key).parameters.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist diese Eigenschaft das Schema für alle zusätzlichen Properties mit dynamischen Schlüsseln in diesem Objekt. | |
methods.(key).parameters.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist diese Eigenschaft das Schema für jedes Element im Array. | |
methods.(key).parameters.(key).annotations |
object |
Weitere Informationen zu dieser Unterkunft. | |
methods.(key).parameters.(key).annotations.required[] |
list |
Eine Liste der Methoden, für die diese Property bei Anfragen erforderlich ist. | |
methods.(key).parameterOrder[] |
list |
Liste der erforderlichen Parameter. Dies ist ein Hinweis für Kunden, wie sie ihre Methodensignaturen strukturieren. Das Array ist so sortiert, dass der wichtigste Parameter zuerst erscheint. | |
methods.(key).scopes[] |
list |
Auf diese Methode anwendbare OAuth 2.0-Umfänge. | |
methods.(key).supportsMediaDownload |
boolean |
Gibt an, ob diese Methode Mediendownloads unterstützt. | |
methods.(key).supportsMediaUpload |
boolean |
Gibt an, ob diese Methode Medienuploads unterstützt. | |
methods.(key).mediaUpload |
object |
Parameter für den Medien-Upload. | |
methods.(key).mediaUpload.accept[] |
list |
MIME-Medienbereiche für zulässige Medienuploads zu dieser Methode. | |
methods.(key).mediaUpload.maxSize |
string |
Maximale Größe für einen Medienupload, z. B. „1 MB“, „2 GB“ oder „3 TB“. | |
methods.(key).supportsSubscription |
boolean |
Gibt an, ob diese Methode Abos unterstützt. | |
baseUrl |
string |
[VERWORFEN] Die Basis-URL für REST-Anfragen. | |
basePath |
string |
[VERWORFEN] Der Basispfad für REST-Anfragen. | |
servicePath |
string |
Der Basispfad für alle REST-Anfragen. | |
batchPath |
string |
Der Pfad für REST-Batchanfragen. | |
methods.(key).path |
string |
Der URI-Pfad dieser REST-Methode. Sollte in Verbindung mit dem Attribut servicePath auf API-Ebene verwendet werden. |
|
methods.(key).httpMethod |
string |
Die von dieser Methode verwendete HTTP-Methode. | |
methods.(key).request |
object |
Das Schema für die Anfrage. | |
methods.(key).request.$ref |
string |
Schema-ID für das Anfrageschema. | |
methods.(key).request.parameterName |
string |
[VERWORFEN] Einige APIs haben aus Gründen der Abwärtskompatibilität dieses Feld. Er kann ignoriert werden. | |
methods.(key).response |
object |
Das Schema für die Antwort. | |
methods.(key).response.$ref |
string |
Schema-ID für das Antwortschema. | |
methods.(key).mediaUpload.protocols |
object |
Unterstützte Upload-Protokolle | |
methods.(key).mediaUpload.protocols.simple |
object |
Unterstützt das Hochladen als einzelne HTTP-Anfrage. | |
methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
True, wenn dieser Endpunkt mehrteilige Medien für den Upload unterstützt. | |
methods.(key).mediaUpload.protocols.simple.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf API-Ebene verwendet werden. |
|
methods.(key).mediaUpload.protocols.resumable |
object |
Unterstützt das Protokoll für fortsetzbare Medienuploads. | |
methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true , wenn dieser Endpunkt das Hochladen von mehrteiligen Medien unterstützt. |
|
methods.(key).mediaUpload.protocols.resumable.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf API-Ebene verwendet werden. |
|
resources |
object |
Die Ressourcen in dieser API. | |
resources.(key) |
nested object |
Eine individuelle Ressourcenbeschreibung. Enthält Methoden und untergeordnete Ressourcen im Zusammenhang mit dieser Ressource. | |
resources.(key).methods |
object |
Methoden für diese Ressource. | |
resources.(key).methods.(key) |
nested object |
Beschreibung für alle Methoden in dieser Ressource. | |
resources.(key).methods.(key).id |
string |
Eine eindeutige ID für diese Methode. Diese Property kann zum Abgleich von Methoden verschiedener Discovery-Versionen verwendet werden. | |
resources.(key).methods.(key).path |
string |
Der URI-Pfad dieser REST-Methode. Sollte in Verbindung mit dem Attribut servicePath auf API-Ebene verwendet werden. |
|
resources.(key).methods.(key).flatPath |
string |
Der URI-Pfad dieser REST-Methode im (RFC 6570)-Format ohne Funktionen der Ebene 2 ({+var}). Ergänzt die Property path . |
|
resources.(key).methods.(key).httpMethod |
string |
Die von dieser Methode verwendete HTTP-Methode. | |
resources.(key).methods.(key).description |
string |
Beschreibung dieser Methode. | |
resources.(key).methods.(key).deprecated |
boolean |
Gibt an, ob diese Methode verworfen wurde. | |
resources.(key).methods.(key).parameters |
object |
Details zu allen Parametern in dieser Methode. | |
resources.(key).methods.(key).parameters.(key) |
nested object |
Details zu einem einzelnen Parameter in dieser Methode. | |
resources.(key).methods.(key).parameters.(key).id |
string |
Eindeutige Kennung für dieses Schema. | |
resources.(key).methods.(key).parameters.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im Abschnitt „Typ“ im JSON-Schema. | |
resources.(key).methods.(key).parameters.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieser Eigenschaft ist die „ID“ eines anderen Schemas. | |
resources.(key).methods.(key).parameters.(key).description |
string |
Eine Beschreibung dieses Objekts. | |
resources.(key).methods.(key).parameters.(key).default |
string |
Der Standardwert dieser Property, sofern vorhanden. | |
resources.(key).methods.(key).parameters.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. | |
resources.(key).methods.(key).parameters.(key).deprecated |
boolean |
Gibt an, ob der Parameter verworfen wurde. | |
resources.(key).methods.(key).parameters.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel, der dabei hilft, den Wert einzuschränken.Weitere Informationen finden Sie unter Zusammenfassung der Typen und Formate. | |
resources.(key).methods.(key).parameters.(key).pattern |
string |
Der reguläre Ausdruck, mit dem dieser Parameter übereinstimmen muss. | |
resources.(key).methods.(key).parameters.(key).minimum |
string |
Der Mindestwert dieses Parameters. | |
resources.(key).methods.(key).parameters.(key).maximum |
string |
Der Höchstwert dieses Parameters. | |
resources.(key).methods.(key).parameters.(key).enum[] |
list |
Werte, die dieser Parameter annehmen kann (wenn es sich um eine Aufzählung handelt). | |
resources.(key).methods.(key).parameters.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Aufzählungen. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet. |
|
resources.(key).methods.(key).parameters.(key).enumDeprecated[] |
list |
Der Einstellungsstatus der Enums. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet. |
|
resources.(key).methods.(key).parameters.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals angezeigt werden kann. | |
resources.(key).methods.(key).parameters.(key).location |
string |
Gibt an, ob dieser Parameter in der Abfrage oder im Pfad für REST-Anfragen enthalten ist. | |
resources.(key).methods.(key).parameters.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, geben Sie das Schema für jede Eigenschaft dieses Objekts an. | |
resources.(key).methods.(key).parameters.(key).properties.(key) |
nested object |
Eine einzelne Property dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das diese Eigenschaft beschreibt. | |
resources.(key).methods.(key).parameters.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist diese Eigenschaft das Schema für alle zusätzlichen Properties mit dynamischen Schlüsseln in diesem Objekt. | |
resources.(key).methods.(key).parameters.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist diese Eigenschaft das Schema für jedes Element im Array. | |
resources.(key).methods.(key).parameters.(key).annotations |
object |
Weitere Informationen zu dieser Unterkunft. | |
resources.(key).methods.(key).parameters.(key).annotations.required[] |
list |
Eine Liste der Methoden, die diese Property bei Anfragen benötigen. | |
resources.(key).methods.(key).parameterOrder[] |
list |
Liste der erforderlichen Parameter. Dies ist ein Hinweis für Kunden, wie sie ihre Methodensignaturen strukturieren. Das Array ist so sortiert, dass der wichtigste Parameter zuerst erscheint. | |
resources.(key).methods.(key).request |
object |
Das Schema für die Anfrage. | |
resources.(key).methods.(key).request.$ref |
string |
Schema-ID für das Anfrageschema. | |
resources.(key).methods.(key).response |
object |
Das Schema für die Antwort. | |
resources.(key).methods.(key).response.$ref |
string |
Schema-ID für das Antwortschema. | |
resources.(key).methods.(key).scopes[] |
list |
Auf diese Methode anwendbare OAuth 2.0-Umfänge. | |
resources.(key).methods.(key).supportsMediaDownload |
boolean |
Gibt an, ob diese Methode Mediendownloads unterstützt. | |
resources.(key).methods.(key).supportsMediaUpload |
boolean |
Gibt an, ob diese Methode Medienuploads unterstützt. | |
resources.(key).methods.(key).mediaUpload |
object |
Parameter für den Medien-Upload. | |
resources.(key).methods.(key).mediaUpload.accept[] |
list |
MIME-Medienbereiche für zulässige Medienuploads zu dieser Methode. | |
resources.(key).methods.(key).mediaUpload.maxSize |
string |
Maximale Größe für einen Medienupload, z. B. „1 MB“, „2 GB“ oder „3 TB“. | |
resources.(key).methods.(key).mediaUpload.protocols |
object |
Unterstützte Upload-Protokolle | |
resources.(key).methods.(key).mediaUpload.protocols.simple |
object |
Unterstützt das Hochladen als einzelne HTTP-Anfrage. | |
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
true , wenn dieser Endpunkt mehrteilige Medien unterstützt. |
|
resources.(key).methods.(key).mediaUpload.protocols.simple.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf API-Ebene verwendet werden. |
|
resources.(key).methods.(key).mediaUpload.protocols.resumable |
object |
Unterstützt das Protokoll für fortsetzbare Medienuploads. | |
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true , wenn dieser Endpunkt das Hochladen von mehrteiligen Medien unterstützt. |
|
resources.(key).methods.(key).mediaUpload.protocols.resumable.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf API-Ebene verwendet werden. |
|
resources.(key).methods.(key).supportsSubscription |
boolean |
Gibt an, ob diese Methode Abos unterstützt. | |
resources.(key).deprecated |
boolean |
Gibt an, ob diese Ressource verworfen wurde. | |
resources.(key).resources |
object |
Untergeordnete Ressourcen zu dieser Ressource. | |
resources.(key).resources.(key) |
nested object |
Beschreibung aller Unterressourcen in dieser Ressource. |