v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Creates a documentation part.

post/restapis/{restapi_id}/documentation/parts

Path parameters

restapi_idstring required

The string identifier of the associated RestApi.

Request body

propertiesstring required

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.

Response

Success

idstring

The DocumentationPart identifier, generated by API Gateway when the <code>DocumentationPart</code> is created.

{"stackTrail":"components:schemas:DocumentationPart:properties:properties","oasType":"schema","type":"unknown","description":"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>."}