Catalog Service Documents
Attach documentation for your services to communicate it’s architecture, support details, release notes, and usage examples, to help others understand and integrate with the service.
Create Service Document
Creates a service document
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
CreateServiceDocumentPayload
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
Response
application/json
Response
Response object for fetching a single service document
ServiceDocumentContentResponse
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
The service document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
List Catalog Service Documents
Returns a paginated collection of documents attached to the given service.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Headers
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.
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Headers
Get a Catalog Service Document
Fetched a service document.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Headers
Allowed values:application/json
Default:application/json
Response
application/json
Response
Response object for fetching a single service document
ServiceDocumentContentResponse
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
The service document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Headers
Update Catalog Service Document
Updates a service document.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Body
application/json
Body
UpdateServiceDocumentPayload
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
Response
application/json
Response
A paginated list response for a collection of documents targeted by a service.
ServiceDocumentContentResponse
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
Document title
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Markdown content.
The service document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z