latest--2.5.0-without-$id

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/asyncapi/_shared/latest--2.5.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: "2.5.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
channels Record<string, object> required
id string

A unique id representing the application.

format=uri
servers Record<string, Reference | server>

An object representing multiple servers.

defaultContentType string
components object

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

14 nested properties
schemas Record<string, schema>

JSON objects describing schemas the API uses.

servers Record<string, Reference | server>

An object representing multiple servers.

channels Record<string, object>
serverVariables Record<string, Reference | serverVariable>
messages Record<string, Reference | object | object>

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

securitySchemes object
parameters Record<string, Reference | parameter>

JSON objects describing re-usable channel parameters.

correlationIds object
operationTraits Record<string, object>
messageTraits Record<string, object>
serverBindings Record<string, object>
channelBindings Record<string, object>
operationBindings Record<string, object>
messageBindings Record<string, object>
tags tag[]
uniqueItems=true
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string

Definitions

specificationExtension

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
servers Record<string, Reference | server>

An object representing multiple servers.

Reference object
$ref string required
format=uri-reference
ReferenceObject string
server object

An object representing a Server.

url string required
protocol string required

The transfer protocol.

description string
protocolVersion string
variables Record<string, Reference | serverVariable>
security SecurityRequirement[]
bindings object
16 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
tags tag[]
uniqueItems=true
serverVariables Record<string, Reference | serverVariable>
serverVariable object

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

enum string[]
uniqueItems=true
default string
description string
examples string[]
SecurityRequirement Record<string, string[]>
bindingsObject object
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
tag object
name string required
description string
externalDocs object

information about external documentation

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

information about external documentation

url string required
format=uri
description string
channels Record<string, object>
channelItem object
$ref string
format=uri-reference
parameters Record<string, Reference | parameter>

JSON objects describing re-usable channel parameters.

description string

A description of the channel.

servers string[]

The names of the servers on which this channel is available. If absent or empty then this channel must be available on all servers.

uniqueItems=true
publish object
9 nested properties
traits Reference | operationTrait[]
summary string
description string
security SecurityRequirement[]
tags tag[]
uniqueItems=true
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
operationId string
bindings object
16 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
message Reference | object | object
subscribe object
9 nested properties
traits Reference | operationTrait[]
summary string
description string
security SecurityRequirement[]
tags tag[]
uniqueItems=true
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
operationId string
bindings object
16 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
message Reference | object | object
deprecated boolean
Default: false
bindings object
16 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
parameters Record<string, Reference | parameter>

JSON objects describing re-usable channel parameters.

parameter object
description string

A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.

schema
All of: Core schema meta-schema object | boolean, object object
location string

A runtime expression that specifies the location of the parameter value

pattern=^\$message\.(header|payload)#(\/(([^\/~])|(~[01]))*)*
schema
json-schema-draft-07-schema object | boolean
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
then object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
else object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
46 nested properties
$id string
format=uri-reference
$schema string
format=uri
$ref string
format=uri-reference
$comment string
title string
description string
default
readOnly boolean
Default: false
writeOnly boolean
Default: false
examples array
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
min=0
minLength
All of: nonNegativeInteger integer, variant
pattern string
format=regex
additionalItems object | boolean
Default: true
items json-schema-draft-07-schema | schemaArray
Default: true
maxItems integer
min=0
minItems
All of: nonNegativeInteger integer, variant
uniqueItems boolean
Default: false
contains object | boolean
Default: true
maxProperties integer
min=0
minProperties
All of: nonNegativeInteger integer, variant
required string[]
Default:
[]
uniqueItems=true
additionalProperties object | boolean
Default: true
definitions Record<string, object | boolean>
Default:
{}
properties Record<string, object | boolean>
Default:
{}
patternProperties Record<string, object | boolean>
Default:
{}
dependencies Record<string, json-schema-draft-07-schema | stringArray>
propertyNames object | boolean
Default: true
const
enum array
minItems=1uniqueItems=true
type simpleTypes | simpleTypes[]
format string
contentMediaType string
contentEncoding string
if object | boolean
Default: true
then object | boolean
Default: true
else object | boolean
Default: true
allOf json-schema-draft-07-schema[]
minItems=1
anyOf json-schema-draft-07-schema[]
minItems=1
oneOf json-schema-draft-07-schema[]
minItems=1
not object | boolean
Default: true
operation object
traits Reference | operationTrait[]
summary string
description string
security SecurityRequirement[]
tags tag[]
uniqueItems=true
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
operationId string
bindings object
16 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
message Reference | object | object
operationTrait object
summary string
description string
tags tag[]
uniqueItems=true
externalDocs object

information about external documentation

2 nested properties
url string required
format=uri
description string
operationId string
security SecurityRequirement[]
bindings object
16 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
message Reference | object | object
correlationId object
location string required

A runtime expression that specifies the location of the correlation ID

pattern=^\$message\.(header|payload)#(\/(([^\/~])|(~[01]))*)*
description string

A optional description of the correlation ID. GitHub Flavored Markdown is allowed.

messageTrait object
schemaFormat string
contentType string
headers
All of: schema, variant
messageId string
correlationId Reference | correlationId
tags tag[]
uniqueItems=true
summary string

A brief summary of the message.

name string

Name of the message.

title string

A human-friendly title for 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
examples object[]
bindings object
16 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
openapiSchema_3_0 object
title string
multipleOf number
exclusiveMin=0
maximum number
exclusiveMaximum boolean
Default: false
minimum number
exclusiveMinimum boolean
Default: false
maxLength integer
min=0
minLength integer
Default: 0
min=0
pattern string
format=regex
maxItems integer
min=0
minItems integer
Default: 0
min=0
uniqueItems boolean
Default: false
maxProperties integer
min=0
minProperties integer
Default: 0
min=0
required string[]
minItems=1uniqueItems=true
enum array
minItems=1
type string
Values: "array" "boolean" "integer" "number" "object" "string"
not openapiSchema_3_0 | Reference
allOf openapiSchema_3_0 | Reference[]
oneOf openapiSchema_3_0 | Reference[]
anyOf openapiSchema_3_0 | Reference[]
items openapiSchema_3_0 | Reference
properties Record<string, openapiSchema_3_0 | Reference>
additionalProperties openapiSchema_3_0 | Reference | boolean
Default: true
description string
format string
default
nullable boolean
Default: false
discriminator object
2 nested properties
propertyName string required
mapping Record<string, string>
readOnly boolean
Default: false
writeOnly boolean
Default: false
example
externalDocs object
2 nested properties
url string required
format=uri-reference
description string
deprecated boolean
Default: false
xml object
5 nested properties
name string
namespace string
format=uri
prefix string
attribute boolean
Default: false
wrapped boolean
Default: false
avroSchema_v1 avroSchema

Json-Schema definition for Avro AVSC files.

components object

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

schemas Record<string, schema>

JSON objects describing schemas the API uses.

servers Record<string, Reference | server>

An object representing multiple servers.

channels Record<string, object>
serverVariables Record<string, Reference | serverVariable>
messages Record<string, Reference | object | object>

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

securitySchemes object
parameters Record<string, Reference | parameter>

JSON objects describing re-usable channel parameters.

correlationIds object
operationTraits Record<string, object>
messageTraits Record<string, object>
serverBindings Record<string, object>
channelBindings Record<string, object>
operationBindings Record<string, object>
messageBindings Record<string, object>
schemas Record<string, schema>

JSON objects describing schemas the API uses.

messages Record<string, Reference | object | object>

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

SecurityScheme userPassword | apiKey | X509 | symmetricEncryption | asymmetricEncryption | HTTPSecurityScheme | oauth2Flows | openIdConnect | SaslSecurityScheme
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
oauth2Flows object
type string required
Values: "oauth2"
flows object required
4 nested properties
implicit
All of: oauth2Flow object, variant, variant
password
All of: oauth2Flow object, variant, variant
clientCredentials
All of: oauth2Flow object, variant, variant
authorizationCode
All of: oauth2Flow object, variant
description string
oauth2Flow object
authorizationUrl string
format=uri
tokenUrl string
format=uri
refreshUrl string
format=uri
scopes Record<string, string>
oauth2Scopes Record<string, string>
openIdConnect object
type string required
Values: "openIdConnect"
openIdConnectUrl string required
format=uri
description string
SaslSecurityScheme SaslPlainSecurityScheme | SaslScramSecurityScheme | SaslGssapiSecurityScheme
SaslPlainSecurityScheme object
type string required
Values: "plain"
description string
SaslScramSecurityScheme object
type string required
Values: "scramSha256" "scramSha512"
description string
SaslGssapiSecurityScheme object
type string required
Values: "gssapi"
description string