API Product Document Summary

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

The API product document identifier.

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

parent_document_idstring(uuid)required

The parent API product document identifier.

slugstringrequired

API product document slug

Match pattern:^[\w-]+$

Example:api-product-document

statusstringrequired

Allowed values:publishedunpublished

titlestringrequired

API product document title

Example:API Product Document

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

Example

ApiProductDocument

object

an api product document

idstring(uuid)required
parent_document_idstring(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

Example

AuthStrategySyncError

object
* Additional properties are NOT allowed.
plugin_namestring
valuestring

Allowed values:plugin_sync_error_commplugin_sync_error_unknownplugin_sync_error_fatalplugin_sync_error_updating_plugin_refs

messagestringrequired
infoobject
* Additional properties are allowed.
Show Child Parameters
Example

AuthStrategySyncErrors

array

The set of errors encountered when trying to sync the auth strategies on the version

plugin_namestring
valuestring

Allowed values:plugin_sync_error_commplugin_sync_error_unknownplugin_sync_error_fatalplugin_sync_error_updating_plugin_refs

messagestringrequired
infoobject
* Additional properties are allowed.
Show Child Parameters
Example

API Product Version

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

The API product version identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The version of the API product

Example:FirstVersion

gateway_serviceobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
publish_statusstringrequiredDEPRECATED

This field is published if the API product version is published to at least one portal. This field is deprecated: Use PortalProductVersion.publish_status instead.

Allowed values:unpublishedpublished

Example:unpublished

deprecatedbooleanrequiredDEPRECATED

Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

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

Example:{"env":"test"}

auth_strategy_sync_errorsarray[object]read-only

The set of errors encountered when trying to sync the auth strategies on the version

Example:{"plugin_name":"konnect-application-auth","value":"plugin_sync_error_comm","message":"Unable to connect to the control plane to update plugin"}

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

The list of portals which this API product version is configured for

>= 0 items

* Additional properties are NOT allowed.
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

Example