0.0.2OAS 3.0

DocumentHub developer Api

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

    Konnect cluster

Security
portalAccessToken (apiKey)

The Developer portal cookie is meant to be used by the Developer API to authenticate with.

Additional Information
Contact Kong

Documents

document operations

List collection documents

List documents in a collection

get
http://documenthub.documenthub.svc.cluster.local:4400/developer/v2/collections/{collectionId}/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

filter[field]string

A field to filter on. Supported fields: slug, metadata.

Example:filter[name]=my-doc

Path Parameters

collectionIdstring(uuid)required

Targeted collection

Example:bb84c46a-432d-4314-81e4-478614a52dcb

Response

Documents in the collection

ListDocuments

* 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/collections/{collectionId}/documents