HasDocumentationRequestPayload

object
resource_kindstringrequired

Allowed values:services

resource_idsarray[string](uuid)requiredunique-items

>= 1 items<= 100 items

Example

HasDocumentationResponse

array
resource_kindstringrequired
resource_idstring(uuid)required
has_documentationbooleanrequired
document_countintegerrequired

HasDocumentationItem

object
resource_kindstringrequired
resource_idstring(uuid)required
has_documentationbooleanrequired
document_countintegerrequired
Example

Document

object

a document

idstring(uuid)required

the id of the document

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

parent_document_idstring(uuid)

the id of the parent document

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

slugstringrequired

the slug of the document

Example:getting-started

revisionobjectrequired

revision of a document

Show Child Parameters
Example

Revision

object

revision of a document

idstring(uuid)required

the id of the revision

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

document_idstring(uuid)required

the id of the document

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

contentobjectrequired

content of the document

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

Show Child Parameters
metaobjectrequired

the metadata of the document

Example:{"title":"Hello World","description":"This is a description","keywords":"hello, world"}

titlestringrequired

the title of the document

Example:Hello World

Example