复选框已设置/删除了JSON模式“必需”验证

时间:2019-03-18 12:06:23

标签: jsonschema json-schema-validator ajv

我正在设计一个使用JSON Schema建模的Web应用程序。我正在尝试创建一个带有文本区域和复选框的页面。文字区域用于说明我为什么喜欢披萨。如果用户单击复选框,则表示他们确认自己不喜欢披萨。除非选中该复选框,否则文本框为“必需”。该复选框实际上是一个布尔型操作,但是不能更改所使用的组件(因为用户研究人员表示是这样)。目前,我正在使用AJV验证我的架构,并且配置为在属性为errorMessages.required但没有输入/选择输入的情况下抛出required

不幸的是,当我谈到JSON模式时,我完全没有经验。以下是我目前对此进行验证的尝试。这可以正确呈现,但是不能按我的要求运行-在我的开发环境中,它仅可以验证任何内容,但是在jsonschemavalidator.net上,除非选中该复选框,否则它不会验证。如何实现我想要的功能?

{
$schema: 'http://json-schema.org/draft-07/schema#',
type: 'object',
additionalProperties: false,
propertyNames: {
    enum: [
        'q-why-i-love-pizza',
        'q-i-hate-pizza'
    ]
},
properties: {
    'q-why-i-love-pizza': {
        type: 'string',
        title: 'If you love pizza, tell us why',
        maxLength: 500,
        errorMessages: {
            required: "Please tell us why you love pizza, or select 'I hate pizza'"
        }
    },
    'q-i-hate-pizza': {
        type: 'array',
        maxItems: 1,
        uniqueItems: true,
        items: {
            anyOf: [
                {
                    title: 'I hate pizza',
                    const: 'hate'
                }
            ]
        },
        errorMessages: {
            required: "Please tell us why you love pizza, or select 'I hate pizza'"
        }
    }
},
allOf: [
    {
        $ref: '#/definitions/if-not-checked-then-q-why-i-love-pizza-is-required'
    }
],
definitions: {
    'if-not-checked-then-q-why-i-love-pizza-is-required': {
        if: {
            not: {
                properties: {
                    'q-i-hate-pizza': {
                        const: 'hate'
                    }
                }
            }
        },
        then: {
            required: ['q-why-i-love-pizza'],
            propertyNames: {
                enum: [
                    'q-i-hate-pizza',
                    'q-why-i-love-pizza'
                    ]
                }
            }
        }
    }
}

编辑:

我希望以下几点:

{
    'q-why-i-love-pizza' : '',
    'q-i-hate-pizza' : ['']
}

由于未选择任何值,因此应验证失败。

{
    'q-why-i-love-pizza' : 'I love pizza because it's amazing',
    'q-i-hate-pizza' : ['']
}

这应该通过,因为用户已经输入了他们为什么喜欢披萨的原因,因此无需单击复选框。

{
    'q-why-i-love-pizza' : '',
    'q-i-hate-pizza' : ['hate']
}

这应该通过,因为尽管用户没有告诉我们为什么他们喜欢披萨,但他们已经选中了该框以表示他们讨厌披萨。

{
    'q-why-i-love-pizza' : 'I am a user, so decided to tell you I hate pizza too',
    'q-i-hate-pizza' : ['hate']
}

这也应该通过,因为我需要接受用户在方框中打勾表示自己讨厌披萨的可能性,但无论如何都要告诉我。

解决方案

{
    type: "object",
    properties: {    
        'q-why-i-love-pizza': {
            type: 'string',
            title: 'If you love pizza, tell us why',
            maxLength: 500,
            errorMessages: {
            required: "Please tell us why you love pizza, or select 'I hate pizza'"
            }
        },
        'q-i-hate-pizza': {
            type: 'array',
            maxItems: 1,
            uniqueItems: true,
            items: {
                anyOf: [
                    {
                        title: 'I hate pizza',
                        const: 'hate'
                    }
                ]    
            },
            errorMessages: {
                required: "Please tell us why you love pizza, or select 'I hate pizza'"
            }
        }
    },
    allOf: [
        { $ref: "#/definitions/if-not-checked-then-q-offender-contact-description-is-required" }
    ],
    definitions: {
        "if-not-checked-then-q-offender-contact-description-is-required": {
            if: {
                not: {
                    required: ["q-i-hate-pizza"]
                }
            },
            then: {
                required: ["q-why-i-love-pizza"]
            }
        }
    }
}

2 个答案:

答案 0 :(得分:1)

我已经简化了您的架构,所以这可能并不完美,但是这种通用方法应该可以工作。

{
  "type": "object",
  "properties": {
    "q-why-i-love-pizza": { "type": "string", "maxLength": 500 },
    "q-i-hate-pizza": { "const": ["hate"] }
  },
  "allOf": [
    { "$ref": "#/definitions/if-hates-pizza-then-q-why-i-love-pizza-is-required" }
  ],
  "definitions": {
    "if-hates-pizza-then-q-why-i-love-pizza-is-required": {
      "if": { "not": { "required": ["q-i-hate-pizza"] } },
      "then": { "required": ["q-why-i-love-pizza"] }
    }
  }
}

答案 1 :(得分:0)

大部分时间都在那儿,但是您错过了一些意想不到的事情。

您的if-not-checked-then-q-why-i-love-pizza-is-required模式。 const关键字仅适用于该属性(如果存在)。 您需要向required模式添加if约束。

很显然,这是一个猜测,因为您尚未提供JSON实例数据。