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
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}
Authentication
Path Parameters
Headers
ResourceKind
stringAllowed values:services
HasDocumentationRequestPayload
objectresource_kindstringrequired
Allowed values:services
resource_idsarray[string](uuid)requiredunique-items
>= 1 items<= 100 items
Example
HasDocumentationResponse
arrayresource_kindstringrequired
resource_idstring(uuid)required
has_documentationbooleanrequired
document_countintegerrequired
HasDocumentationItem
objectresource_kindstringrequired
resource_idstring(uuid)required
has_documentationbooleanrequired
document_countintegerrequired
Example