Skip to main content
Version: 8.2511.x.x RR

OpenApiValidationFilter

The OpenApiValidationFilter validates an incoming request against a configured OpenAPI definition file.

Classname
ch::nevis::nevisproxy::filter::validation::OpenApiValidationFilter
Library
libValidationFilters.so.1

Configuration​

DefinitionFile​

Type: String
Usage Constraint: required

Filename of the OpenAPI definition file.

BlockOnError​

Type: Enum
Possible values: on, off, log
Usage Constraint: optional, conditions are allowed
Supported pragmas: break
Default: on

This parameter defines a list of conditions. The conditions determine for which requests the system must perform a OpenAPI validation. Furthermore, the parameter specifies what to do if the request does not contain valid OpenAPI data.

  • on: the request will be blocked returning the configured StatusCode
  • log: the request will not be blocked but an error (error code [VALD,0114]) will be traced
  • off: no OpenAPI validation will be done. The request will nto be blocked.

StatusCode​

Type: Integer
Range: min: 1, max: 999 Usage Constraint: optional
Default: 403

Defines which HTTP status code should be sent back to the client, in case the request is blocked.