Kong · Schema

EventGatewayPolicyPatch

The schema of the policy to patch it.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
name	string	A unique user-defined name of the policy.
description	string	A human-readable description of the policy.
enabled	boolean	Whether the policy is enabled.
condition	string	A string containing the boolean expression that determines whether the policy is applied.
labels	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventGatewayPolicyPatch",
  "title": "EventGatewayPolicyPatch",
  "description": "The schema of the policy to patch it.",
  "properties": {
    "name": {
      "description": "A unique user-defined name of the policy.",
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "nullable": true,
      "pattern": "^[\\p{L}\\p{N}][\\p{L}\\p{N} _\\-\\.']*[\\p{L}\\p{N}]$"
    },
    "description": {
      "description": "A human-readable description of the policy.",
      "type": "string",
      "maxLength": 512,
      "nullable": true
    },
    "enabled": {
      "description": "Whether the policy is enabled.",
      "type": "boolean"
    },
    "condition": {
      "description": "A string containing the boolean expression that determines whether the policy is applied.",
      "type": "string",
      "example": "context.topic.name.endsWith('my_suffix')",
      "maxLength": 1000,
      "nullable": true,
      "x-expression": {
        "type": "boolean"
      }
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    }
  }
}