Unable to validate when schema contains references

[radarsh]

Hi,

I'm really struggling with this and any clues as to where I might be going wrong will be greatly appreciated.

I am trying to validate a YAML file using a custom JSON schema. However, my schema, test-schema.json references definitions from another file, base-schema.json. This is a common pattern which I have used a lot in the past to keep definitions re-usable. However, this is the first time I'm trying to programmatically validate using this library and facing issues.

test-schema.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.org/schemas/test-schema.json",
    "type": "object",
    "properties": {
        "test": {
            "allOf": [
                {
                    "$ref": "base-schema.json#/$defs/Definition"
                },
                {
                    "type": "object",
                    "properties": {
                        "three": {
                            "type": "string"
                        }
                    }
                }
            ],
            "additionalProperties": false
        }
    }
}

base-schema.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.org/schemas/base-schema.json",
    "$defs": {
        "Definition": {
            "type": "object",
            "properties": {
                "one": {
                    "type": "string"
                },
                "two": {
                    "type": "string"
                }
            }
        }
    }
}

Java test

public static void main(String[] args) throws Exception {
        var baseSchema = new String(new FileInputStream(new File("/path/to/base-schema.json")).readAllBytes());
        var testSchema = new String(new FileInputStream(new File("/path/to/test-schema.json")).readAllBytes());
        var inputData =
            """
                test:
                  one: string
                  two: string
                  three: string
                """;

        ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory());
        JsonNodeReader jsonNodeReader = JsonNodeReader.builder().yamlMapper(yamlMapper).build();
        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V202012,
            builder -> builder
                .jsonNodeReader(jsonNodeReader)
                .schemaLoaders(schemaLoaders -> schemaLoaders.schemas(Map.of(
                        "https://example.org/schemas/base-schema.json", baseSchema
                    ))
                    .add(DisallowSchemaLoader.getInstance()))
                .build());
        SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();

        JsonSchema schema = factory.getSchema(testSchema, InputFormat.YAML, config);
        Set<ValidationMessage> messages = schema.validate(inputData, InputFormat.YAML, executionContext -> {
            executionContext.getExecutionConfig().setFormatAssertionsEnabled(true);
        });

        messages.forEach(System.err::println);
    }

When I run the above, I simply get these errors:

/test: property 'one' is not defined in the schema and the schema does not allow additional properties
/test: property 'two' is not defined in the schema and the schema does not allow additional properties
/test: property 'three' is not defined in the schema and the schema does not allow additional properties

It's as if the validator isn't able to understand that the Definition definition is defined in another schema file and therefore the allOf is mysteriously failing.

Any help is appreciated. Thank you.

[justin-tay]

The additionalProperties keyword only checks properties in the same schema and does not look into sub schemas. You should consider using the unevaluatedProperties keyword instead.

[radarsh]

Thank you for the suggestion. I tried it and while it reduced the number of errors, I still had some errors from the top level schema. This seems to be a red herring if we have other problems with validation such as required constraints not matching. When the required property is added, the problem was going away.

I have enabled failFast to emulate the behaviour of IntelliJ IDEA for now and with this, I only get the correct errors.