Схема JSON: allof с дополнительными свойствами

[автор проекта спецификации проверки версии 4 здесь]

Вы столкнулись с самой распространенной проблемой в схеме JSON, а именно с ее фундаментальной неспособностью выполнять наследование, как ожидают пользователи; но в то же время это одна из его основных особенностей.

Когда вы это сделаете:

"allOf": [ { "schema1": "here" }, { "schema2": "here" } ]

schema1 и schema2 ничего не знают друг о друге; они оцениваются в их собственном контексте.

В вашем сценарии, с которым сталкиваются многие, многие люди, вы ожидаете, что свойства, определенные в schema1, будут известны schema2; но это не так и никогда не будет.

Вот почему я сделал эти два предложения для черновика v5:

• strictProperties,
• merge.

Тогда ваша схема для shipping_address будет:

{
    "merge": {
        "source": { "$ref": "#/definitions/address" },
        "with": {
            "properties": {
                "type": { "enum": [ "residential", "business" ] }
            }
        }
    }
}

вместе с определением от strictProperties до true в address.

Кстати, я также являюсь автором сайта, на который вы ссылаетесь.

Теперь позвольте мне вернуться к проекту v3. Проект v3 действительно определял extends, и его значение было либо схемой, либо массивом схем. По определению этого ключевого слова это означало, что экземпляр должен быть действительным для текущей схемы и всех схем, указанных в extends; По сути, allOf из черновика v4 - это extends из черновика v3.

Рассмотрим это (черновик v3):

{
    "extends": { "type": "null" },
    "type": "string"
}

А теперь, что:

{
    "allOf": [ { "type": "string" }, { "type": "null" } ]
}

Они одинаковые. А может что?

{
    "anyOf": [ { "type": "string" }, { "type": "null" } ]
}

Или это?

{
    "oneOf": [ { "type": "string" }, { "type": "null" } ]
}

В общем, это означает, что extends в проекте v3 никогда не делал того, что люди ожидали от него. В проекте v4 четко определены *Of ключевых слов.

Но проблема, с которой вы столкнулись, - это, безусловно, наиболее часто встречающаяся проблема. Отсюда мои предложения, которые раз и навсегда искоренили бы этот источник недоразумений!

additionalProperties применяется ко всем свойствам, которые не учитываются properties или patternProperties в непосредственной схеме.

Это означает, что когда у вас есть:

    {
      "allOf": [
        { "$ref": "#/definitions/address" },
        { "properties":
          { "type": { "enum": [ "residential", "business" ] } },
          "required": ["type"]
        }
      ],
      "additionalProperties":false
    }

additionalProperties здесь применяется ко всем свойствам, потому что нет записи properties уровня брата - запись внутри allOf не учитывается.

Одна вещь, которую вы могли бы сделать, - это переместить определение properties на один уровень вверх и предоставить записи-заглушки для свойств, которые вы импортируете:

    {
      "allOf": [{"$ref": "#/definitions/address"}],
      "properties": {
        "type": {"enum": ["residential", "business"]},
        "addressProp1": {},
        "addressProp2": {},
        ...
      },
      "required": ["type"],
      "additionalProperties":false
    }

Это означает, что additionalProperties не будет применяться к нужным вам свойствам.

Вот немного упрощенная версия решения Yves-M:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "street_address",
        "city",
        "state"
      ]
    }
  },
  "type": "object",
  "properties": {
    "billing_address": {
      "$ref": "#/definitions/address"
    },
    "shipping_address": {
      "allOf": [
        {
          "$ref": "#/definitions/address"
        }
      ],
      "properties": {
        "type": {
          "enum": [
            "residential",
            "business"
          ]
        },
        "street_address": {},
        "city": {},
        "state": {}
      },
      "required": [
        "type"
      ],
      "additionalProperties": false
    }
  }
}

Это сохраняет проверку требуемых свойств в базовой address схеме и просто добавляет необходимое свойство type в shipping_address.

К сожалению, additionalProperties принимает во внимание только непосредственные свойства на уровне братьев и сестер. Может, на это есть причина. Но именно поэтому нам нужно повторить унаследованные свойства.

Здесь мы повторяем унаследованные свойства в упрощенной форме, используя синтаксис пустого объекта. Это означает, что свойства с этими именами будут действительны независимо от того, какое значение они содержат. Но мы можем положиться на ключевое слово allOf для обеспечения соблюдения ограничений типа (и любых других ограничений), объявленных в базовой схеме address.

Не устанавливайте additionalProperties = false на уровне определения

И все будет хорошо:

{    
    "definitions": {
        "address": {
            "type": "object",
            "properties": {
                "street_address": { "type": "string" },
                "city":           { "type": "string" },
                "state":          { "type": "string" }
            }
        }
    },

    "type": "object",
    "properties": {

        "billing_address": {
            "allOf": [
                { "$ref": "#/definitions/address" }
            ],
            "properties": {
                "street_address": {},
                "city": {},
                "state": {}                 
            },          
            "additionalProperties": false
            "required": ["street_address", "city", "state"] 
        },

        "shipping_address": {
            "allOf": [
                { "$ref": "#/definitions/address" },
                {
                    "properties": {
                        "type": {
                            "enum": ["residential","business"]
                        }
                    }
                }
            ],
            "properties": {
                "street_address": {},
                "city": {},
                "state": {},
                "type": {}                          
            },              
            "additionalProperties": false
            "required": ["street_address","city","state","type"] 
        }

    }
}

Каждый из ваших billing_address и shipping_address должен указывать свои собственные обязательные свойства.

В вашем определении не должно быть "additionalProperties": false, если вы хотите объединить его свойства с другими.