Get one product document
Returns the specified document from the product’s document tree.
Path Parameters
Contains a unique identifier used by the Portal API for this resource.
ID of the document.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Headers
Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json
Default:application/json
Response
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.
Contains a unique identifier used by the DocumentHub service for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used by the DocumentHub service for this resource.
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Slug of the document. This is used in the URL to identify the document.
Example:getting-started
Markdown document
Example:# My Kong api This api is powered by Konnect
Title of the document. This is used in the Portal UI to identify the document.
Example:Hello World
Product Actions Response
objectList of actions that can be performed on the API Product
Show Child Parameters
Product
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Name of product.
Example:Billing
Example:API for billing functions
Number of linked documents in documentation.
Example:3
Number of published versions.
Example:2
Show Child Parameters
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"}
ProductListPage
objectreturns the pagination information
Show Child Parameters
Show Child Parameters
ProductVersion
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Name of product version.
Example:v2.0.0
If true, product version is deprecated.
Configurations for how the product version is able to be registered for by applications.