Skip to content
|
search
Plugin Hub
report-issueReport an issue
header icon

WebSocket Validator Configuration

By Kong Inc.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The WebSocket Validator plugin is compatible with the following protocols:

ws, wss

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

  • name

    string required

    The name of the plugin, in this case websocket-validator.

  • instance_name

    string

    An optional custom name to identify an instance of the plugin, for example websocket-validator_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

  • service.name or service.id

    string

    The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/SERVICE_NAME|SERVICE_ID/plugins.

  • route.name or route.id

    string

    The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/ROUTE_NAME|ROUTE_ID/plugins.

  • consumer.name or consumer.id

    string

    The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/CONSUMER_NAME|CONSUMER_ID/plugins.

  • enabled

    boolean default: true

    Whether this plugin will be applied.

  • config

    record required

    • client

      record

      • text

        record

        • type

          string required Must be one of: draft4

          The corresponding validation library for config.client.text.schema. Currently, only draft4 is supported.

        • schema

          string required

          Schema used to validate client-originated text frames. The semantics of this field depend on the validation type set by config.client.text.type.

      • binary

        record

        • type

          string required Must be one of: draft4

          The corresponding validation library for config.client.binary.schema. Currently, only draft4 is supported.

        • schema

          string required

          Schema used to validate client-originated binary frames. The semantics of this field depend on the validation type set by config.client.binary.type.

    • upstream

      record

      • text

        record

        • type

          string required Must be one of: draft4

          The corresponding validation library for config.upstream.text.schema. Currently, only draft4 is supported.

        • schema

          string required

          Schema used to validate upstream-originated text frames. The semantics of this field depend on the validation type set by config.upstream.text.type.

      • binary

        record

        • type

          string required Must be one of: draft4

          The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

        • schema

          string required

          Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.