Search
K
Konnect Service Catalog

ServiceDocument

object
* Additional properties are NOT allowed.
slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestringrequired

Document title

parent_document_idstring(uuid)

parent document id

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

idstring(uuid)required

The service document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

ServiceDocumentTree

object
* Additional properties are NOT allowed.
slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestringrequired

Document title

parent_document_idstring(uuid)

parent document id

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

idstring(uuid)required

The service document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

childrenarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

CreateServiceDocumentPayload

object
* Additional properties are NOT allowed.
slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestringrequired

Document title

parent_document_idstring(uuid)

parent document id

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

contentstringrequired

Markdown content.

Example

UpdateServiceDocumentPayload

object
* Additional properties are NOT allowed.
slugstring

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestring

Document title

parent_document_idstring(uuid)

parent document id

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

contentstring

Markdown content.

Example

ServiceDocumentContentResponse

object
* Additional properties are NOT allowed.
slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

titlestringrequired

Document title

parent_document_idstring(uuid)required

parent document id

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

contentstringrequired

Markdown content.

idstring(uuid)required

The service document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example