JSON Schema for OpenAPI course

Looking to master JSON Schema for OpenAPI?

A 9+ hour course taught by a member of the JSON Schema Technical Steering Committee

Take the Video Course Also check out our O'Reilly book

contains : Schema

contains

Schema

Validation succeeds if the instance contains an element that validates against this schema.

Value This keyword must be set to a valid JSON Schema Hint: Use the jsonschema metaschema and jsonschema lint commands to catch keywords set to invalid values
Kind Applicator
Applies To Array
Base Dialect Draft 7
Changed In None
Introduced In Draft 6
Vocabulary Validation
Specification https://json-schema.org/draft-07/draft-handrews-json-schema-validation-01#rfc.section.6.4.6
Metaschema http://json-schema.org/draft-07/schema#
Official Tests draft7/contains.json
Default {}
Annotation None
Affected By None
Affects None
Also See

The contains keyword restricts array instances to include one or more items (at any location of the array) that validate against the given subschema.

Remember that JSON Schema is a constraint-driven language. Therefore, non-array instances successfully validate against this keyword. If needed, make use of the type keyword to constraint the accepted type accordingly.

Examples

A schema that constrains array instances to contain at least one even number Schema 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "contains": {
    "type": "number",
    "multipleOf": 2
  }
}
Valid An array value with one even number is valid Instance 
[ "foo", 2, false, [ "bar" ], -5 ]
Valid An array value with multiple even numbers is valid Instance 
[ "foo", 2, false, 3, 4, [ "bar" ], -5, -3.0 ]
Valid An array value that solely consists of even numbers is valid Instance 
[ 2, 4, 6, 8, 10, 12 ]
Invalid An array value without any even number is invalid Instance 
[ "foo", true ]
Invalid An empty array value is invalid Instance 
[]
Valid A non-array value is valid Instance 
"Hello World"