0.0.1OAS 3.0

DocumentHub admin Api

API Base URL
  • Server 1:http://documenthub.documenthub.svc.cluster.local:4400/v0

    Konnect cluster

Security
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Additional Information
Contact Kong

Customization

customization operations

Get the document tree

Get the document tree

get
http://documenthub.documenthub.svc.cluster.local:4400/v0/{resourceKind}/{resourceId}/documents/tree

Path Parameters

resourceKindstringrequired

Kind of the Konnect resource

Allowed values:services

Example:services

resourceIdstring(uuid)required

Id of the Konnect resource

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

application/json

Tree of documents

a document tree

idstring(uuid)required

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

parent_document_idstring | null(uuid)

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

titlestringrequired
slugstringrequired

document slug

Example:path-for-seo

metadataobjectrequired

metadata of the document

Example:{"author":"John Doe"}

statusstringrequired

Allowed values:publishedunpublished

childrenarray[object]required

a document tree

Example:[{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","title":"Hello world","status":"published","slug":"hello-world","metadata":{"author":"John Doe"},"children":[]}]

Show Child Parameters
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

get/{resourceKind}/{resourceId}/documents/tree
 
application/json