API Gateway Documentation Part

This table represents the API Gateway Documentation Part resource from Amazon Web Services.

aws.apigateway_documentationpart

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
id	core	string	The DocumentationPart identifier, generated by API Gateway when the <code>DocumentationPart</code> is created.
location	core	json	The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
properties	core	string	A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., <code>"{ \"description\": \"The API does ...\" }"</code>. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of <code>x-amazon-apigateway-documentation</code>.
tags	core	hstore