Edit API document
- Print
- PDF
Edit API document
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Edit the content of a deployed API manual. It's only available for APIs you create yourself.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| PATCH | /products/{product-id}/apis/{api-id}/documents |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id | String | Required | Product ID that the API belongs to
|
api-id | String | Required | ID of the API whose document you want to edit
|
Request syntax
The request syntax is as follows.
{
"documentMd" : "string"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
documentMd | String | Required | API manual content |
Request example
The following is a sample request.
curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/w1k03m9zo9/apis/cvcohvd2xj/documents' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"documentMd" : "Manual of the API document"
}'
Response
The following describes the response format.
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Was this article helpful?