API Documentation

Update API Document

Changed on

Updates a document for an API.

patch/v3/apis/{apiId}/documents/{documentId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/apis/{apiId}/documents/{documentId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

idstring uuid

The API document identifier.

contentstring

Raw markdown content to display in your Portal

titlestring

The title of the document. Used to populate the <title> tag for the page

slugstring

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(title)

status'published' | 'unpublished'

If status=published the document will be visible in your live portal

parent_document_idstring uuid nullable

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example request

{
  "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  "title": "API Document",
  "slug": "api-document",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Response

API document

idstring uuid required

The API document identifier.

contentstring required

Raw markdown content to display in your Portal

titlestring required

The title of the document. Used to populate the <title> tag for the page

slugstring required

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(title)

status'published' | 'unpublished' required

If status=published the document will be visible in your live portal

parent_document_idstring uuid nullable required

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  "title": "API Document",
  "slug": "api-document",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 5d2b35832e3fRevision changes
    • warning

      added the new type enum value to the /////// response property for the response status

  • ecce2daf9de6Revision changes
    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property became nullable for the status