Event Gateway Schema Registries

Update Schema Registry

Changed on

Updates an existing schema registry associated with the specified Event Gateway.

put/v1/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

The unique name of the schema registry.

descriptionstring

A human-readable description.

type'confluent' required

The type of the schema registry.

labelsLabels

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 request

{
  "config": {
    "authentication": {
      "password": "${vault.env['MY_ENV_VAR']}"
    }
  },
  "labels": {
    "env": "test"
  }
}

Response

Updated schema registry object.

namestring required

The unique name of the schema registry.

descriptionstring

A human-readable description.

typestring required

The type of the schema registry.

configobject nullable

The configuration of the schema registry.

labelsLabels

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 "_".

idstring uuid required

The unique identifier of the schema registry.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 106b373707f3Revision changes
    • breaking

      the ////////// request property's minLength was increased from 0 to 1

    • breaking

      the ////////// request property's minLength was increased from 0 to 1

  • 0325d14dfc53Revision changes
    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      the /// request property type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      removed subschema #2 from the /// request property allOf list

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status