Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The Request Validator plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
string required
The name of the plugin, in this case
request-validator
.- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
name
. - If using the KongPlugin object in Kubernetes, the field is
plugin
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
string
An optional custom name to identify an instance of the plugin, for example
request-validator_my-service
.The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.
An instance name must be unique within the following context:
- Within a workspace for Kong Gateway Enterprise
- Within a control plane or control plane group for Konnect
- Globally for Kong Gateway (OSS)
-
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/{serviceName|Id}/plugins
. -
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/{routeName|Id}/plugins
. -
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/{consumerName|Id}/plugins
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
string
The request body schema specification. One of
body_schema
orparameter_schema
must be specified.
-
set of type
string
default:application/json
List of allowed content types. The value can be configured with the
charset
parameter. For example,application/json; charset=UTF-8
.
-
string required default:
kong
Must be one of:kong
,draft4
Which validator to use. Supported values are
kong
(default) for using Kong’s own schema validator, ordraft4
for using a JSON Schema Draft 4-compliant validator.
-
array of type
record
Array of parameter validator specification. One of
body_schema
orparameter_schema
must be specified.-
string required Must be one of:
query
,header
,path
The location of the parameter.
-
string required
The name of the parameter. Parameter names are case-sensitive, and correspond to the parameter name used by the
in
property. Ifin
ispath
, thename
field MUST correspond to the named capture group from the configuredroute
.
-
boolean required
Determines whether this parameter is mandatory.
-
string Must be one of:
label
,form
,matrix
,simple
,spaceDelimited
,pipeDelimited
,deepObject
Required when
schema
andexplode
are set. Describes how the parameter value will be deserialized depending on the type of the parameter value.
-
boolean
Required when
schema
andstyle
are set. Whenexplode
istrue
, parameter values of typearray
orobject
generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters, this property has no effect.
-
string
Requred when
style
andexplode
are set. This is the schema defining the type used for the parameter. It is validated usingdraft4
for JSON Schema draft 4 compliant validator. In addition to being a valid JSON Schema, the parameter schema MUST have a top-leveltype
property to enable proper deserialization before validating.
-
-
boolean required default:
false
If enabled, the plugin returns more verbose and detailed validation errors.
-
boolean required default:
true
Determines whether to enable parameters validation of request content-type.
-