diff --git a/app/_hub/kong-inc/oas-validation/overview/_index.md b/app/_hub/kong-inc/oas-validation/overview/_index.md index edfb0098d7a9..fa079e308543 100644 --- a/app/_hub/kong-inc/oas-validation/overview/_index.md +++ b/app/_hub/kong-inc/oas-validation/overview/_index.md @@ -2,9 +2,19 @@ nav_title: Overview --- -Validate HTTP requests and responses based on an API specification. -Supports both Swagger v2 and OpenAPI v3 specifications JSON request and response bodies, with support for schema definitions described using JSON Schema draft v4. -For JSON Schema draft 4 type schemas, see the [JSON Schema documentation](https://json-schema.org/) for details on the format and examples. +Validate HTTP requests and responses against an OpenAPI Specification. + + +{% if_version lte:3.6.x %} + +The plugin supports both Swagger (v2) and OpenAPI (3.0.x) specifications, with the support of JSON Schema [Draft-04](https://json-schema.org/specification-links#draft-4). + +{% endif_version %} +{% if_version gte:3.7.x %} + +The plugin supports both Swagger (v2) and OpenAPI (3.0.x and 3.1.0) specifications with a JSON Schema validator that supports [Draft 2019-09](https://json-schema.org/specification-links#draft-2019-09-(formerly-known-as-draft-8)). + +{% endif_version %} {% if_plugin_version gte:3.2.x %} {:.important .no-icon} @@ -23,6 +33,20 @@ To enable the plugin, use one of the following methods: {% endif_plugin_version %} +{% if_version gte:3.7.x %} + +## Supported OpenAPI 3.1.0 specification features + +| Category | Supported | Not supported | +|---------------------------------|--------------------------------|--------------------------------------------------------------------------| +| Request Body | `application/json` | `application/xml`
`multipart/form-data`
`text/plain`
`text/xml`
| +| Response Body | `application/json` | - | +| Request Parameters | `path`, `query`, `header`, `cookie` | - | +| Schema | `allOf`
`oneOf`
`anyOf`
| - | +| Parameter Serialization | `style`, `explode ` | - | + +{% endif_version %} + ## Tutorial This example tutorial steps you through ensuring an API request conforms to the associated API specification. This example uses the [sample Petstore spec](https://petstore.swagger.io/).