Enable structured validation errorsv3.15+
By default, validation errors are returned as a single flat string.
Enable structured_errors to receive errors in JSON Schema draft 2020-12 Output Structure,
with instanceLocation and keywordLocation fields for each error.
Use max_structured_errors to cap the number of errors returned.
Any errors over the cap are discarded.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: oas-validation
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: trueMake the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: oas-validation
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: true
plugin: oas-validation
" | kubectl apply -f -Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_oas_validation" "my_oas_validation" {
enabled = true
config = {
api_spec = "contents of entire API spec go here"
structured_errors = true
max_structured_errors = 10
verbose_response = true
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: oas-validation
service: serviceName|Id
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: trueMake sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
serviceId: Theidof the service the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: oas-validation
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: true
plugin: oas-validation
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=oas-validationPrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_oas_validation" "my_oas_validation" {
enabled = true
config = {
api_spec = "contents of entire API spec go here"
structured_errors = true
max_structured_errors = 10
verbose_response = true
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: oas-validation
route: routeName|Id
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: trueMake sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: oas-validation
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: true
plugin: oas-validation
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=oas-validationkubectl annotate -n kong ingress konghq.com/plugins=oas-validationPrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_oas_validation" "my_oas_validation" {
enabled = true
config = {
api_spec = "contents of entire API spec go here"
structured_errors = true
max_structured_errors = 10
verbose_response = true
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: oas-validation
consumer: consumerName|Id
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: trueMake sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "oas-validation",
"config": {
"api_spec": "contents of entire API spec go here",
"structured_errors": true,
"max_structured_errors": 10,
"verbose_response": true
},
"tags": []
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
consumerId: Theidof the consumer the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: oas-validation
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
api_spec: contents of entire API spec go here
structured_errors: true
max_structured_errors: 10
verbose_response: true
plugin: oas-validation
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=oas-validationPrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_oas_validation" "my_oas_validation" {
enabled = true
config = {
api_spec = "contents of entire API spec go here"
structured_errors = true
max_structured_errors = 10
verbose_response = true
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.id
}
}