x-amazon-apigateway-documentation objeto

Define as partes de documentação a serem importadas para o API Gateway. Esse objeto é um objeto JSON que contém uma matriz das instâncias de DocumentationPart.

Propriedades
Nome da propriedade	Tipo	Descrição
documentationParts	Array	Uma matriz das instâncias de DocumentationPart exportadas ou importadas.
version	String	O identificador de versão do snapshot das partes de documentação exportadas.

x-amazon-apigateway-documentation exemplo

O exemplo a seguir da extensão do API Gateway para o OpenAPI define instâncias DocumentationParts a serem importadas ou exportadas de uma API no 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
      }
    ]
  }
}