JSON schema for object with either A and B or C required properties

Question

I have two possible JSON objects for one request:

{
  "from": "string",
  "to": "string",
  "text": "string"
}

or

{
  "number": "integer",
  "text": "string"
}

In both cases "text" property is optional. Other properties are required (either "number, or both "from" and "to").

What will be the correct JSON schema to validate this?

Possible duplicate of [JSON Schema: How do I require one field or another or (one of two others) but not all of them?](http://stackoverflow.com/questions/24023536/json-schema-how-do-i-require-one-field-or-another-or-one-of-two-others-but-no) — james.garriss, Mar 27 '17 at 16:20

score 15 · Accepted Answer · answered Jul 05 '16 at 22:56

15

Here is another solution that I think is a bit more clear. The dependencies clause ensures that "from" and "to" always come as a pair. Then the oneOf clause can be really simple and avoid the not-required boilerplate.

{
  "type": "object",
  "properties": {
    "from": { "type": "string" },
    "to": { "type": "string" },
    "number": { "type": "integer" },
    "text": { "type": "string" }
  },
  "dependencies": {
    "from": ["to"],
    "to": ["from"]
  },
  "oneOf": [
    { "required": ["from"] },
    { "required": ["number"] }
  ]
}

answered Jul 05 '16 at 22:56

Jason Desrosiers

22,479
5
47
53

Nice! Thanks a lot – Alexander Zhak Jul 05 '16 at 23:30
That's so ugly!... thought there will be better way to do it. maybe using refs like `type:"#from_to | #num_text"` – Tomer W Mar 08 '20 at 10:11

score 0 · Answer 2 · answered Jul 05 '16 at 17:27

Finally managed to build the correct scheme.

{
  "definitions": {
    "interval": {
      "type": "object",
      "properties": {
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        },
        "text": {
          "type": "string"
        }
      },
      "required": ["from", "to"],
      "not": {
        "required": ["number"]
      }
    },
    "top": {
      "type": "object",
      "properties": {
        "number": {
          "type": "integer"
        },
        "text": {
          "type": "string"
        }
      },
      "required": ["number"],
      "allOf": [
        {
          "not": {
            "required": ["from"]
          }
        },
        {
          "not": {
            "required": ["to"]
          }
        }
      ]

    }
  },
  "type": "object",
  "oneOf": [
    {"$ref": "#/definitions/interval"},
    {"$ref": "#/definitions/top"}
  ]
}

JSON schema for object with either A and B or C required properties

2 Answers2