Kong · Schema

EventGatewayPolicy

A policy associated with an Event Gateway.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
type string The type name of the policy.
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.
labels object
id string The unique identifier of the policy.
config object The configuration of the policy.
created_at object
parent_policy_id string The unique identifier of the parent policy, if any.
updated_at object
condition string A string containing the boolean expression that determines whether the policy is applied.
View JSON Schema on GitHub

JSON Schema

kong-eventgatewaypolicy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventGatewayPolicy",
  "title": "EventGatewayPolicy",
  "description": "A policy associated with an Event Gateway.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The type name of the policy.",
      "type": "string",
      "maxLength": 255,
      "minLength": 1
    },
    "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"
    },
    "id": {
      "description": "The unique identifier of the policy.",
      "type": "string",
      "format": "uuid"
    },
    "config": {
      "description": "The configuration of the policy.",
      "type": "object"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "parent_policy_id": {
      "description": "The unique identifier of the parent policy, if any.",
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "condition": {
      "description": "A string containing the boolean expression that determines whether the policy is applied.",
      "type": "string",
      "default": "",
      "maxLength": 1000,
      "x-expression": {
        "type": "boolean",
        "fields": []
      }
    }
  },
  "required": [
    "type",
    "id",
    "created_at",
    "updated_at"
  ]
}