Update API Product Version Request

object

The 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.

* Additional properties are NOT allowed.
namestring

The version name of the API product version.

>= 1 characters

Example:v1

publish_statusstringDEPRECATED

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

deprecatedbooleanDEPRECATED

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.

notifyboolean

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

gateway_serviceAny Of
GatewayServicePayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

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"}

Example

Update API Product Version Specification Request

object

The request schema for updating a specification for a version of an API product.

* Additional properties are NOT allowed.
namestring

The name of the API product version specification

Match pattern:^.+(?:\.yaml|\.yml|\.json)$

>= 1 characters<= 255 characters

Example:oas.yaml

contentstring(byte)

The base64 encoded contents of the API product version specification

>= 1 characters

Example:TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA==

Example

LegacyGatewayServicePayload

object
* Additional properties are NOT allowed.
idstring(uuid)required

The identifier of a gateway service associated with the version of the API product.

Example:09b4786a-3e48-4631-8f6b-62d1d8e1a7f3

runtime_group_idstring(uuid)requiredDEPRECATED

The identifier of the control plane that the gateway service resides in

Example:e4d9ebb1-26b4-426a-b00e-cb67044f3baf

Example

GatewayServicePayload

object
* Additional properties are NOT allowed.
idstring(uuid)required

The identifier of a gateway service associated with the version of the API product.

Example:09b4786a-3e48-4631-8f6b-62d1d8e1a7f3

control_plane_idstring(uuid)required

The identifier of the control plane that the gateway service resides in

Example:e4d9ebb1-26b4-426a-b00e-cb67044f3baf

Example

StringFieldFilter

One Of
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

containsstring

The field contains the provided value.

Example:?filter[field_name_here][contains]=foo

ocontainsstring

The field contains any of the provided values.

Example:?filter[field_name_here][ocontains]=foo,bar

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example