DocumentationPart
A documentation part for a targeted API entity.
Contents
- id
-
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPartis created.Type: String
Required: No
- location
-
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.
Type: DocumentationPartLocation object
Required: No
- properties
-
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.,
"{ \"description\": \"The API does ...\" }". 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 ofx-amazon-apigateway-documentation.Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
