x-amazon-apigateway-documentation Objekt - APIAmazon-Gateway
x-amazon-apigateway-documentation Beispiel

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

x-amazon-apigateway-documentation Objekt

Definiert die Dokumentationsteile, die in API Gateway importiert werden sollen. Dieses Objekt ist ein JSON Objekt, das ein Array der DocumentationPart Instanzen enthält.

Name der Eigenschaft Typ Beschreibung
documentationParts Array

Ein Array der exportierten oder importierten DocumentationPart-Instances.
version String

Die Versions-ID des Snapshots der exportierten Dokumentationsbausteine.

x-amazon-apigateway-documentation Beispiel

Das folgende Beispiel für die API Gateway-Erweiterung für Open API definiert DocumentationParts Instanzen, die API in ein In-Gateway importiert oder aus einem API Gateway exportiert werden sollen. 

{ ...
  "x-amazon-apigateway-documentation": {
    "version": "1.0.3",
    "documentationParts": [
       {
         "location": {
           "type": "API"
       },
        "properties": {
          "description": "API description",
          "info": {
            "description": "API info description 4",
            "version": "API info version 3"
          }
        }
      },
      {
         … // Another DocumentationPart instance
      }
    ]
  }
}