лучший способ сделать условные массивы в схеме json с достойными сообщениями об ошибках

Я хотел бы ограничить массив (кортеж) в JSON-схеме и получать приличные сообщения об ошибках, но пока мне это не удалось.

Массив состоит из 2 элементов, первый - это строка, а второй - объект. Допустимые / обязательные свойства объекта зависят от строки. 2 действительных примера:

{
    "color": [ "white", { "a white property": 42 }]
}

а также

{
    "color": [ "black", { "this is a black property": "tAttUQoLtUaE" }]
}

для справки тип в машинописном тексте будет определяться как:

type MyObject = {
    color:
    | ["white", {
        "a white property": number
    }]
    | ["black", {
        "this is a black property": string
    }]
}

Я пробовал oneOf (см. Ниже), и он работает, но если файл недействителен, сообщение об ошибке непонятно. Вы можете попробовать этот экземпляр на jsonschemavalidator.org:

{
  "color": [ "black", {
      "XXX": "foo"
  }]
}

Моя попытка:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/root.json",
    "type": "object",
    "required": [
        "color"
    ],
    "properties": {
        "color": {
            "oneOf": [
                {
                    "type": "array",
                    "items": [
                        {
                            "enum": [ "white"]
                        },
                        {
                            "type": "object",
                            "required": [ "a white property" ],
                            "additionalProperties": false,
                            "properties": {
                                "a white property": {
                                    "type": "number"
                                }
                            }
                        }
                    ]
                },
                {
                    "type": "array",
                    "items": [
                        {
                            "enum": ["black"]
                        },
                        {
                            "type": "object",
                            "required": [ "this is a black property" ],
                            "additionalProperties": false,
                            "properties": {
                                "this is a black property": {
                                    "type": "string"
                                }
                            }
                        }
                    ]
                }
            ]
        }
    },
    "additionalProperties": false
}

Есть ли лучший способ выразить это правило?


person Coen    schedule 29.01.2020    source источник


Ответы (1)


См. атрибут jsonSchema, который требуется условно, для описания четырех стратегий для условных ограничений. . Вот они, в том порядке, в котором стратегия дает лучшие сообщения об ошибках.

  1. dependencies: это очень специфическое ограничение, поэтому часто появляются отличные сообщения об ошибках. К сожалению, в вашей ситуации это не работает.

  2. _2 _ / _ 3_: так вы получите лучшие сообщения в вашем случае.

  3. Вывод: при этом выводятся довольно хорошие сообщения об ошибках, но не так хорошо, как _4 _ / _ 5_. _6 _ / _ 7_ был добавлен в черновик-07. Если вы не можете использовать draft-07 или выше, это ваш лучший выбор.

  4. Enum: это тот, который вы используете, и, как вы видели, он вызывает ужасные ошибки. Это худший вариант для сообщений об ошибках.

person Jason Desrosiers    schedule 30.01.2020