JSONSchema - 依赖于父属性的必需属性

Question

我想根据根架构中是否存在属性，在数组子架构中应用额外的“必需”属性。我的架构设置如下：

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "required":[
       "isParentDependency",
       "subArray"
    ],
    "properties": {
        "isParentDependency": {
            "$id": "#/properties/isParentDependency",
            "type": "boolean"
        },
        "subArray": {
            "$id": "#/properties/subArray",
            "type": "array",
            "items": {
                "$id": "#/properties/subArrayItem",
                "required": ["alwaysRequiredProp"],
                "dependencies": {
                    "isParentDependency":{
                        "required":["requiredPropIfIsParentDependency"]
                    }
                },
                "properties": {
                    "alwaysRequiredProp": {
                        "$id": "#/properties/subArray/items/properties/alwaysRequiredProp",
                        "type": "boolean"
                    },
                    "requiredPropIfIsParentDependency": {
                        "$id": "#/properties/subArray/items/properties/requiredPropIfIsParentDependency",
                        "type": "boolean"
                    }
                }
            }
        }
    }
}

通过案例

{
    "isParentDependency": false,
    "subArray": [{
        "alwaysRequiredProp": true
    }]
}

    "isParentDependency": true,
    "subArray": [{
        "alwaysRequiredProp": true,
        "requiredPropIfIsParentDependency":true
    }]
}

失败案例

{
    "isParentDependency": true,
    "subArray": [{
        "alwaysRequiredProp": true
    }]
}

显然这行不通，但我一直无法弄清楚如何创建指向根架构的指针（或使用 $ref 应用 if/else 类型的解决方案）

非常感谢任何指导！

Answer 1

使用 JSON Schema，嵌套在树下的每一层 properties 都看不到树上。因此，您必须在它需要查看的最顶层定义您的条件。在这种情况下，这是根级别。

看看这个架构。

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "definitions": {
    "subArray": {
      "type": "array",
      "items": {
        "required": [
          "alwaysRequiredProp"
        ],
        "properties": {
          "alwaysRequiredProp": {
            "type": "boolean"
          },
          "requiredPropIfIsParentDependency": {
            "type": "boolean"
          }
        }
      }
    }
  },
  "required": [
    "isParentDependency",
    "subArray"
  ],
  "properties": {
    "isParentDependency": {
      "type": "boolean"
    },
    "subArray": {
      "$ref": "#/definitions/subArray"
    }
  },
  "if": {
    "properties": {
      "isParentDependency": {
        "const": true
      }
    }
  },
  "then": {
    "properties": {
      "subArray": {
        "items": {
          "required": [
            "requiredPropIfIsParentDependency"
          ]
        }
      }
    }
  }
}

subArray 已被移动到定义中，然后被引用，因此可以更轻松地查看条件应用程序逻辑。

subArray 的定义只决定了items 结构的属性，如果提供的话，需要alwaysRequiredProp。它不需要requiredPropIfIsParentDependency。

使用if 和then 关键字进入条件应用程序。

如果if 架构为真，则应用else 架构。

if 的值是一个模式。它适用于根级别。它要求 isParentDependency 是 true （它不需要属性本身，因为这始终是必需的。在 if 语句中要求属性并不意味着始终需要该属性，除非 else 是 false，但是我们甚至没有在这里使用else）。

当isParentDependency 为true 时，应用then 架构，该架构向下查找subArray 的项目，需要requiredPropIfIsParentDependency。

您可以使用jsonschema.dev（预加载此架构和您的失败​​实例）在浏览器中测试此功能。