ProductDocument

object

A document for a product. This is a document that is not a part of the API specification.

idstring(uuid)requiredread-only

Contains a unique identifier used by the DocumentHub service for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

parent_document_idstring(uuid)

Contains a unique identifier used by the DocumentHub service for this resource.

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

Slug of the document. This is used in the URL to identify the document.

Example:getting-started

contentobjectrequired

content of the document

Example:{"type":"document","content":[{"type":"paragraph","content":[{"text":"Hello World","type":"text"}]}]}

Show Child Parameters
titlestringrequired

Title of the document. This is used in the Portal UI to identify the document.

Example:Hello World

Example

ProductDocumentRaw

object

A document for a product. This is a document that is not a part of the API specification.

idstring(uuid)requiredread-only

Contains a unique identifier used by the DocumentHub service for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

parent_document_idstring(uuid)

Contains a unique identifier used by the DocumentHub service for this resource.

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

Slug of the document. This is used in the URL to identify the document.

Example:getting-started

contentstringrequired

Markdown document

Example:# My Kong api This api is powered by Konnect

titlestringrequired

Title of the document. This is used in the Portal UI to identify the document.

Example:Hello World

Example

UUID

string

Contains a unique identifier used for this resource.

Example

CreatedAt

string

An ISO-8601 timestamp representation of entity creation date.

Example

UpdatedAt

string

An ISO-8601 timestamp representation of entity update date.

Example