Delete API Product

Removes an individual API product.

delete

Path Parameters

idstring(uuid)required

API product identifier

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

Response

API product was deleted successfully.

delete/api-products/{id}
 

API Product Documentation

Create API Product Document

Creates a document for an API product.

post

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

Body

application/json

CreateDocumentPayload

a document payload

parent_document_idstring | null(uuid)

parent document id

Default:null

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

slugstringrequired

document slug. must be unique accross documents belonging to an api product

Match pattern:^[\w-]+$

<= 80 characters

Example:path-for-seo

statusstringrequired

Allowed values:publishedunpublished

titlestringrequired

document title

>= 1 characters

Example:How to create a document in Konnect DocumentHub

contentstring

Can be markdown string content or base64 encoded string

Example:## My Markdown

metadataobject

metadata of the document

Default:{}

Example:{"author":"John Doe"}

Response

application/json

API product document

ApiProductDocument

an api product document

idstring(uuid)required
parent_document_idstring | null(uuid)required
titlestringrequired
slugstringrequired
statusstringrequired

Allowed values:unpublishedpublished

metadataobjectrequired
contentstringrequired

The unencoded markdown string of the api product document.

astOne Of
array[object]required
HeadingBlockobject
Show Child Parameters
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

post/api-products/{apiProductId}/documents

Body

{ "slug": "api-product-document", "status": "published", "title": "API Product Document", "content": "IyBBUEkgUHJvZHVjdCBEb2N1bWVudCBIZWFkZXIKQVBJIHByb2R1Y3QgZG9jdW1lbnQgY29udGVudA==" }
 
application/json

List API Product Documents

Returns a collection of all documents for an API product.

get

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

apiProductIdstring(uuid)required

The API product identifier

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

Response

List of API product documents

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

returns the pagination information

Show Child Parameters
get/api-products/{apiProductId}/documents
 

Get an API Product Document

Returns a document for the API product.

get

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

idstring(uuid)required

The document identifier related to the API product

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

Response

application/json

API product document

ApiProductDocument

an api product document

idstring(uuid)required
parent_document_idstring | null(uuid)required
titlestringrequired
slugstringrequired
statusstringrequired

Allowed values:unpublishedpublished

metadataobjectrequired
contentstringrequired

The unencoded markdown string of the api product document.

astOne Of
array[object]required
HeadingBlockobject
Show Child Parameters
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

get/api-products/{apiProductId}/documents/{id}
 
application/json