Kong · Schema

EnumConfigFieldSchema

Defines an enum value integration config field.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
display_name	string	user-friendly name of the configuration field.
description	string	Optional brief description of the configuration field.
required	boolean	Denotes whether the config field is a required value.
mutable_condition	object
type	string	The field type of config value.
choices	array	List of enumerated choices that can be selected as the config field value.
default	string	The default value for the config field. Must reference the value of an option listed in `choices`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EnumConfigFieldSchema",
  "title": "EnumConfigFieldSchema",
  "description": "Defines an enum value integration config field.",
  "type": "object",
  "properties": {
    "display_name": {
      "description": "user-friendly name of the configuration field.",
      "type": "string"
    },
    "description": {
      "description": "Optional brief description of the configuration field.",
      "type": "string"
    },
    "required": {
      "description": "Denotes whether the config field is a required value.",
      "type": "boolean",
      "default": false
    },
    "mutable_condition": {
      "$ref": "#/components/schemas/MutableCondition"
    },
    "type": {
      "description": "The field type of config value.",
      "type": "string",
      "enum": [
        "enum"
      ]
    },
    "choices": {
      "description": "List of enumerated choices that can be selected as the config field value.",
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "value",
          "display_name"
        ],
        "properties": {
          "value": {
            "description": "The value represented by this option.",
            "type": "string"
          },
          "display_name": {
            "description": "user-friendly name of the option.",
            "type": "string"
          },
          "description": {
            "description": "Optional brief description of the option.",
            "type": "string"
          }
        }
      }
    },
    "default": {
      "description": "The default value for the config field.\nMust reference the value of an option listed in `choices`.\n",
      "type": "string"
    }
  },
  "required": [
    "type",
    "choices"
  ]
}