Get many documents

Get many documents

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

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

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

Headers

Acceptstring

Allowed values:application/jsonapplication/vnd.konnect.document-tree+json

Default:application/json

Response

Tree of documents

ListDocumentsPortal

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/{resourceKind}/{resourceId}/documents
 

Get Document Tree

get the document tree

get
http://documenthub.documenthub.svc.cluster.local:4400/developer/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

the title of the document

Example:Getting Started

slugstringrequired

the slug of the document

Example:getting-started

metaobjectrequired

the metadata of the document

Example:{"author":"Jane Doe","description":"This is a description","keywords":"hello, world"}

childrenarray[object]required

a document tree

Show Child Parameters
get/{resourceKind}/{resourceId}/documents/tree
 
application/json

Get Document by ID

get the document by its id

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

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

documentIdstring(uuid)required

Targeted document

Example:bb84c46a-432d-4314-81e4-478614a52dcb

Headers

Acceptstring

Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json

Default:application/json

Response

Document

Document

a document

idstring(uuid)required

the id of the document

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

parent_document_idstring | null(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
get/{resourceKind}/{resourceId}/documents/{documentId}
 

Get Document by Slug

get the document by its slug

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

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

slugstringrequired

slug of the document

Example:getting-started

Headers

Acceptstring

Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json

Default:application/json

Response

Document

Document

a document

idstring(uuid)required

the id of the document

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

parent_document_idstring | null(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
get/{resourceKind}/{resourceId}/documents/slug/{slug}
 

ResourceKind

string

Allowed values:services