В jsonSchema вы можете указать, являются ли определенные поля обязательными или нет, используя requiredатрибут:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "header": {
            "type": "object",
            "properties": {
                "messageName": {
                    "type": "string"
                },
                "messageVersion": {
                    "type": "string"
                }
            },
            "required": [
                "messageName",
                "messageVersion"
            ]
        }
    },
    "required": [
        "header"
    ]
}

В некоторых случаях я бы хотел, чтобы messageVersionполе не было обязательным. Есть ли способ сделать условной обязательность этого поля?

В зависимости от вашей ситуации есть несколько разных подходов. Я могу придумать четыре разных способа условного требования поля.

Зависимости

dependenciesКлючевым словом является условным изменением requiredключевого слова. Свойство Foreach в dependencies, если свойство присутствует в проверяемом JSON, то схема, связанная с этим ключом, также должна быть действительной. Если свойство "foo" присутствует, то свойство "bar" обязательно.

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "dependencies": {
    "foo": { "required": ["bar"] }
  }
}

Также существует краткая форма, если схема содержит только requiredключевое слово.

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "dependencies": {
    "foo": ["bar"]
  }
}

Последствия

Если ваше условие зависит от значения поля, вы можете использовать концепцию логической логики, называемую импликацией. «A подразумевает B» эффективно означает, что если A истинно, то B также должно быть истинным. Следствие также может быть выражено как «! A или B». Либо свойство «foo» не равно «bar», либо свойство «bar» является обязательным . Или, другими словами: если свойство "foo" равно "bar", тогда свойство "bar" обязательно.

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "anyOf": [
    {
      "not": {
        "properties": {
          "foo": { "const": "bar" }
        },
        "required": ["foo"]
      }
    },
    { "required": ["bar"] }
  ]
}

Если «foo» не равно «bar», #/anyOf/0совпадения и проверка пройдены успешно. Если «foo» равно «bar», #/anyOf/0не выполняется и #/anyOf/1должно быть действительным для anyOfуспешной проверки.

Enum

Если ваше условное выражение основано на перечислении, это немного проще. «foo» может быть «bar» или «baz». Если «foo» равно «bar», тогда «bar» является обязательным. Если «foo» равно «baz», то «baz» является обязательным.

{
  "type": "object",
  "properties": {
    "foo": { "enum": ["bar", "baz"] },
    "bar": { "type": "string" },
    "baz": { "type": "string" }
  },
  "anyOf": [
    {
      "properties": {
        "foo": { "const": "bar" }
      },
      "required": ["bar"]
    },
    {
      "properties": {
        "foo": { "const": "baz" }
      },
      "required": ["baz"]
    }
  ]
}

Если-то-еще

Относительно новое дополнение к схеме JSON (draft-07) добавляет ключевые слова if, thenи else. Если свойство "foo" равно "bar", тогда свойство "bar" обязательно.

{
  "type": "object",
  "properties": {
    "foo": { "type": "string" },
    "bar": { "type": "string" }
  },
  "if": {
    "properties": {
      "foo": { "const": "bar" }
    },
    "required": ["foo"]
  },
  "then": { "required": ["bar"] }
}

РЕДАКТИРОВАТЬ 23.12.2017: обновлен раздел о последствиях и добавлен раздел If-Then-Else.

РЕДАКТИРОВАТЬ 06/04/2018: Исправление ошибки для If-Then-Else и обновление синглтонов enumдля использования const.