How to validate data based on an input value with AJV?

Question

I am using AJV trying to validate some data and dynamically require properties based on another property's value.

What I am trying to validate is: - enabled is always required, - if enabled = true then only one of the other properties (realtime, threshold or digest) must be provided,

Sample payloads and expected results:

Should pass

{
  "notifications": {
    "enabled": false
  }
}

Should pass

{
  "notifications": {
    "enabled": true,
    "realtime": true
  }
}

Should pass

{
  "notifications": {
    "enabled": true,
    "digest": true
  }
}

Should pass

{
  "notifications": {
    "enabled": true,
    "threshold": {}
  }
}

Should fail because enabled = true but no other property is set.

{
  "notifications": {
    "enabled": true
  }
}

Should fail because enabled = true and more than one other property is set.

{
  "notifications": {
    "enabled": true,
    "threshold": {},
    "digest: true
  }
}

Here's the validation schema I am using:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Settings",
  "type": "object",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "realtime": {
          "type": "boolean"
        },
        "threshold": {
          "type": "object",
          "properties": {
            "detections": {
              "type": "number"
            },
            "elapsed": {
              "type": "number"
            }
          },
          "required": ["detections", "elapsed"]
        },
        "digest": {
          "type": "boolean"
        }
      },
      "required": ["enabled"],
      "if": {
        "properties": { "enabled": true }
      },
      "then": {
        "oneOf": [
          { "required": [ "realtime" ] },
          { "required": [ "threshold" ] },
          { "required": [ "digest" ] }
        ]
      }
    }
  }
}

Thank you!

Are you saying, you have this Schema so far but it doesn’t work? — Relequestual, Dec 13 '19 at 07:10
I can’t understand what your question is. Can you be more specific please? Maybe give some data as an example of data you expect to pass and to fail? — Relequestual, Dec 13 '19 at 07:11
@Relequestual -I updated the question, feel free to have a go at it. — Stefan, Dec 16 '19 at 00:34
Your solution is pretty much the same as what I would have suggested since you updated your question. — Relequestual, Dec 16 '19 at 09:18

Stefan · Answer 1 · 2019-12-16T01:24:34.097

Turns out I was very close and the problem was how the if statement was being evaluated for true. Here's the correct schema that validates (passes and fails) all examples above as expected:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Settings",
  "type": "object",
  "properties": {
    "notifications": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "realtime": {
          "type": "boolean"
        },
        "threshold": {
          "type": "object",
          "properties": {
            "detections": {
              "type": "number"
            },
            "elapsed": {
              "type": "number"
            }
          },
          "required": ["detections", "elapsed"]
        },
        "digest": {
          "type": "boolean"
        }
      },
      "required": ["enabled"],
      "if": {
        "enabled": {
          "const": true
        }
      },
      "then": {
        "oneOf": [
          {
            "required": ["realtime"]
          },
          {
            "required": ["threshold"]
          },
          {
            "required": ["digest"]
          }
        ]
      }
    }
  }
}

This part did the trick:

"if": {
    "properties": {
        "enabled": {
            "const": true
        }
    }
}

How to validate data based on an input value with AJV?

1 Answers1