x-amazon-apigateway-documentation oggetto

Definisce le parti della documentazione da importare in API Gateway. Questo oggetto è un JSON oggetto contenente una matrice di DocumentationPart istanze.

Nome proprietà	Tipo	Descrizione
documentationParts	Array	Matrice delle istanze di DocumentationPart esportate o importate.
version	String	L'identificatore di versione dello snapshot delle parti di documentazione esportate.

x-amazon-apigateway-documentation esempio

L'esempio seguente dell'estensione API Gateway a Open API definisce DocumentationParts le istanze da importare o esportare da un Gateway API inAPI.

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