List product documents

Returns a list of documents that are associated with a given product. The list is paginated, and is in either a list or tree format (based on the Accept header).

get
/api/v2/products/{productId}/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

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Headers

Acceptstring

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

Default:application/json

Response

Lists documents for a given product.

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 one product document

Returns the specified document from the product’s document tree.

get
/api/v2/products/{productId}/documents/{documentId}

Path Parameters

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

documentIdstring(uuid)required

ID of the document.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Headers

Acceptstring

Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json

Default:application/json

Response

Details for a single document for a given product.

ProductDocumentRaw

A document for a product. This is a document that is not a part of the API specification.

idstring(uuid)requiredread-only

Contains a unique identifier used by the DocumentHub service for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

parent_document_idstring | null(uuid)

Contains a unique identifier used by the DocumentHub service for this resource.

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

Slug of the document. This is used in the URL to identify the document.

Example:getting-started

contentstringrequired

Markdown document

Example:# My Kong api This api is powered by Konnect

titlestringrequired

Title of the document. This is used in the Portal UI to identify the document.

Example:Hello World

Product Actions Response

object
* Additional properties are NOT allowed.
actionsobjectrequired

List of actions that can be performed on the API Product

* Additional properties are NOT allowed.
Show Child Parameters
Example

Product

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

Name of product.

Example:Billing

descriptionstring

Example:API for billing functions

document_countintegerread-only

Number of linked documents in documentation.

Example:3

version_countintegerread-only

Number of published versions.

Example:2

latest_versionobject
* Additional properties are NOT allowed.
Show Child Parameters
public_labelsobjectrequired

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

Example

ProductListPage

object
metaobject

returns the pagination information

Show Child Parameters
dataarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
Example