结合两个JSON模式对象的属性

Question

I am writing some JSON schemas that have some objects with shared properties.

in JSON schema 1:

...
"properties": {
    "someProperty": {
        "type": "object",
        "required": [
            "propertyA",
            "propertyB",
            "propertyC",
        ],
        "additionalProperties": false,
        "properties": {
            "propertyA": {
                "type": "integer"
            },
            "propertyB": {
                "type": "integer"
            },
            "propertyC": {
                "type": "integer"
            }
        }
    }
}
...

in JSON schema 2:

...
"properties": {
    "someProperty": {
        "type": "object",
        "required": [
            "propertyD",
            "propertyB",
            "propertyC",
        ],
        "additionalProperties": false,
        "properties": {
            "propertyD": {
                "type": "integer"
            },
            "propertyB": {
                "type": "integer"
            },
            "propertyC": {
                "type": "integer"
            }
        }
    }
}
...

So the only difference between those two objects ( someProperty ) is the propertyA vs. propertyD .

Therefore, I decided to make a common JSON schema that will contain a definition for those two shared properties, propertyB and propertyC .

One solution was to have a definition of an object in the common schema that would contain those two properties, but I wanted my JSON to have those three properties at the same level (flat, unwrapped), and not like this:

"someProperty": {
    "propertyA": 2,
    "sharedObject": {
        "propertyB": 3,
        "propertyC": 4
    }
}

Is what I want possible? I want to end up with something that would enable my JSON to be valid like this:

"someProperty": {
    "propertyA": 2,
    "propertyB": 3,
    "propertyC": 4
}

and:

"someProperty": {
    "propertyD": 2,
    "propertyB": 3,
    "propertyC": 4
}

With all of these properties as required and no additionalProperties allowed.

Answer 1

You can achieve this with oneOf . oneOf is an exclusive OR statement. One or the other of "propertyA" or "propertyD" and not both can be present at the same time.

{
  "type": "object",
  "properties": {
    "someProperty": {
      "type": "object",
      "properties": {
        "propertyA": {
          "type": "integer"
        },
        "propertyB": {
          "type": "integer"
        },
        "propertyC": {
          "type": "integer"
        },
        "propertyD": {
          "type": "integer"
        }
      },
      "required": ["propertyB", "propertyC"],
      "oneOf": [
        { "required": ["propertyA"] },
        { "required": ["propertyD"] }
      ],
      "additionalProperties": false
    }
  }
}