json-schema - allow for logical-OR in required properties

Question

An alternate title for this question would be "required property combinations".

Say I am working with a json-schema like so:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "JSON schema for NLU (npm-link-up) library.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "list", "packages", "deps"
  ],
   // ... 
}

what I want to do, is make one of "list", "packages", "deps", to be required. That is one, but no more than one, should be present.

So it might be something like:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "JSON schema for NLU (npm-link-up) library.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    {
      "min": 1,
      "max": 1,
      "selection":  ["list", "packages", "deps"]
    }
  ],
}

or

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "JSON schema for NLU (npm-link-up) library.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    {
      "operator": "or",
      "selection": ["list", "packages", "deps"]
    }
  ],
}

is this possible?

Jason Desrosiers · Accepted Answer · 2018-08-13T04:41:52.097

3

There are four boolean combinator keywords in JSON Schema:

allOf - AND
anyOf - OR
oneOf - XOR (eXclusive OR)
not - NOT

What you want can be done like this ...

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "JSON schema for NLU (npm-link-up) library.",
  "type": "object",
  "additionalProperties": false,
  "oneOf": [
    { "required": ["list"] },
    { "required": ["packages"] },
    { "required": ["deps"] }
  ]
}

edited Aug 13 '18 at 04:41

answered Aug 13 '18 at 03:15

Jason Desrosiers

22,479
5
47
53

are you sure that is the right syntax? what if I wanted more than one `"oneOf"`? – Alexander Mills Aug 13 '18 at 04:40
Oops, I fixed the syntax issue. Each item in the `oneOf` array should be a JSON Schema. – Jason Desrosiers Aug 13 '18 at 04:43
1

If you need more than one `oneOf`, you can use `allOf`. For example, `{ "allOf": [{ "oneOf": [...] }, { "oneOf": [...] }] }`. – Jason Desrosiers Aug 13 '18 at 04:44

json-schema - allow for logical-OR in required properties

1 Answers1