0.0.1OAS 3.0

DocumentHub Developer Api

API Base URL
  • Server 1:http://documenthub.documenthub.svc.cluster.local:4400/developer/v0

    Konnect cluster

Security
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Additional Information
Contact Kong

Has documentation

Returns whether the resourceKind resourceId pairs has documentation

post
http://documenthub.documenthub.svc.cluster.local:4400/developer/v0/has-documentation

Body

application/json

has documentation

HasDocumentationRequestPayload

resource_kindstringrequired

Allowed values:services

resource_idsarray[string](uuid)requiredunique-items

>= 1 items<= 100 items

Response

200 application/json

Has Documentation response

HasDocumentationResponse

resource_kindstringrequired
resource_idstring(uuid)required
has_documentationbooleanrequired
document_countintegerrequired
post/has-documentation

Body

{ "resource_kind": "services", "resource_ids": [] }
 
200 application/json

Customization

customization operations

Get many documents

Get many documents

get
http://documenthub.documenthub.svc.cluster.local:4400/developer/v0/{resourceKind}/{resourceId}/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

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

Headers

Acceptstring

Allowed values:application/jsonapplication/vnd.konnect.document-tree+json

Default:application/json

Response

Tree of documents

ListDocumentsPortal

* 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/{resourceKind}/{resourceId}/documents