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-Instances enthält.

Eigenschaften
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 einer API Gateway-Erweiterung für OpenAPI definiert DocumentationParts-Instances, die in eine API in API Gateway importiert oder von einer API in 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
      }
    ]
  }
}