JSON schema - how to specify permutations of required properties

Question

Below is an extract from my JSON schema.

I want to specify that both algorithm and results are required.

Additionally I want to specify:

when algorithm is algorithm1, then results must be one of results1, results2, or results3.
when algorithm is algorithm2, then results must be one of results2, results3, or results4.

Is this possible?

        "algorithm": {
            "description": "description...",
            "type": "string",
            "enum": [
                "",
                "algorithm1",
                "algorithm2"
            ]
        },
        "results": {
            "description": "description...",
            "type": "string",
            "enum": [
                "",
                "results1",
                "results2",
                "results3",
                "results4"
            ]
        },
     "required": ["algorithm", "results"]

Enforcing schemas depending on enum values can be done as suggested here: stackoverflow.com/questions/18375506/… — jruizaranguren
– jruizaranguren, Commented Apr 1, 2015 at 8:33
Thanks @jruizaranguren. I was able to figure it out from your helpful link. — ksl
– ksl, Commented Apr 1, 2015 at 13:08

ksl · Accepted Answer · 2015-04-01 13:07:33Z

Thanks to the reference above from @jruizaranguren, I was able to figure it out.

"required": ["results"],
"results": {
    "type": "object",
    "oneOf": [
        { "$ref": "#/definitions/Results1" },
        { "$ref": "#/definitions/Results2" }
    ]
},
"definitions": {
    "Results1": {
        "type": "object",
        "required": ["algorithm", "results"],
        "properties": {
            "algorithm": {
                "type": "string",
                "enum": [ "algorithm1" ]
            },
            "results": {
                "type": "string",
                "allOf": [
                    { "result": "results1" },
                    { "result": "results2" },
                    { "result": "results3" }
                ]
            }
        }
    },
    "Results2": {
        "type": "object",
        "required": ["algorithm", "results"],
        "properties": {
            "algorithm": {
                "type": "string",
                "enum": [ "algorithm2" ]
            },
            "results": {
                "type": "string",
                "allOf": [
                    { "result": "results2" },
                    { "result": "results3" },
                    { "result": "results4" }
                ]
            }
        }
    }

Collectives™ on Stack Overflow

JSON schema - how to specify permutations of required properties

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related