Objeto x-amazon-apigateway-documentation - Amazon API Gateway
Ejemplo de x-amazon-apigateway-documentation

Objeto x-amazon-apigateway-documentation

Define las piezas de documentación que se van a importar a API Gateway. Este objeto es un objeto JSON que contiene una matriz de instancias DocumentationPart.

Nombre de la propiedad Tipo Descripción
documentationParts Array

Una matriz de instancias DocumentationPart exportadas o importadas.
version String

El identificador de versión de la snapshot de las piezas de documentación exportadas.

Ejemplo de x-amazon-apigateway-documentation

El siguiente ejemplo de la extensión de API Gateway para OpenAPI define instancias DocumentationParts para que se importen o exporten desde una API en API Gateway. 

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