DocumentationPart
import type { DocumentationPart } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location).
The target specifies an API entity to which the documentation content applies.
The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY.
Valid location fields depend on the API entity type.
All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
See also: Documenting an API, "DocumentationParts"
§Properties
The "DocumentationPart" identifier, generated by API Gateway when the DocumentationPart is created.
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.