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
List Catalog Service Documents
Returns a paginated collection of documents attached to the given service.
get
Query Parameters
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Headers
Acceptstring
Determines if response should be in JSON format or a document tree
Allowed values:application/jsonapplication/vnd.konnect.document-tree+json
Default:application/json
Response
Response
A paginated list response for a collection of documents targeted by a service.
* 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/catalog-services/{serviceId}/documents
Authentication
Path Parameters
Query Parameters
Headers
Get a Catalog Service Document
Fetched a service document.
get
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
documentIdstringrequired
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Headers
Acceptstring
Allowed values:application/json
Default:application/json
Response
application/json
Response
application/json
Response object for fetching a single service document
ServiceDocumentContentResponse
* Additional properties are NOT allowed.
slugstringrequired
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
titlestringrequired
Document title
parent_document_idstring | null(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
get/catalog-services/{serviceId}/documents/{documentId}
Authentication
Path Parameters
Headers
application/json
Update Catalog Service Document
Updates a service document.
patch
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
documentIdstringrequired
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Body
application/json
Body
application/json
UpdateServiceDocumentPayload
* Additional properties are NOT allowed.
slugstring
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
titlestring
Document title
parent_document_idstring | null(uuid)
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
contentstring
Markdown content.
Response
application/json
Response
application/json
A paginated list response for a collection of documents targeted by a service.
ServiceDocumentContentResponse
* Additional properties are NOT allowed.
slugstringrequired
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
titlestringrequired
Document title
parent_document_idstring | null(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
patch/catalog-services/{serviceId}/documents/{documentId}
Authentication
Path Parameters
Body
{
"slug": "readme",
"title": "README",
"content": "My Documentation"
}
application/json
Delete Catalog Service Document
Deletes a service document.
delete
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
documentIdstringrequired
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Response
Response
Service document was deleted successfully.
delete/catalog-services/{serviceId}/documents/{documentId}
Authentication
Path Parameters
Move Catalog Service Document
Moves a service document.
post
Path Parameters
serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
documentIdstringrequired
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Body
application/json
Body
application/json
Move document
move document request payload
parent_document_idstring(uuid)
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
indexinteger
index of the document in the parent document’s children
Example:1
Response
Response
The service document has been moved
post/catalog-services/{serviceId}/documents/{documentId}/move
Authentication
Path Parameters
Body
{
"parent_document_id": "71a10e4f-8def-44db-b9b2-88823f41b5e8",
"index": 0
}