Support custom vocabularies and unknown keyword and meta-schema handling

[justin-tay]

Closes #977, closes #829

This adds support for customizing

• Custom vocabularies
• Unknown keyword handling
• Unknown meta-schema handling

This contains breaking changes in how custom meta-schemas are created and the documentation updates assume it will be released as 1.4.0.

JsonSchemaFactory

• The following were renamed on JsonSchemaFactory builder
  • defaultMetaSchemaURI -> defaultMetaSchemaIri
  • enableUriSchemaCache -> enableSchemaCache
• The builder now accepts a JsonMetaSchemaFactory 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

• In particular Version201909 and Version202012 had most of the keywords moved to their respective vocabularies.
• The following were renamed
  • getUri -> getIri
• The builder now accepts a vocabularyFactory to allow for custom vocabularies.
• The builder now accepts a 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.
• The implementation of the builder now correctly throws an exception for $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.
• The applicable VersionCode for each of the ValidatorTypeCode were modified to remove the keywords that are defined in vocabularies for Version201909 and Version202012.

Vocabulary

• This now contains 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.
• The following were renamed
  • getId -> getIri

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 85.71429% with 48 lines in your changes are missing coverage. Please review.

Project coverage is 78.51%. Comparing base (fed46cf) to head (42cbbe5).

Files	Patch %	Lines
...main/java/com/networknt/schema/JsonMetaSchema.java	72.97%	17 Missing and 3 partials ⚠️
...n/java/com/networknt/schema/JsonSchemaFactory.java	73.33%	5 Missing and 7 partials ⚠️
...ain/java/com/networknt/schema/AbstractKeyword.java	18.18%	9 Missing ⚠️
...networknt/schema/DefaultJsonMetaSchemaFactory.java	88.88%	0 Missing and 3 partials ⚠️
src/main/java/com/networknt/schema/Vocabulary.java	57.14%	3 Missing ⚠️
...tworknt/schema/format/BaseFormatJsonValidator.java	66.66%	0 Missing and 1 partial ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #980      +/-   ##
============================================
- Coverage     78.64%   78.51%   -0.13%     
- Complexity     1852     1866      +14     
============================================
  Files           165      169       +4     
  Lines          6002     6088      +86     
  Branches       1148     1153       +5     
============================================
+ Hits           4720     4780      +60     
- Misses          845      871      +26     
  Partials        437      437              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rishabh413]

Hi @justin-tay

Will this also fix #475 (comment) ?

[justin-tay]

Hi @justin-tay

Will this also fix #475 (comment) ?

That should already have been fixed as it has nothing to do with implementing custom vocabularies. That issue has to do with the lack of support for $dynamicRef which was fixed in

• Support Draft 2020-12 and refactor schema retrieval #931

[rishabh413]

It did, thanks!!