make jsonSchema enum attribute conditionally required with useful error message

Question

I might be doing this wrong because the error message is not helpful- even though this "works"

I have an enum (field1) that can be aaa or bbb

If its aaa then field2 must be required. If its not aaa then field2 can be optional

I have this now

"anyOf": [
    {
        "properties": {
            "field1": {
                "const": "aaa"
            }
        },
        "required": [
            "field2"
        ]
    },
    {
        "properties": {
            "field1": {
                "const": "bbb"
            }
        }
    }
]

But this is the error I get if field1 = aaa and field2 is not specified:

E           jsonschema.exceptions.ValidationError: 'bbb' was expected
E           
E           Failed validating 'const' in schema[1]['properties']['field1']:
E               {'const': 'bbb'}
E           
E           On instance['httpMethod']:
E               'aaa'

I was expecting an error more like "field2" expected because schema[1]['properties']['field1'] == bbb

Am I using this incorrectly?

Can you share the JSON instance that you're trying to validate? — gregsdennis, Mar 09 '20 at 03:24
Does this answer your question? [jsonSchema attribute conditionally required](https://stackoverflow.com/questions/38717933/jsonschema-attribute-conditionally-required) — Relequestual, Mar 10 '20 at 10:07
Does this answer your question? [best way to make conditional arrays in json schema with decent error messages](https://stackoverflow.com/questions/59976752/best-way-to-make-conditional-arrays-in-json-schema-with-decent-error-messages) — Jason Desrosiers, Mar 11 '20 at 19:45

score 2 · Accepted Answer · answered Mar 28 '20 at 21:36

If you are using >= draft-07, I guess if-then(-else) will give you the best error in your case.

from jsonschema import Draft7Validator

schema = {
    "type": "object",
    "properties": {
        "field1": {
            "enum": [
                "aaa",
                "bbb"
            ]
        },
        "field2": {
            "type": "string"
        }
    },
    "if": {
        "properties": { "field1": { "const": "aaa" } }
    },
    "then": {
        "required": [ "field2" ]
    }
}

obj = {
    "field1": "aaa",
}

Draft7Validator(schema).validate(obj)

It will generate the error:

Traceback (most recent call last):
  File "error.py", line 28, in <module>
    Draft7Validator(schema).validate(obj)
  File "(...)/jsonschema/validators.py", line 353, in validate
    raise error
jsonschema.exceptions.ValidationError: 'field2' is a required property

Failed validating 'required' in schema['if']['then']:
    {'required': ['field2']}

On instance:
    {'field1': 'aaa'}

make jsonSchema enum attribute conditionally required with useful error message

1 Answers1