Applicator Vocabulary Official Included By Default

A vocabulary that defines applicator keywords that are recommended for use as the basis of other vocabularies.

Dialect 2019-09
URI https://json-schema.org/draft/2019-09/vocab/applicator
Specification https://json-schema.org/draft/2019-09/draft-handrews-json-schema-02#rfc.section.9
Authors
Metaschema https://json-schema.org/draft/2019-09/meta/applicator

To make use of this vocabulary, modify your metaschema to declare the use of this vocabulary using the $vocabulary keyword and evaluate its metaschema. If the vocabulary must be present for an implementation to proceed:

{
  ...
  "$vocabulary": {
    ...
    "https://json-schema.org/draft/2019-09/vocab/applicator": true
  },
  "allOf": [
    { "$ref": "https://json-schema.org/draft/2019-09/meta/applicator" }
  ]
}

Otherwise, if it is optional for implementations to understand this vocabulary to proceed:

{
  ...
  "$vocabulary": {
    ...
    "https://json-schema.org/draft/2019-09/vocab/applicator": false
  },
  "allOf": [
    { "$ref": "https://json-schema.org/draft/2019-09/meta/applicator" }
  ]
}

Keywords

Keyword Kind Instance Summary
allOf Applicator Any An instance validates successfully against this keyword if it validates successfully against all schemas defined by this keyword’s value.
anyOf Applicator Any An instance validates successfully against this keyword if it validates successfully against at least one schema defined by this keyword’s value.
oneOf Applicator Any An instance validates successfully against this keyword if it validates successfully against exactly one schema defined by this keyword’s value.
if Applicator Any This keyword declares a condition based on the validation result of the given schema.
then Applicator Any When if is present, and the instance successfully validates against its subschema, then validation succeeds against this keyword if the instance also successfully validates against this keyword’s subschema.
else Applicator Any When if is present, and the instance fails to validate against its subschema, then validation succeeds against this keyword if the instance successfully validates against this keyword’s subschema.
not Applicator Any An instance is valid against this keyword if it fails to validate successfully against the schema defined by this keyword.
properties Applicator Annotation Object Validation succeeds if, for each name that appears in both the instance and as a name within this keyword’s value, the child instance for that name successfully validates against the corresponding schema.
patternProperties Applicator Annotation Object Validation succeeds if, for each instance name that matches any regular expressions that appear as a property name in this keyword’s value, the child instance for that name successfully validates against each schema that corresponds to a matching regular expression.
additionalProperties Applicator Annotation Object Validation succeeds if the schema validates against each value not matched by other object applicators in this vocabulary.
propertyNames Applicator Object Validation succeeds if the schema validates against every property name in the instance.
dependentSchemas Applicator Object This keyword specifies subschemas that are evaluated if the instance is an object and contains a certain property.
additionalItems Applicator Annotation Array If items is set to an array of schemas, validation succeeds if each element of the instance not covered by it validates against this schema.
items Applicator Annotation Array If set to a schema, validation succeeds if each element of the instance validates against it, otherwise validation succeeds if each element of the instance validates against the schema at the same position, if any
contains Applicator Array Validation succeeds if the instance contains an element that validates against this schema.
unevaluatedItems Applicator Annotation Array Validates array elements that did not successfully validate against other standard array applicators.
unevaluatedProperties Applicator Annotation Object Validates object properties that did not successfully validate against other standard object applicators.