Documents

document operations

List collection documents

List documents in a collection

get
http://documenthub.documenthub.svc.cluster.local:4400/developer/v2/collections/{collectionId}/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

filter[field]string

A field to filter on. Supported fields: slug, metadata.

Example:filter[name]=my-doc

Path Parameters

collectionIdstring(uuid)required

Targeted collection

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

Response

Documents in the collection

ListDocuments

* 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/collections/{collectionId}/documents
 

Get a document by slug

Get a document. Will be removed after

get
http://documenthub.documenthub.svc.cluster.local:4400/developer/v2/collections/{collectionId}/documents/slug

Query Parameters

slugstringrequired

Unique slug of the document.

Example:/about/company

Path Parameters

collectionIdstring(uuid)required

Targeted collection

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

Response

application/json

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
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/collections/{collectionId}/documents/slug
 
application/json

Get the document

Get the document

get
http://documenthub.documenthub.svc.cluster.local:4400/developer/v2/collections/{collectionId}/documents/{documentId}

Path Parameters

collectionIdstring(uuid)required

Targeted collection

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

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
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/collections/{collectionId}/documents/{documentId}
 

ListDocumentsTree

object
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

a document tree

Show Child Parameters
Example