Skip to content

Latest commit

 

History

History
47 lines (41 loc) · 10.1 KB

config.md

File metadata and controls

47 lines (41 loc) · 10.1 KB
Raw

Schema Validators Configuration

Name Description Default Value
applyDefaultsStrategy The strategy for applying defaults when walking when missing or null nodes are encountered. ApplyDefaultsStrategy.EMPTY_APPLY_DEFAULTS_STRATEGY
cacheRefs Whether the schemas loaded from refs will be cached and reused for subsequent runs. Setting this to false will affect performance but may be neccessary to prevent high memory usage for the cache if multiple nested applicators like anyOf, oneOf and allOf are used. true
discriminatorKeywordEnabled Whether the discriminator keyword is handled according to OpenAPI 3. false
errorMessageKeyword The keyword to use for custom error messages in the schema. If not set this features is disabled. This is typically set to errorMessage or message. null
executionContextCustomizer This can be used to customize the ExecutionContext generated by the JsonSchema for each validation run. null
failFast Whether to return failure immediately when an assertion is generated. false
formatAssertionsEnabled The default is to generate format assertions from Draft 4 to Draft 7 and to only generate annotations from Draft 2019-09. Setting to true or false will override the default behavior. null
javaSemantics Whether java semantics is used for the type keyword. false
locale The locale to use for generating messages in the ValidationMessage. Locale.getDefault()
losslessNarrowing Whether lossless narrowing is used for the type keyword. false
messageSource This is used to retrieve the locale specific messages. DefaultMessageSource.getInstance()
nullableKeywordEnabled Whether the nullable keyword is handled according to OpenAPI 3.0. This affects the enum and type keywords. false
pathType The path type to use for reporting the instance location and evaluation path. Set to PathType.JSON_PATH to use JSON Path. PathType.JSON_POINTER
preloadJsonSchema Whether the schema will be preloaded before processing any input. This will use memory but the execution of the validation will be faster. true
preloadJsonSchemaRefMaxNestingDepth The max depth of the evaluation path to preload when preloading refs. 40
readOnly Whether schema is read only. This affects the readOnly keyword. null
regularExpressionFactory The factory to use to create regular expressions for instance JoniRegularExpressionFactory or GraalJSRegularExpressionFactory. This requires the dependency to be manually added to the project or a ClassNotFoundException will be thrown. JDKRegularExpressionFactory.getInstance()
schemaIdValidator This is used to customize how the $id values are validated. Note that the default implementation allows non-empty fragments where no base IRI is specified and also allows non-absolute IRI $id values in the root schema. JsonSchemaIdValidator.DEFAULT
strict This is set whether keywords are strict in their validation. What this does depends on the individual validators.
typeLoose Whether types are interpreted in a loose manner. If set to true, a single value can be interpreted as a size 1 array. Strings may also be interpreted as number, integer or boolean. false
writeOnly Whether schema is write only. This affects the writeOnly keyword. null

How to use config

When you create a JsonSchema instance from the JsonSchemaFactory, you can pass an object of SchemaValidatorsConfig as the second parameter.

JsonSchemaFactory factory = JsonSchemaFactory.getInstance(VersionFlag.V202012);
SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().typeLoose(false).build();
JsonSchema schema = factory.getSchema(schema, config);

Details

Name Details
typeLoose When typeLoose is true, the validator will convert strings to different types to match the type defined in the schema. This is mostly used to validate the JSON request or response for headers, query parameters, path parameters, and cookies. For the HTTP protocol, these are all strings and might be defined as other types in the schema. For example, the page number might be an integer in the schema but passed as a query parameter in string. When it comes to validating arrays note that any item can also be interpreted as a size 1 array of that item so the item will be validated against the type defined for the array.
strict This is a map of keywords to whether the keyword's validators should perform a strict or permissive analysis. When strict is true, validators will perform strict checking against the schema. This is the default behavior. When set to false, validators are free to relax some constraints but not required. Each validator has its own understanding of what constitutes strict and permissive.
failFast When set to true, the validation process stops immediately when the first error occurs. This mostly used on microservices that is designed to fail-fast, or users don't want to see hundreds of errors for a big payload.
nullableKeywordEnabled When a field is set as nullable in the OpenAPI specification, the schema validator validates that it is nullable; however, it continues with validation against the nullable field. If nullableKeywordEnabled is set to true && incoming field is nullable && value is field: null --> succeed. If nullableKeywordEnabled is set to false && incoming field is nullable && value is field: null --> it is up to the type validator using the SchemaValidator to handle it.
javaSemantics When set to true, use Java-specific semantics rather than native JavaScript semantics. For example, if the node type is number per JS semantics where the value can be losslesly interpreted as java.lang.Long, the validator would use integer as the node type instead of number. This is useful when schema type is integer, since validation would fail otherwise.
losslessNarrowing When set to true, can interpret round doubles as integers. Note that setting javaSemantics = true will achieve the same functionality at this time.
pathType This defines how path expressions are defined and returned once validation is performed through ValidationMessage instances. This can either be set to PathType.JSON_POINTER for JSONPointer expressions, or to PathType.JSON_PATH for JSONPath expressions. Doing so allows you to report the path for each finding and to potentially lookup nodes (see here for an example).