DocumentationPart
A documentation part for a targeted API entity.
Links
Relation | Description | Method | Templated |
---|---|---|---|
self | A relation that refers to the current resource. |
GET | No |
documentationpart:delete | Deletes a specified DocumentationPart item. |
DELETE | No |
documentationpart:update | Updates the content in a specified DocumentationPart item. |
PATCH | No |
Properties
{
"id" : "String",
"location" : {
"type" : "String",
"path" : "String",
"method" : "String",
"statusCode" : "String",
"name" : "String"
},
"properties" : "String"
}
- id
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created.- 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
[Required] The type of API entity to which the documentation content applies. Valid values are
API
,AUTHORIZER
,MODEL
,RESOURCE
,METHOD
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
,RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. Content inheritance does not apply to any entity of theAPI
,AUTHORIZER
,METHOD
,MODEL
,REQUEST_BODY
, orRESOURCE
type.- path
The URL path of the target. It is a valid field for the API entity types of
RESOURCE
,METHOD
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
,RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. The default value is/
for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the otherlocation
attributes, the child entity'spath
attribute must match that of the parent entity as a prefix.- method
The HTTP verb of a method. It is a valid field for the API entity types of
METHOD
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
,RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. The default value is*
for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocation
attributes, the child entity'smethod
attribute must match that of the parent entity exactly.- statusCode
The HTTP status code of a response. It is a valid field for the API entity types of
RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. The default value is*
for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocation
attributes, the child entity'sstatusCode
attribute must match that of the parent entity exactly.- name
The name of the targeted API entity. It is a valid and required field for the API entity types of
AUTHORIZER
,MODEL
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
andRESPONSE_HEADER
. It is an invalid field for any other entity type.- 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 theproperties 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
.
Remarks
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.