When using JSON Schema for validation, it is not recursively validate child entities?

Question

When using the following schema

{
    "$schema": "http://json-schema.org/schema#",
    "definitions":{
        "entity": {
            "type": "object",
            "properties": {
                "parent": {"type": ["null","string"]},
                "exclude": {"type": "boolean"},
                "count": {"type": ["null","integer"]},
                "EntityType": {"type": "string"},
                "Children": {
                    "type": "array",
                    "items": {"$ref":"#/definitions/entity"}
                }
            }
        }
    },
    "required": ["parent","EntityType","count"]
}

On this provided body of JSON

{
    "parent": "null",
    "EntityType": "test",
    "count": "null",
    "Children": [
        {
            "EntityType": "test",
            "count": 3
        },
        {
            "EntityType": "test"
        }
    ],
    "Extra": "somevalue"
}

It should be returning that I have provided an invalid Json object, however it does not seem to be doing so.

That said, if I were to have the root node not succeed (by removing one of the required fields) the validation works and says that I haven't provided a required field. Is there a reason that I am not able to validate the json recursively?

I think you could do the trick with https://www.npmjs.com/package/great-json-validator — Carlino Gonzalez, Oct 13 '21 at 17:16

score 2 · Accepted Answer · answered Mar 06 '19 at 22:18

2

It looks like you want parent, EntityType, and count to be required properties of the entity definition. However they're only required at the root, not the entity level. I would suggest that you move the required keyword into the entity definition, then reference the definition as part of an allOf to ensure the root is compliant.

{
    "$schema": "http://json-schema.org/schema#",
    "definitions":{
        "entity": {
            "type": "object",
            "properties": {
                "parent": {"type": ["null","string"]},
                "exclude": {"type": "boolean"},
                "count": {"type": ["null","integer"]},
                "EntityType": {"type": "string"},
                "Children": {
                    "type": "array",
                    "items": {"$ref":"#/definitions/entity"}
                }
            },
            "required": ["parent","EntityType","count"]
        }
    },
    "allOf": [{"$ref": "#/definitions/entity"}]
}

answered Mar 06 '19 at 22:18

gregsdennis

7,218
3
38
71

1

Assuming this is draft-7, in the next version of JSON Schema (draft-8), you won't need to wrap the $ref in an `allOf`, although currently you do. – Relequestual Mar 07 '19 at 08:37
1

Great this solution did exactly what I need. Thank you for clarifying how I could use AllOf to validate recursively! – Ryan Lynar Mar 07 '19 at 18:06
@relequestual a solution is needed **now** [slams fist on desk] :) – gregsdennis Mar 07 '19 at 18:34
@gregsdennis quiet you! =] – Relequestual Mar 08 '19 at 09:07

When using JSON Schema for validation, it is not recursively validate child entities?

1 Answers1