JSON Structure: Validation Extensions

Validation Keywords

Numeric Validation Keywords This section defines the validation keywords applicable to schemas with numeric types. The value of each keyword MUST be in the value space of the numeric type to which the keyword is applied. For schemas with extended numeric types (such as long integers and decimals) whose base representation is a string, numeric constraint values (e.g., for minimum, maximum) MUST be provided as strings.

minimum An instance is valid if its numeric value is greater than or equal to the value specified in minimum. Example for basic type: Example for extended type:

maximum An instance is valid if its numeric value is less than or equal to the value specified in maximum. Example for basic type: Example for extended type:

exclusiveMinimum An instance is valid if its numeric value is strictly greater than the value specified in exclusiveMinimum. Example for basic type: Example for extended type:

exclusiveMaximum An instance is valid if its numeric value is strictly less than the value specified in exclusiveMaximum. Example for basic type: Example for extended type:

multipleOf An instance is valid if dividing its numeric value by the value of multipleOf results in an integer value. The value of multipleOf MUST be a positive number. Example for basic type: Example for extended type:

String Validation Keywords This section defines the validation keywords applicable to schemas with the type string. The maxLength keyword is not included as it is part of JSON Structure Core and is not redefined here.

minLength A string is valid if its length is at least the integer value specified in minLength. The value of minLength MUST be a non-negative integer. Example:

pattern A string is valid if its entire value conforms to the regular expression provided in the pattern keyword. The value of pattern MUST be a string representing a valid regular expression that conforms to the standard. Example:

format A string is valid if it conforms to a specific format. The value of format MUST be a string. The format keyword adds additional standard validation constraints not covered by the extended types in the core specification without the need to define an explicit regular expression pattern.

ipv4 – Internet Protocol version 4 address
ipv6 – Internet Protocol version 6 address
email – Email address
idn-email – Internationalized email address
hostname – Hostname
idn-hostname – Internationalized hostname
iri – Internationalized Resource Identifier
iri-reference – Internationalized Resource Identifier reference
uri-template – URI template
relative-json-pointer – Relative JSON pointer
regex – Regular expression

Array and Set Validation Keywords This section defines the validation keywords applicable to schemas with the type array and set.

minItems An array or set is valid if its number of elements is at least the integer value specified in minItems. The value of minItems MUST be a non-negative integer. Example:

maxItems An array or set is valid if its number of elements does not exceed the integer value specified in maxItems. The value of maxItems MUST be a non-negative integer. Example:

uniqueItems This keyword is only applicable to schemas with the type array as this constraint is inherent to set. An array is valid if, when uniqueItems is set to true, no two elements are equal. The value of uniqueItems MUST be a boolean (either true or false). Example:

contains An array or set is valid if at least one element satisfies the schema specified in contains. The value of contains MUST be a valid JSON Structure object. Example: The condition schema MAY contain a const keyword to specify a fixed value that the array must contain. Example:

maxContains An array or set is valid if at most the number of elements specified in maxContains satisfy the schema specified in contains. The value of maxContains MUST be a non-negative integer. Example:

minContains An array or set is valid if at least the number of elements specified in minContains satisfy the schema specified in contains. The value of minContains MUST be a non-negative integer. Example:

Object and Map Validation Keywords This section defines the validation keywords applicable to schemas with the type object and map.

minProperties and minEntries An object is valid if it has at least as many properties as defined by the integer value specified in minProperties. The value of minProperties MUST be a non-negative integer. The minEntries keyword applies equivalently to map types. Example: This constraint is useful for object definitions that use dynamic properties via additionalProperties and patternProperties.

maxProperties and maxEntries An object is valid if it contains no more than the integer value specified in maxProperties. The value of maxProperties MUST be a non-negative integer. The maxEntries keyword applies equivalently to map types. Example:

dependentRequired This keyword establishes dependencies between object properties. The value is a map of arrays of strings. Each entry in the map corresponds to a property name in the object instance. If the property exists, then the properties listed in the corresponding array MUST also exist in the instance. This keyword does not apply to the map type. Example:

patternProperties and patternKeys This keyword applies schemas to properties whose names match specified regular expressions. For each property in the object instance, if its name matches a regular expression defined in patternProperties, then its value MUST validate against the corresponding schema. The property names used as keys in patternProperties MUST be strings representing valid regular expressions conforming to the standard. The patternKeys keyword applies equivalently to map types. Example:

Note: All identifiers are additionally subject to the constraints of the identifier syntax in JSON Structure Core .

propertyNames and keyNames The propertyNames keyword validates the names of all properties in an object against a string-typed schema. An object is valid if every property name in the object is valid. The schema MUST be of type string. The keyNames keyword applies equivalently to map types. Example:

has The has keyword validates that an object or map has at least one (property) value that matches the schema. The schema MUST be of type object. Example:

Default Values

default The default keyword provides a default value for a schema. If an instance matches the schema but does not contain the property, the default value is used. Example:

Enabling the Extensions Validation extensions can be enabled in a schema or meta-schema by adding the JSONSchemaValidation key to the $uses clause when referencing the extended meta-schema: The extensions are enabled by default in the validation meta-schema: