---
title: "Schema Validation"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/schemas/EventGatewayConsumeSchemaValidationPolicy"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19.md

# Schema Validation

A policy that validates consume messages against a schema registry.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for Event Gateways
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    SchemaValidationType:
      description: >
        How to validate the schema and parse the record.

        * confluent_schema_registry - validates against confluent schema
        registry.

        * json - simple JSON parsing without the schema.
      type: string
      enum:
        - confluent_schema_registry
        - json
    SchemaRegistryReference:
      description: A reference to a schema Registry.
      oneOf:
        - $ref: "#/components/schemas/SchemaRegistryReferenceById"
        - $ref: "#/components/schemas/SchemaRegistryReferenceByName"
      x-terraform-preferred: "#/components/schemas/SchemaRegistryReferenceById"
    ConsumeKeyValidationAction:
      description: |
        Defines a behavior when record key is not valid.
        * mark - marks a record with kong/server header and client ID value
          to help to identify the clients violating schema.
        * skip - skips delivering a record.
      type: string
      enum:
        - mark
        - skip
    ConsumeValueValidationAction:
      description: |
        Defines a behavior when record value is not valid.
        * mark - marks a record with kong/server header and client ID value
          to help to identify the clients violating schema.
        * skip - skips delivering a record.
      type: string
      enum:
        - mark
        - skip
    SchemaRegistryReferenceById:
      type: object
      properties:
        id:
          description: The unique identifier of the schema registry.
          type: string
          format: uuid
          minLength: 1
      required:
        - id
    SchemaRegistryReferenceByName:
      description: Reference a schema registry by its unique name.
      type: object
      properties:
        name:
          description: The unique name of the schema registry.
          type: string
          maxLength: 255
          minLength: 1
      required:
        - name
    EventGatewayConsumeSchemaValidationPolicy:
      description: A policy that validates consume messages against a schema registry.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          enum:
            - schema_validation
          maxLength: 255
          minLength: 1
          x-terraform-transform-const: true
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        config:
          description: The configuration of the schema validation policy.
          type: object
          properties:
            type:
              $ref: "#/components/schemas/SchemaValidationType"
            schema_registry:
              $ref: "#/components/schemas/SchemaRegistryReference"
            key_validation_action:
              $ref: "#/components/schemas/ConsumeKeyValidationAction"
            value_validation_action:
              $ref: "#/components/schemas/ConsumeValueValidationAction"
          required:
            - type
        condition:
          description: A string containing the boolean expression that determines whether
            the policy is applied.
          type: string
          example: context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] ==
            "a-value"
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields:
              - name: context.auth.principal.name
                type: string
                description: Name of authenticated principal. Username in case of PLAIN/SCRAM,
                  `sub` claim in case of OAUTHBEARER.
              - name: context.auth.type
                type: string
                description: >
                  The matched authentication type from a virtual cluster:
                  anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512,
                  sasl_oauth_bearer.
              - name: context.topic.name
                type: string
                description: The name of the topic.
              - name: record.headers
                type: object
                description: An associative array of header key value pairs.
      required:
        - type
        - config
      title: Schema Validation
```
