CreateDocumentationPart - Amazon API Gateway


Creates a documentation part.

Request Syntax

POST /restapis/restapi_id/documentation/parts HTTP/1.1 Content-type: application/json { "location": { "method": "string", "name": "string", "path": "string", "statusCode": "string", "type": "string" }, "properties": "string" }

URI Request Parameters

The request uses the following URI parameters.


The string identifier of the associated RestApi.

Required: Yes

Request Body

The request accepts the following data in JSON format.


The location of the targeted API entity of the to-be-created documentation part.

Type: DocumentationPartLocation object

Required: Yes


The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "id": "string", "location": { "method": "string", "name": "string", "path": "string", "statusCode": "string", "type": "string" }, "properties": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.


The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Type: String


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


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 of x-amazon-apigateway-documentation.

Type: String


For information about the errors that are common to all actions, see Common Errors.


The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400


The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409


The request exceeded the rate limit. Retry after the specified time period.

HTTP Status Code: 429


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: