Kong · Schema

WebsocketValidatorPluginConfig

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
config	object
consumer	object	If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to acti
name	object
protocols	array	A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins th
route	object	If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service	object	If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebsocketValidatorPluginConfig",
  "title": "WebsocketValidatorPluginConfig",
  "x-speakeasy-entity": "PluginWebsocketValidator",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "client": {
          "type": "object",
          "properties": {
            "binary": {
              "type": "object",
              "properties": {
                "schema": {
                  "description": "Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`.",
                  "type": "string"
                },
                "type": {
                  "description": "The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.",
                  "type": "string",
                  "enum": [
                    "draft4"
                  ]
                }
              },
              "required": [
                "schema",
                "type"
              ]
            },
            "text": {
              "type": "object",
              "properties": {
                "schema": {
                  "description": "Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`.",
                  "type": "string"
                },
                "type": {
                  "description": "The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.",
                  "type": "string",
                  "enum": [
                    "draft4"
                  ]
                }
              },
              "required": [
                "schema",
                "type"
              ]
            }
          }
        },
        "upstream": {
          "type": "object",
          "properties": {
            "binary": {
              "type": "object",
              "properties": {
                "schema": {
                  "description": "Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`.",
                  "type": "string"
                },
                "type": {
                  "description": "The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.",
                  "type": "string",
                  "enum": [
                    "draft4"
                  ]
                }
              },
              "required": [
                "schema",
                "type"
              ]
            },
            "text": {
              "type": "object",
              "properties": {
                "schema": {
                  "description": "Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by `config.upstream.binary.type`.",
                  "type": "string"
                },
                "type": {
                  "description": "The corresponding validation library for `config.upstream.binary.schema`. Currently, only `draft4` is supported.",
                  "type": "string",
                  "enum": [
                    "draft4"
                  ]
                }
              },
              "required": [
                "schema",
                "type"
              ]
            }
          }
        }
      }
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "websocket-validator"
    },
    "protocols": {
      "description": "A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.",
      "type": "array",
      "items": {
        "enum": [
          "ws",
          "wss"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "ws",
        "wss"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}