Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/asyncapi/_shared/latest--1.0.0-without-$id.json
Parent schema asyncapi
Type: object

!!Auto generated!! Do not manually edit.

Properties

asyncapi string required

The AsyncAPI specification version of this document.

Values: "1.0.0"
info object required

General information about the API.

6 nested properties
title string required

A unique and precise title of the API.

version string required

A semantic version number of the API.

description string

A longer description of the API. Should be different from the title. CommonMark is allowed.

termsOfService string

A URL to the Terms of Service for the API. MUST be in the format of a URL.

format=uri
contact object

Contact information for the owners of the API.

3 nested properties
name string

The identifying name of the contact person/organization.

url string

The URL pointing to the contact information.

format=uri
email string

The email address of the contact person/organization.

format=email
license object
2 nested properties
name string required

The name of the license type. It's encouraged to use an OSI compatible license.

url string

The URL pointing to the license.

format=uri
topics object required

Relative paths to the individual topics. They must be relative to the 'baseTopic'.

baseTopic string

The base topic to the API. Example: 'hitch'.

Default: ""
pattern=^[^/.]
servers server[]
uniqueItems=true
components object

An object to hold a set of reusable objects for different aspects of the AsyncAPI Specification.

3 nested properties
schemas Record<string, object>

JSON objects describing schemas the API uses.

messages Record<string, object>

JSON objects describing the messages being consumed and produced by the API.

securitySchemes object
tags tag[]
uniqueItems=true
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string

Definitions

vendorExtension

Any property starting with x- is valid.

info object

General information about the API.

title string required

A unique and precise title of the API.

version string required

A semantic version number of the API.

description string

A longer description of the API. Should be different from the title. CommonMark is allowed.

termsOfService string

A URL to the Terms of Service for the API. MUST be in the format of a URL.

format=uri
contact object

Contact information for the owners of the API.

3 nested properties
name string

The identifying name of the contact person/organization.

url string

The URL pointing to the contact information.

format=uri
email string

The email address of the contact person/organization.

format=email
license object
2 nested properties
name string required

The name of the license type. It's encouraged to use an OSI compatible license.

url string

The URL pointing to the license.

format=uri
contact object

Contact information for the owners of the API.

name string

The identifying name of the contact person/organization.

url string

The URL pointing to the contact information.

format=uri
email string

The email address of the contact person/organization.

format=email
license object
name string required

The name of the license type. It's encouraged to use an OSI compatible license.

url string

The URL pointing to the license.

format=uri
server object

An object representing a Server.

url string required
scheme string required

The transfer protocol.

Values: "kafka" "kafka-secure" "amqp" "amqps" "mqtt" "mqtts" "secure-mqtt" "ws" "wss" "stomp" "stomps"
description string
schemeVersion string
variables Record<string, object>
serverVariables Record<string, object>
serverVariable object

An object representing a Server Variable for server URL template substitution.

enum string[]
uniqueItems=true
default string
description string
topics object

Relative paths to the individual topics. They must be relative to the 'baseTopic'.

topicItem object
$ref string
publish object
9 nested properties
$ref string
headers object

A deterministic version of a JSON Schema object.

30 nested properties
$ref string
format string
title object

Core schema meta-schema

Default:
{}
description object

Core schema meta-schema

Default:
{}
default object

Core schema meta-schema

Default:
{}
multipleOf object

Core schema meta-schema

Default:
{}
maximum object

Core schema meta-schema

Default:
{}
exclusiveMaximum object

Core schema meta-schema

Default:
{}
minimum object

Core schema meta-schema

Default:
{}
exclusiveMinimum object

Core schema meta-schema

Default:
{}
maxLength object

Core schema meta-schema

Default:
{}
minLength object

Core schema meta-schema

Default:
{}
pattern object

Core schema meta-schema

Default:
{}
maxItems object

Core schema meta-schema

Default:
{}
minItems object

Core schema meta-schema

Default:
{}
uniqueItems object

Core schema meta-schema

Default:
{}
maxProperties object

Core schema meta-schema

Default:
{}
minProperties object

Core schema meta-schema

Default:
{}
required object

Core schema meta-schema

Default:
{}
enum object

Core schema meta-schema

Default:
{}
additionalProperties schema | boolean
Default:
{}
type object

Core schema meta-schema

Default:
{}
items schema | schema[]
Default:
{}
allOf schema[]
minItems=1
properties Record<string, object>
Default:
{}
discriminator string
readOnly boolean
Default: false
xml object
externalDocs object

information about external documentation

example
payload object

A deterministic version of a JSON Schema object.

30 nested properties
$ref string
format string
title object

Core schema meta-schema

Default:
{}
description object

Core schema meta-schema

Default:
{}
default object

Core schema meta-schema

Default:
{}
multipleOf object

Core schema meta-schema

Default:
{}
maximum object

Core schema meta-schema

Default:
{}
exclusiveMaximum object

Core schema meta-schema

Default:
{}
minimum object

Core schema meta-schema

Default:
{}
exclusiveMinimum object

Core schema meta-schema

Default:
{}
maxLength object

Core schema meta-schema

Default:
{}
minLength object

Core schema meta-schema

Default:
{}
pattern object

Core schema meta-schema

Default:
{}
maxItems object

Core schema meta-schema

Default:
{}
minItems object

Core schema meta-schema

Default:
{}
uniqueItems object

Core schema meta-schema

Default:
{}
maxProperties object

Core schema meta-schema

Default:
{}
minProperties object

Core schema meta-schema

Default:
{}
required object

Core schema meta-schema

Default:
{}
enum object

Core schema meta-schema

Default:
{}
additionalProperties schema | boolean
Default:
{}
type object

Core schema meta-schema

Default:
{}
items schema | schema[]
Default:
{}
allOf schema[]
minItems=1
properties Record<string, object>
Default:
{}
discriminator string
readOnly boolean
Default: false
xml object
externalDocs object

information about external documentation

example
tags tag[]
uniqueItems=true
summary string

A brief summary of the message.

description string

A longer description of the message. CommonMark is allowed.

externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
deprecated boolean
Default: false
example
subscribe object
9 nested properties
$ref string
headers object

A deterministic version of a JSON Schema object.

30 nested properties
$ref string
format string
title object

Core schema meta-schema

Default:
{}
description object

Core schema meta-schema

Default:
{}
default object

Core schema meta-schema

Default:
{}
multipleOf object

Core schema meta-schema

Default:
{}
maximum object

Core schema meta-schema

Default:
{}
exclusiveMaximum object

Core schema meta-schema

Default:
{}
minimum object

Core schema meta-schema

Default:
{}
exclusiveMinimum object

Core schema meta-schema

Default:
{}
maxLength object

Core schema meta-schema

Default:
{}
minLength object

Core schema meta-schema

Default:
{}
pattern object

Core schema meta-schema

Default:
{}
maxItems object

Core schema meta-schema

Default:
{}
minItems object

Core schema meta-schema

Default:
{}
uniqueItems object

Core schema meta-schema

Default:
{}
maxProperties object

Core schema meta-schema

Default:
{}
minProperties object

Core schema meta-schema

Default:
{}
required object

Core schema meta-schema

Default:
{}
enum object

Core schema meta-schema

Default:
{}
additionalProperties schema | boolean
Default:
{}
type object

Core schema meta-schema

Default:
{}
items schema | schema[]
Default:
{}
allOf schema[]
minItems=1
properties Record<string, object>
Default:
{}
discriminator string
readOnly boolean
Default: false
xml object
externalDocs object

information about external documentation

example
payload object

A deterministic version of a JSON Schema object.

30 nested properties
$ref string
format string
title object

Core schema meta-schema

Default:
{}
description object

Core schema meta-schema

Default:
{}
default object

Core schema meta-schema

Default:
{}
multipleOf object

Core schema meta-schema

Default:
{}
maximum object

Core schema meta-schema

Default:
{}
exclusiveMaximum object

Core schema meta-schema

Default:
{}
minimum object

Core schema meta-schema

Default:
{}
exclusiveMinimum object

Core schema meta-schema

Default:
{}
maxLength object

Core schema meta-schema

Default:
{}
minLength object

Core schema meta-schema

Default:
{}
pattern object

Core schema meta-schema

Default:
{}
maxItems object

Core schema meta-schema

Default:
{}
minItems object

Core schema meta-schema

Default:
{}
uniqueItems object

Core schema meta-schema

Default:
{}
maxProperties object

Core schema meta-schema

Default:
{}
minProperties object

Core schema meta-schema

Default:
{}
required object

Core schema meta-schema

Default:
{}
enum object

Core schema meta-schema

Default:
{}
additionalProperties schema | boolean
Default:
{}
type object

Core schema meta-schema

Default:
{}
items schema | schema[]
Default:
{}
allOf schema[]
minItems=1
properties Record<string, object>
Default:
{}
discriminator string
readOnly boolean
Default: false
xml object
externalDocs object

information about external documentation

example
tags tag[]
uniqueItems=true
summary string

A brief summary of the message.

description string

A longer description of the message. CommonMark is allowed.

externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
deprecated boolean
Default: false
example
deprecated boolean
Default: false
message object
$ref string
headers object

A deterministic version of a JSON Schema object.

30 nested properties
$ref string
format string
title object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
description object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
default object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
multipleOf object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maximum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
exclusiveMaximum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minimum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
exclusiveMinimum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxLength object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minLength object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
pattern object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
uniqueItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxProperties object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minProperties object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
required object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
enum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
additionalProperties schema | boolean
Default:
{}
type object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
items schema | schema[]
Default:
{}
allOf schema[]
minItems=1
properties Record<string, object>
Default:
{}
discriminator string
readOnly boolean
Default: false
xml object
5 nested properties
name string
namespace string
prefix string
attribute boolean
Default: false
wrapped boolean
Default: false
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
example
payload object

A deterministic version of a JSON Schema object.

30 nested properties
$ref string
format string
title object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
description object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
default object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
multipleOf object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maximum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
exclusiveMaximum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minimum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
exclusiveMinimum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxLength object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minLength object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
pattern object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
uniqueItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxProperties object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minProperties object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
required object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
enum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
additionalProperties schema | boolean
Default:
{}
type object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
items schema | schema[]
Default:
{}
allOf schema[]
minItems=1
properties Record<string, object>
Default:
{}
discriminator string
readOnly boolean
Default: false
xml object
5 nested properties
name string
namespace string
prefix string
attribute boolean
Default: false
wrapped boolean
Default: false
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
example
tags tag[]
uniqueItems=true
summary string

A brief summary of the message.

description string

A longer description of the message. CommonMark is allowed.

externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
deprecated boolean
Default: false
example
schema object

A deterministic version of a JSON Schema object.

$ref string
format string
title object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
description object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
default object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
multipleOf object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maximum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
exclusiveMaximum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minimum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
exclusiveMinimum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxLength object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minLength object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
pattern object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
uniqueItems object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
maxProperties object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
minProperties object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
required object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
enum object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
additionalProperties schema | boolean
Default:
{}
type object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
items schema | schema[]
Default:
{}
allOf schema[]
minItems=1
properties Record<string, object>
Default:
{}
discriminator string
readOnly boolean
Default: false
xml object
5 nested properties
name string
namespace string
prefix string
attribute boolean
Default: false
wrapped boolean
Default: false
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
example
json-schema-draft-07-schema object

Core schema meta-schema

id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
33 nested properties
id string
$schema string
title string
description string
default
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength
All of: positiveInteger integer, variant
pattern string
format=regex
additionalItems boolean | json-schema-draft-07-schema
Default:
{}
maxItems integer
min=0
minItems
All of: positiveInteger integer, variant
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties
All of: positiveInteger integer, variant
required string[]
minItems=1uniqueItems=true
additionalProperties boolean | json-schema-draft-07-schema
Default:
{}
definitions Record<string, object>
Default:
{}
properties Record<string, object>
Default:
{}
patternProperties Record<string, object>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
enum array
minItems=1uniqueItems=true
format string
not object

Core schema meta-schema

Default:
{}
xml object
name string
namespace string
prefix string
attribute boolean
Default: false
wrapped boolean
Default: false
externalDocs object

information about external documentation

url string required
format=uri
description string
tag object
name string required
description string
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
components object

An object to hold a set of reusable objects for different aspects of the AsyncAPI Specification.

schemas Record<string, object>

JSON objects describing schemas the API uses.

messages Record<string, object>

JSON objects describing the messages being consumed and produced by the API.

securitySchemes object
schemas Record<string, object>

JSON objects describing schemas the API uses.

messages Record<string, object>

JSON objects describing the messages being consumed and produced by the API.

Reference object
$ref string required
format=uri
SecurityScheme userPassword | apiKey | X509 | symmetricEncryption | asymmetricEncryption | HTTPSecurityScheme
userPassword object
type string required
Values: "userPassword"
description string
apiKey object
type string required
Values: "apiKey"
in string required
Values: "user" "password"
description string
X509 object
type string required
Values: "X509"
description string
symmetricEncryption object
type string required
Values: "symmetricEncryption"
description string
asymmetricEncryption object
type string required
Values: "asymmetricEncryption"
description string
HTTPSecurityScheme NonBearerHTTPSecurityScheme | BearerHTTPSecurityScheme | APIKeyHTTPSecurityScheme
NonBearerHTTPSecurityScheme object
scheme string required
type string required
Values: "http"
description string
BearerHTTPSecurityScheme object
scheme string required
Values: "bearer"
type string required
Values: "http"
bearerFormat string
description string
APIKeyHTTPSecurityScheme object
type string required
Values: "httpApiKey"
name string required
in string required
Values: "header" "query" "cookie"
description string
SecurityRequirement Record<string, string[]>