Create API Product Document
Creates a document for an API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
CreateDocumentPayload
a document payload
parent document id
Default:null
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug. must be unique accross documents belonging to an api product
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Allowed values:publishedunpublished
document title
>= 1 characters
Example:How to create a document in Konnect DocumentHub
Can be markdown string content or base64 encoded string
Example:## My Markdown
metadata of the document
Default:{}
Example:{"author":"John Doe"}
Response
application/json
Response
API product document
ApiProductDocument
an api product document
Allowed values:unpublishedpublished
The unencoded markdown string of the api product document.
One OfShow Child Parameters
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
Authentication
Path Parameters
Body
List API Product Documents
Returns a collection of all documents for an API product.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
List of API product documents
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get an API Product Document
Returns a document for the API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The document identifier related to the API product
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Response
application/json
Response
API product document
ApiProductDocument
an api product document
Allowed values:unpublishedpublished
The unencoded markdown string of the api product document.
One OfShow Child Parameters
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
Authentication
Path Parameters
Update an API Product Document
Updates a document for an API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The document identifier related to the API product
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Body
application/json
Body
UpdateDocumentAttributesAndContentPayload
a document payload
Parent document Id. If this value is explicitly set to null, the
document will be put as a top level document at the bottom of the tree.
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug. must be unique accross documents belonging to an api product
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Allowed values:publishedunpublished
document title
>= 1 characters
Example:How to update a document in Konnect DocumentHub
Can be markdown string content or base64 encoded string
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
Response
application/json
Response
API product document
ApiProductDocument
an api product document
Allowed values:unpublishedpublished
The unencoded markdown string of the api product document.
One OfShow Child Parameters
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
Authentication
Path Parameters
Body
Delete API Product Documentation
Removes a document from an API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The document identifier related to the API product
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Response
Response
Document for the API product was deleted successfully.