json - 使用 JSON Schema 验证另一个属性

Question

在下面的模型中，仅当“detail”数组为空时才需要“category_id”属性。

如果“detail”数组不为空，则不需要“category_id”属性。

如何使用 JSON Schema 做到这一点？

{
    "description": "Expense model validation.",
    "type": "object",
    "properties": {
        "description": {
            "type": "string"
        },
        "category_id": {
            "type": "string"
        },
        "detail": {
            "type": "array",
            "items": {
                "description": "Expense detail",
                "type": "object",
                "properties": {
                    "description": {
                        "type": "string"
                    }
                },
                "required": [ "description" ]
            }
        }
    },
    "required": [ "description", "category_id" ]
}

Answer 1

您可以使用anyOf来检查其中一个category_id是否存在，或者detail是否存在并且至少有一个项目。

{
  "description": "Expense model validation.",
  "type": "object",
  "properties": {
    "description": { "type": "string" },
    "category_id": { "type": "string" },
    "detail": {
      "type": "array",
      "items": {
        "description": "Expense detail",
        "type": "object",
        "properties": {
          "description": { "type": "string" }
        },
        "required": ["description"]
      }
    }
  },
  "required": ["description"],
  "anyOf": [
    { "required": ["category_id"] },
    {
      "properties": {
        "detail": { "minItems": 1 }
      },
      "required": ["detail"]
    }
  ]
}