JSON Schema links

[ghost]

Hello,

I'm using your library and i'm looking for how to deal with "links" keywords in my JSON Schema.
This links keyword is DRAFT V4 compliant, however a warning is thrown :

warning: the following keywords are unknown and will be ignored: [links]
level: "warning"
schema: {"loadingURI":"#","pointer":""}
domain: "syntax"
ignored: ["links"]

Please can anyone help?

[fge]

Hello,

Which version are you using?

[ghost]

Hello I'm currently using version 2.0.1

[fge]

Ah, that explains it.

Syntax support, by default in 2.0.x, only covers validation, not the hyperschema. Therefore syntax checking for links is not supported.

In 2.1.x, it is supported, although not completely: draft v3 is not supported, and draft v4 href is valid only as long as they are "true" URI templates, as the RFC defines them (see https://github.com/fge/uri-template).

It is possible to backport this to 2.0.x, but the cost is heavy; and in any case, link generation is not supported. How much do you care about links syntax validation?

[ghost]

Thanks for the explanation.
Is it possible to remove the warning message from the report?

[fge]

It is, but there is a preliminary condition to this: do you have a $schema declared into your schemas?

[ghost]

Yes I do my json schema is valid. I have declared it.
I want also remove the warning message for readOnly which is also included

[fge]

OK, that may be part of the problem here; what is $schema set to?

[ghost]

Here is the URL provided: http://json-schema.org/draft-04/hyper-schema#

[fge]

Hmm, OK, this can be viewed as a bug. In 2.0.x as well as in 2.1.x.

In both of these versions, when an unknown $schema is encountered, the default schema will be whatever is configured to be the default schema. In your case, that will be http://json-schema.org/draft-04/schema#, and the keywords defined by that schema. And there are no hyperschema validation keywords in there...

Working around this will require quite some amount of code. Here is how...

Step 1: define a new keyword for links:

final Keyword links = Keyword.newBuilder("links")
    .withSyntaxChecker(new SyntaxChecker()
    {
        @Override
        public void checkSyntax(final Collection<JsonPointer> pointers,
            final ProcessingReport report, final SchemaTree tree)
        {
        }
    }).freeze();

Step 2: build a new library based on draft v4, change the $schema of that library and add the new keyword:

// see above for "links"
final Library customLibrary = DraftV4Library.get().thaw()
    .addKeyword(links).freeze();

Step 3: create a new ValidationConfiguration, add this library to it:

final ValidationConfiguration cfg = ValidationConfiguration.newBuilder()
    .setDefaultLibrary("http://json-schema.org/draft-04/hyper-schema#", customLibrary)
    .build();

Step 4: build your JsonSchemaFactory using this library:

final JsonSchemaFactory factory = JsonSchemaFactory.newBuilder()
    .setValidationConfiguration(cfg).build();

You can then use this factory to create your JsonSchemas and the warnings should no longer appear.

[fge]

Closing this one. Hyper schema syntax validation (only syntax validation) will be in 2.2.

[Philzen]

Hi @fge,

really enjoy discovering the project but i'm slightly confused: I'm am getting exactly the error described when testing on http://json-schema-validator.herokuapp.com/

readme.md states version 2.2.5 is current - while the latest git tag is at 2.2.4 - and i'm struggling to any the version number under the demo link... so is this still an open bug in 2.2 or is the deployment just running an older version?

[muditsri]

I am using version: 2.3.8 but still getting warnings: warning: the following keywords are unknown and will be ignored: [elementName]

What i did: Had the XSD, which i converted into JsonSchema, and i believe this conversion is an issue.
Does anyone have idea on how to convert XSD to JsonSchema, so that its supported in version 2.3.8