MENU
      Edit API document

        Edit API document


        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the API belongs to
        api-idStringRequiredID of the API whose document you want to edit

        Request syntax

        The request syntax is as follows.

        {
          "documentMd" : "string"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        documentMdStringRequiredAPI 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"
        }'
        Curl

        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?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.