x-amazon-apigateway-documentation objet - APIPasserelle Amazon
x-amazon-apigateway-documentation exemple

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

x-amazon-apigateway-documentation objet

Définit les parties de documentation à importer dans API Gateway. Cet objet est un JSON objet contenant un tableau des DocumentationPart instances.

Nom de la propriété Type Description
documentationParts Array

Un tableau des instances DocumentationPart exportées ou importées.
version String

L'identifiant de version de l'instantané des parties de la documentation exportées.

x-amazon-apigateway-documentation exemple

L'exemple suivant d'extension API Gateway pour Open API définit DocumentationParts les instances à importer ou à exporter depuis un API API portail intégré. 

{ ...
  "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
      }
    ]
  }
}