如何使 json-schema 允许一个但不允许另一个字段？

Question

是否可以使jsonschema 仅具有两个字段之一。

例如，如果我想要一个 JSON 和 ether start_dt 或 end_dt 的图像，但不能同时使用它们。像这样：

好的

{
    "name": "foo",
    "start_dt": "2012-10-10"
} 

好的

{
    "name": "foo",
    "end_dt": "2012-10-10"
} 

不行

{
    "name": "foo",
    "start_dt": "2012-10-10"
    "end_dt": "2013-11-11"
} 

我应该在架构中添加什么：

{ 
    "title": "Request Schema",
    "type": "object",
    "properties": {
        "name": 
            {   
                "type": "string"
            },  
        "start_dt": 
            {
                "type": "string",
                "format": "date"

            },
        "end_dt":
            {
                "type": "string",
                "format": "date"
            }
    }
}

Answer 1

您可以使用oneOf 来表达这一点。这意味着数据必须与恰好匹配一个提供的子模式，但不能超过一个。

将此与required 结合起来，此架构表示实例必须定义start_dt，或定义end_dt - 但如果它们同时包含两者，则无效：

{
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "start_dt": {"type": "string", "format": "date"},
        "end_dt": {"type": "string", "format": "date"}
    },
    "oneOf": [
        {"required": ["start_dt"]},
        {"required": ["end_dt"]}
    ]
}

带有三个示例的在线演示：

• OK
• OK
• NOT OK