Create API Product Version Request
objectThe request schema to create a version of an API product.
Note that the publish_status and deprecated fields are deprecated: Use PortalProductVersion.publish_status instead.
The version name of the API product version.
>= 1 characters
Example:v1
The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use PortalProductVersion.publish_status instead.
Allowed values:unpublishedpublished
Default:unpublished
Example:unpublished
Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Default:false
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"}
One OfShow Child Parameters
Create API Product Version Specification Request
objectThe request schema to create a specification for a version of an API product.
The name of the API product version specification
Match pattern:^.+(?:\.yaml|\.yml|\.json)$
>= 1 characters<= 255 characters
Example:oas.yaml
The base64 encoded contents of the API product version specification
>= 1 characters
Example:TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA==
CreateDocumentPayload
objecta 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"}
UpdateDocumentAttributesAndContentPayload
objecta 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=
Update API Product Version Request
objectThe request schema for updating a version of an API product.
Note that the publish_status and deprecated fields are deprecated: Use PortalProductVersion.publish_status instead.
The version name of the API product version.
>= 1 characters
Example:v1
The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use PortalProductVersion.publish_status instead.
Allowed values:unpublishedpublished
Example:unpublished
Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
When set to true, and all the following conditions are true:
- version of the API product deprecation has changed from
false->true - version of the API product is published
then consumers of the now deprecated verion of the API product will be notified.
Example:true
Any OfShow Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}