CODEWITHSUNDEEP
jsonschema
begie
begie

Reputation: 1284

Is XML Schema xs:alternative equivalent available in JSON Schema?

Is it possible to use alternatives in JSON Schema? In XSD this is doable using xs:alternative element.

For example see: How to use alternatives in XML Schema 1.1

UPDATE 1:

This is a sample JSON I would like to describe using JSON schema:

{
  "actions": [
    {
      "type": "basic",
      "param1": "value"
    },
    {
      "type": "extended",
      "param1": "value",
      "param2": "blah"
    }
  ]
}

Requirements:

Upvotes: 4

Views: 2187

Answers (1)

jruizaranguren
jruizaranguren

Reputation: 13607

There is a similar mechanism since Draft04 with nicer semantics: oneOf, anyOf, allOf and not, keywords.

  • oneOf: enforce a given element to satisfy only one of a list of schemas.
  • anyOf: must satisfy at least one of a list of schemas.
  • allOf: must satisfy all provided schemas in list.
  • not: must not satisfy a given schema.

Assuming you are looking for an exclusive "alternative", this would be an example of json-schema using oneOf:

{
    "actions" : {
        "type" : "array",
        "items" : {
            "oneOf" : [{
                    " $ref " : "#/definitions/type1 "
                }, {
                    " $ref " : "#/definitions/type2 "
                }
            ]

        }

    },
    " definitions " : {
        " type1 " : {
            " type " : " object ",
                        "properties": {
                                  "param1":{"type":"string"}
                        },
                        "required":["param1"]
        },
        " type2 " : {
            " type " : " object ",
                         "properties": {
                                  "param2":{"type":"string"},
                                  "param3":{"type":"string"}
                        },
                         "required":["param2","param3"]
        }
    }
}

Upvotes: 3

Related Questions