JSON schema - valid if object does *not* contain a particular property

json jsonschema
M Miller picture M Miller · May 28, 2015 · Viewed 11.3k times · Source

Is it possible to set up a JSON schema that still allows for additionalProperties but does not match if a very particular property name is present? In other words, I need to know if it's possible to have the exact opposite of the required declaration.

Schema:

{
    "type": "object",
    "properties": {
        "x": { "type": "integer" }
    },
    "required": [ "x" ],
    "ban": [ "z" ] // possible?
}

Match:

{ "x": 123 }

Match:

{ "x": 123, "y": 456 }

Do not match:

{ "x": 123, "y": 456, "z": 789 }

Answer

Jason Desrosiers picture Jason Desrosiers · Jun 5, 2015

What you want to do can be achieved using the not keyword. If the not schema validates, the parent schema will not validate.

{
    "type": "object",
    "properties": {
        "x": { "type": "integer" }
    },
    "required": [ "x" ],
    "not": { "required": [ "z" ] }
}

Related questions

Tool to generate JSON schema from JSON data

We have this json schema draft. I would like to get a sample of my JSON data and generate a skeleton for the JSON schema, that I can rework manually, adding things like description, required, etc, which can not be …

Read More
Generate Json schema from XML schema (XSD)

Does anybody know how to generate a JSON schema from a existing XML schema (XSD file)? Are there any tools available for this?

Read More
Generate JSON schema from Java class

I have a POJO class: public class Stock { int id; String name; Date date; } Are there any annotations or development framework/API that can convert POJO to JSON schema like below: {"id": { "type" : "int" }, "name":{ "type" : "string" } "date":{ "type" : "Date" } } …

Read More