API Package Documentation

Create API Package Document

Changed on

Publish a new document attached to an API Package.

All configuration options may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the POST request will take precedence.

post/v3/api-packages/{packageId}/documents

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/api-packages/{packageId}/documents
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

idstring uuid

The API document identifier.

contentstring required

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 Package 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

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

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

    • warning

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

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status