Extension Field Registry

x-jsonschema-maxContains - The maximum number of array elements that may match contains, used when targeting OpenAPI versions that do not directly support maxContains.

JSON Schema 2019-09 introduced the maxContains keyword to set the maximum number of array elements that may match contains.

The x-jsonschema-maxContains extension mirrors this JSON Schema keyword when targeting OpenAPI versions where the keyword is not directly available, serializing it as x-jsonschema-maxContains.

Use this extension only with JSON Schema versions before 2019-09; 2019-09 and later define maxContains directly.

It can appear as a property in the following objects: ["Schema Object"].

Used by: (informational)

Schema

{"type"=>"integer", "minimum"=>0}

Example

openapi: 3.0.4
info:
  title: My API
  version: 1.0.0
paths: {}
components:
  schemas:
    Roles:
      type: array
      items:
        type: string
      x-jsonschema-contains:
        const: admin
      x-jsonschema-maxContains: 1