This library can contain breaking changes in minor version releases.
This contains information on the notable or breaking changes in each version.
This contains breaking changes
When using the walker with defaults the default across a $ref are properly resolved and used.
The behavior for the property listener is now more consistent whether or not validation is enabled. Previously if validation is enabled but the property is null the property listener is not called while if validation is not enabled it will be called. Now the property listener will be called in both scenarios.
The following are the breaking changes to those using the walk functionality.
WalkEvent | Field | Change | Notes |--------------------------|--------------|---------- | schemaLocation | Removed | For keywords: getValidator().getSchemaLocation(). For items and properties: getSchema().getSchemaLocation() | evaluationPath | Removed | For keywords: getValidator().getEvaluationPath(). For items and properties: getSchema().getEvaluationPath() | schemaNode | Removed | getSchema().getSchemaNode() | parentSchema | Removed | getSchema().getParentSchema() | schema | New | For keywords this is the parent schema of the validator. For items and properties this is the item or property schema being evaluated. | node | Renamed | instanceNode | currentJsonSchemaFactory| Removed | getSchema().getValidationContext().getJsonSchemaFactory() | validator | New | The validator indicated by the keyword.
The following are the breaking changes in how custom meta-schemas are created.
JsonSchemaFactory
JsonSchemaFactory builderdefaultMetaSchemaURI -> defaultMetaSchemaIrienableUriSchemaCache -> enableSchemaCacheJsonMetaSchemaFactory which can be used to restrict the loading of meta-schemas that aren't explicitly defined in the JsonSchemaFactory. The DisallowUnknownJsonMetaSchemaFactory can be used to only allow explicitly configured meta-schemas.JsonMetaSchema
Version201909 and Version202012 had most of the keywords moved to their respective vocabularies.getUri -> getIrivocabularyFactory to allow for custom vocabularies.unknownKeywordFactory. By default this uses the UnknownKeywordFactory implementation that logs a warning and returns a AnnotationKeyword. The DisallowUnknownKeywordFactory can be used to disallow the use of unknown keywords.$vocabulary with value of true that are not known to the implementation.ValidatorTypeCode
getNonFormatKeywords has been removed and replaced with getKeywords. This now includes the format keyword as the JsonMetaSchema.Builder now needs to know if the format keyword was configured, as it might not be in meta-schemas that don't define the format vocabulary.VersionCode for each of the ValidatorTypeCode were modified to remove the keywords that are defined in vocabularies for Version201909 and Version202012.Vocabulary
Keyword instances instead of the string keyword value as it needs to know the explicit implementation. For instance the implementation for the items keyword in Draft 2019-09 and Draft 2020-12 are different.getId -> getIriThis contains a breaking change in that the results from failFast are no longer thrown as an exception. The single result is instead returned normally in the output. This was partially done to distinguish the fail fast result from true exceptions such as when references could not be resolved.
The following keywords were refactored to improve performance and meet the functional requirements.
In particular this converts the unevaluatedItems and unevaluatedProperties validators to use annotations to perform the evaluation instead of the current mechanism which affects performance. This also refactors $recursiveRef to not rely on that same mechanism.
unevaluatedPropertiesunevaluatedItemspropertiespatternPropertiesitems / additionalItemsprefixItems / itemscontains$recursiveRefThis also fixes the issue where the unevaluatedItems keyword does not take into account the contains keyword when performing the evaluation.
This also fixes cases where anyOf short-circuits to not short-circuit the evaluation if a adjacent unevaluatedProperties or unevaluatedItems keyword exists.
This should fix most of the remaining functional and performance issues.
| Implementations | Overall | DRAFT_03 | DRAFT_04 | DRAFT_06 | DRAFT_07 | DRAFT_2019_09 | DRAFT_2020_12 |
|---|---|---|---|---|---|---|---|
| NetworkNt | pass: r:4703 (100.0%) o:2369 (100.0%) fail: r:0 (0.0%) o:1 (0.0%) | pass: r:600 (100.0%) o:251 (100.0%) fail: r:0 (0.0%) o:0 (0.0%) | pass: r:796 (100.0%) o:318 (100.0%) fail: r:0 (0.0%) o:0 (0.0%) | pass: r:880 (100.0%) o:541 (100.0%) fail: r:0 (0.0%) o:0 (0.0%) | pass: r:1201 (100.0%) o:625 (100.0%) fail: r:0 (0.0%) o:0 (0.0%) | pass: r:1226 (100.0%) o:634 (99.8%) fail: r:0 (0.0%) o:1 (0.2%) |
Benchmark Mode Cnt Score Error Units NetworkntBenchmark.testValidate thrpt 10 6776.693 ± 115.309 ops/s NetworkntBenchmark.testValidate:·gc.alloc.rate thrpt 10 971.191 ± 16.420 MB/sec NetworkntBenchmark.testValidate:·gc.alloc.rate.norm thrpt 10 165318.816 ± 0.459 B/op NetworkntBenchmark.testValidate:·gc.churn.G1_Eden_Space thrpt 10 968.894 ± 51.234 MB/sec NetworkntBenchmark.testValidate:·gc.churn.G1_Eden_Space.norm thrpt 10 164933.962 ± 8636.203 B/op NetworkntBenchmark.testValidate:·gc.churn.G1_Survivor_Space thrpt 10 0.002 ± 0.001 MB/sec NetworkntBenchmark.testValidate:·gc.churn.G1_Survivor_Space.norm thrpt 10 0.274 ± 0.218 B/op NetworkntBenchmark.testValidate:·gc.count thrpt 10 89.000 counts NetworkntBenchmark.testValidate:·gc.time thrpt 10 99.000 ms
Benchmark Mode Cnt Score Error Units EveritBenchmark.testValidate thrpt 10 3719.192 ± 125.592 ops/s EveritBenchmark.testValidate:·gc.alloc.rate thrpt 10 1448.208 ± 74.746 MB/sec EveritBenchmark.testValidate:·gc.alloc.rate.norm thrpt 10 449621.927 ± 7400.825 B/op EveritBenchmark.testValidate:·gc.churn.G1_Eden_Space thrpt 10 1446.397 ± 79.919 MB/sec EveritBenchmark.testValidate:·gc.churn.G1_Eden_Space.norm thrpt 10 449159.799 ± 18614.931 B/op EveritBenchmark.testValidate:·gc.churn.G1_Survivor_Space thrpt 10 0.001 ± 0.001 MB/sec EveritBenchmark.testValidate:·gc.churn.G1_Survivor_Space.norm thrpt 10 0.364 ± 0.391 B/op EveritBenchmark.testValidate:·gc.count thrpt 10 133.000 counts EveritBenchmark.testValidate:·gc.time thrpt 10 148.000 ms
This adds support for Draft 2020-12
This adds support for the following keywords
$dynamicRef$dynamicAnchor$vocabularyThis refactors the schema retrieval codes as the ID is based on IRI and not URI.
Note that Java does not support IRIs. See https://cr.openjdk.org/%7Edfuchs/writeups/updating-uri/ for details.
The following are removed and replaced by SchemaLoader and SchemaMapper.
URIFactory - No replacement. The resolve logic is in AbsoluteIRI.URISchemeFactory - No replacement as URIFactory isn't required anymore.URISchemeFetcher - No replacement. The SchemaLoaders are iterated and called.URITranslator - Replaced by SchemaMapper.URLFactory - No replacement as URIFactory isn't required anymore.URLFetcher - Replaced by UriSchemaLoader.URNURIFactory - No replacement as URIFactory isn't required anymore.The SchemaLoader and SchemaMapper are configured in the JsonSchemaFactory.Builder. See Customizing Schema Retrieval.
As per the specification. The format keyword since Draft 2019-09 no longer generates assertions by default.
This can be changed by using a custom meta schema with the relevant $vocabulary or by setting the execution configuration to enable format assertions.
The following are a summary of the changes
JsonNodePath. The paths are instanceLocation, schemaLocation and evaluationPath. The meaning of these paths are as defined in the specification.JsonNodePath that is typically a JSON pointerat to instanceLocation. Note that for the required validator the error message instanceLocation does not point to the missing property to be consistent with the specification. The ValidationMessage now contains a property attribute if this is required.schemaPath to schemaLocation. This should generally be an absolute IRI with a fragment particularly in later drafts.evaluationPathJsonValidator
getSchemaLocation and getEvaluationPath in the interfaceschemaLocation and evaluationPathvalidate method uses JsonNodePath for the instanceLocationvalidate method with just the rootNode has been removedJsonSchemaWalker
walk method uses JsonNodePath for the instanceLocationWalkEvent
at to instanceLocationschemaPath to schemaLocationevaluationPathkeyWordName to keywordWalkListenerRunner
at to instanceLocationschemaPath to schemaLocationevaluationPathBaseJsonValidator
atPath methods are removed. Use JsonNodePath.append to get the path of the childbuildValidationMessage methods are removed. Use the message builder method instead.CollectorContext
evaluatedProperties and evaluatedItems are now Collection<JsonNodePath>JsonSchema
evaluationPath instead of schemaPath@deprecated constructor methods have been removedValidatorTypeCode
customMessage has been removed. This made the ValidatorTypeCode mutable if the feature was used as the enum is a shared instance. The logic for determining the customMessage has been moved to the validator.newValidator instances now uses a functional interface instead of reflection.ValidatorState
ValidatorState is now a property of the ExecutionContext. This change is largely to improve performance. The CollectorContext.get method is particularly slow for this use case.Removes use of ThreadLocal to store context and explicitly passes the context as a parameter where needed.
The following are the main API changes, typically to accept an ExecutionContext as a parameter
com.networknt.schema.JsonSchemacom.networknt.schema.JsonValidatorcom.networknt.schema.Formatcom.networknt.schema.walk.JsonSchemaWalkercom.networknt.schema.walk.WalkEventJsonSchema was modified to optionally accept an ExecutionContext for the validate, validateAndCollect and walk methods. For methods where no ExecutionContext is supplied, one is created for each run in the createExecutionContext method in JsonSchema.
ValidationResult was modified to store the ExecutionContext of the run which is also a means of reusing the context, by passing this context information from the ValidationResult to following runs.
Up to version 1.0.81, the dependency org.apache.commons:commons-lang3 was included as a runtime dependency. Starting with 1.0.82 it is not required anymore.