Validate

Validate request

Table 1. Supported parameters
Parameter Required Data type Details
inputMessage Yes string The input must be specified. Input must be parsed if the message body is to be validated. It is not necessary to parse if content-type, request parameters, or response headers are the only things being validated.
mode Yes object Validate the input based on the OpenAPI schema specified for the response
Table 2. Options for mode
Parameter Required Data type Details
request Yes object Validate the input based on the OpenAPI schema specified for the request. Always returns BAD_REQUEST if not valid.
response Yes object Validate the input based on the OpenAPI schema specified for the response. Always returns INTERNALSERVERERROR if not valid.
openApiSchemaRef Yes object Validate the input based on the specified OpenAPI schema in #/components/schemas. Can be configured to return BADREQUEST or INTERNALSERVER_ERROR.
file Yes object Validate the input based on the file specified. Can be configured to return BADREQUEST or INTERNALSERVER_ERROR.
Table 3. Nested properties inside request
Parameter Required Data type Details
contentType No boolean Enable content-type header validation
cookie No boolean Enable cookie parameter validation
header No boolean Enable header parameter validation
path No boolean Enable path parameter validation
query No boolean Enable query parameter validation
schema No object Specify configuration for message body validation
Table 4. Nested properties inside schema
Parameter Required Data type Details
validateSchema Yes boolean Indicates whether the message body should be validated against the defined schema
Table 5. Nested properties inside response
Parameter Required Data type Details
contentType No boolean Enable content-type header validation
header No boolean Enable response header validation
schema No object Specify configuration for message body validation
Table 6. Nested properties inside openApiSchemaRef
Parameter Required Data type Details
failureStatusCode Yes enum (of string) Choose between BADREQUEST or INTERNALSERVER_ERROR for validation failures. Must be 400 or 500.
reference Yes string Must be a reference within #/components/schemas
Table 7. Nested properties inside file
Parameter Required Data type Details
failureStatusCode Yes enum (of string) Choose between BADREQUEST or INTERNALSERVER_ERROR for validation failures. Must be 400 or 500.
moduleRef Yes object Specify a file to use as the schema for validation. Same as Table 5.