POST

/restapis/{restapi_id}/documentation/parts

http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/documentation/parts

Creates a documentation part.

Access Token Required: API Key

Path Parameters

restapi_idstringrequired

The string identifier of the associated RestApi.

Body Params

locationobjectrequired

Specifies the target API entity to which the documentation applies.

propertiesstringrequired

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/documentation/parts' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}