API docs by Redocly

Internal DocumentHub Developer Api (0.0.1)

Download OpenAPI specification:Download

URL: https://konghq.com

DocumentHub Developer Api

Customization

customization operations

Get many documents

Get many documents

Authorizations:
bearerAuth
path Parameters
resourceKind
required
string
Value: "services"
Example: services

Kind of the Konnect resource

resourceId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Konnect resource

query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

header Parameters
Accept
string (DocumentContentTypeEnum)
Default: application/json
Enum: "application/json" "application/vnd.konnect.document-tree+json"

Responses

Response samples

Content type
No sample

get the document tree

get the document tree

Authorizations:
bearerAuth
path Parameters
resourceKind
required
string
Value: "services"
Example: services

Kind of the Konnect resource

resourceId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Konnect resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get the document by its id

get the document by its id

Authorizations:
bearerAuth
path Parameters
resourceKind
required
string
Value: "services"
Example: services

Kind of the Konnect resource

resourceId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Konnect resource

documentId
required
string <uuid>
Example: bb84c46a-432d-4314-81e4-478614a52dcb

Targeted document

header Parameters
Accept
string (DocumentFormatContentTypeEnum)
Default: application/json
Enum: "text/markdown" "application/json" "application/vnd.konnect.document-nodes+json"

Responses

Response samples

Content type
{
  • "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "getting-started",
  • "revision": {
    }
}

get the document by its slug

get the document by its slug

Authorizations:
bearerAuth
path Parameters
resourceKind
required
string
Value: "services"
Example: services

Kind of the Konnect resource

resourceId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Konnect resource

slug
required
string
Example: getting-started

slug of the document

header Parameters
Accept
string (DocumentFormatContentTypeEnum)
Default: application/json
Enum: "text/markdown" "application/json" "application/vnd.konnect.document-nodes+json"

Responses

Response samples

Content type
{
  • "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "getting-started",
  • "revision": {
    }
}

Returns wether the resourceKind resourceId pairs has documentation

Has documentation

Authorizations:
bearerAuth
Request Body schema: application/json

has documentation

resource_kind
required
string (ResourceKind)
Value: "services"
resource_ids
required
Array of strings <uuid> [ 1 .. 100 ] items unique

Responses

Request samples

Content type
application/json
{
  • "resource_kind": "services",
  • "resource_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]