AJV 架构验证错误

Question

我有如下输入 json，

{"contents":[{"type":"field"},{"type":"field","itemId":"594b9980e52b5b0768afc4e8"}]}

条件是，如果类型是 'field'，那么 'itemId' 应该是必填字段如果类型是 'fieldGroup' 或 'subSection'，那么 'itemId' 是可选的

这是我试过的 Json 模式，但它没有按预期工作，

"type": "object",
"additionalProperties": false,
"properties" : {
    "contents" : {
        "type" : "array",
        "items": {"$ref": "#displayItem" }
    }
},
"definitions": {
    "displayItem" : {
        "id": "#displayItem",
        "type": "object",
        "items": {
            "anyOf": [
                {"$ref": "#fieldType"},
                {"$ref": "#fieldGroupSubSectionType"}
            ]
        }
    },

    "fieldType" : {

        "id": "#fieldType",
        "type": "object",
        "additionalProperties": false,
        "properties": {
            "itemId": {
                "type": "string"
            },
            "type": {
                "type": "string",
                "enum": ["field"]
            }
        }

    },

    "fieldGroupSubSectionType" : {

        "id": "#fieldGroupSubSectionType",
        "type": "object",
        "additionalProperties": false,
        "properties": {
            "itemId": {
                "type": [ "string", "null" ]
            },
            "type": {
                "type": "string",
                "enum": [
                    "fieldGroup",
                    "subSection"
                ]
            }
        }

    }
}

对于实现上述用例的示例 Json 架构的任何帮助/变通方法，我们表示赞赏。

Answer 1

如果我正确理解了您想要的描述，那么您提供的 json 示例无效，因为它的类型为："field" 但没有 "itemId" 属性.

假设这是真的。而不是使用

type: ["string", null]

使用需要的 属性.

我稍微更改了您的架构，而不是单独定义我内联它们，但除此之外（以及 required 的使用）是相同的：

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "contents": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "itemId": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "field"
                ]
              }
            },
            "required": [
              "itemId"
            ]
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "itemId": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "fieldGroup",
                  "subSection"
                ]
              }
            }
          }
        ]
      }
    }
  }
}

Answer 2

这是您的答案，其中对最佳做法和风格进行了一些清理。诀窍是你需要使用暗示"a implies b <=> (not a) or b"。在这种情况下，您有 "type = field implies itemId is required <=> type is not field or itemId is required".

{
  "type": "object",
  "properties": {
    "contents": {
      "type": "array",
      "items": { "$ref": "#/definitions/displayItem" }
    }
  },
  "definitions": {
    "displayItem": {
      "type": "object",
      "properties": {
        "itemId": { "type": "string" },
        "type": { "enum": ["field", "fieldGroup", "subSection"] }
      },
      "anyOf": [
        { "not": { "$ref": "#/definitions/fieldType" } },
        { "required": ["itemId"] }
      ]
    },
    "fieldType": {
      "properties": {
        "type": { "enum": ["field"] }
      }
    }
  }
}

AJV 架构验证错误

AJV schema validation error

json

jsonschema

json-schema-validator