latest--2.6.0-without-$id

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/asyncapi/_shared/latest--2.6.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.6.0"
info object required

The object provides metadata about the API. The metadata can be used by the clients if needed.

Examples: {"title":"AsyncAPI Sample App","description":"This is a sample server.","termsOfService":"https://asyncapi.org/terms/","contact":{"name":"API Support","url":"https://www.example.com/support","email":"[email protected]"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}}
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 exposed API.

Examples: {"name":"API Support","url":"https://www.example.com/support","email":"[email protected]"}
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

License information for the exposed API.

Examples: {"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}
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

Holds the relative paths to the individual channel and their operations. Channel paths are relative to servers.

Examples: {"user/signedup":{"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
id string

A unique id representing the application.

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

The Servers Object is a map of Server Objects.

Examples: {"development":{"url":"development.gigantic-server.com","description":"Development server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:development","description":"This environment is meant for developers to run their own tests"}]},"staging":{"url":"staging.gigantic-server.com","description":"Staging server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:staging","description":"This environment is a replica of the production environment"}]},"production":{"url":"api.gigantic-server.com","description":"Production server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:production","description":"This environment is the live environment available for final users"}]}}
defaultContentType string
components object

Holds a set of reusable objects for different aspects of the AsyncAPI specification. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

Examples: {"components":{"schemas":{"Category":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"Tag":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}}},"servers":{"development":{"url":"{stage}.gigantic-server.com:{port}","description":"Development server","protocol":"amqp","protocolVersion":"0.9.1","variables":{"stage":{"$ref":"#/components/serverVariables/stage"},"port":{"$ref":"#/components/serverVariables/port"}}}},"serverVariables":{"stage":{"default":"demo","description":"This value is assigned by the service provider, in this example `gigantic-server.com`"},"port":{"enum":["8883","8884"],"default":"8883"}},"channels":{"user/signedup":{"subscribe":{"message":{"$ref":"#/components/messages/userSignUp"}}}},"messages":{"userSignUp":{"summary":"Action to sign a user up.","description":"Multiline description of what this action does.\nHere you have another line.\n","tags":[{"name":"user"},{"name":"signup"}],"headers":{"type":"object","properties":{"applicationInstanceId":{"description":"Unique identifier for a given instance of the publishing application","type":"string"}}},"payload":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/userCreate"},"signup":{"$ref":"#/components/schemas/signup"}}}}},"parameters":{"userId":{"description":"Id of the user.","schema":{"type":"string"}}},"correlationIds":{"default":{"description":"Default Correlation ID","location":"$message.header#/correlationId"}},"messageTraits":{"commonHeaders":{"headers":{"type":"object","properties":{"my-app-header":{"type":"integer","minimum":0,"maximum":100}}}}}}}
14 nested properties
schemas Record<string, schema>

JSON objects describing schemas the API uses.

servers Record<string, Reference | server>

The Servers Object is a map of Server Objects.

Examples: {"development":{"url":"development.gigantic-server.com","description":"Development server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:development","description":"This environment is meant for developers to run their own tests"}]},"staging":{"url":"staging.gigantic-server.com","description":"Staging server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:staging","description":"This environment is a replica of the production environment"}]},"production":{"url":"api.gigantic-server.com","description":"Production server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:production","description":"This environment is the live environment available for final users"}]}}
channels Record<string, object>

Holds the relative paths to the individual channel and their operations. Channel paths are relative to servers.

Examples: {"user/signedup":{"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
serverVariables Record<string, Reference | serverVariable>

A map between a variable name and its value. The value is used for substitution in the server's URL template.

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 reusable channel parameters.

Examples: {"user/{userId}/signup":{"parameters":{"userId":{"description":"Id of the user.","schema":{"type":"string"}}},"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
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

Allows referencing an external resource for extended documentation.

Examples: {"description":"Find more info here","url":"https://example.com"}
2 nested properties
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

Definitions

specificationExtension

Any property starting with x- is valid.

info object

The object provides metadata about the API. The metadata can be used by the clients if needed.

Examples:
  • { "title": "AsyncAPI Sample App", "description": "This is a sample server.", "termsOfService": "https://asyncapi.org/terms/", "contact": { "name": "API Support", "url": "https://www.example.com/support", "email": "[email protected]" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }
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 exposed API.

Examples: {"name":"API Support","url":"https://www.example.com/support","email":"[email protected]"}
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

License information for the exposed API.

Examples: {"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}
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 exposed API.

Examples:
  • { "name": "API Support", "url": "https://www.example.com/support", "email": "[email protected]" }
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

License information for the exposed API.

Examples:
  • { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }
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>

The Servers Object is a map of Server Objects.

Examples:
  • { "development": { "url": "development.gigantic-server.com", "description": "Development server", "protocol": "amqp", "protocolVersion": "0.9.1", "tags": [ { "name": "env:development", "description": "This environment is meant for developers to run their own tests" } ] }, "staging": { "url": "staging.gigantic-server.com", "description": "Staging server", "protocol": "amqp", "protocolVersion": "0.9.1", "tags": [ { "name": "env:staging", "description": "This environment is a replica of the production environment" } ] }, "production": { "url": "api.gigantic-server.com", "description": "Production server", "protocol": "amqp", "protocolVersion": "0.9.1", "tags": [ { "name": "env:production", "description": "This environment is the live environment available for final users" } ] } }
Reference object
$ref string required

A simple object to allow referencing other components in the specification, internally and externally.

Examples: {"$ref":"#/components/schemas/Pet"}
format=uri-reference
ReferenceObject string

A simple object to allow referencing other components in the specification, internally and externally.

Examples:
  • { "$ref": "#/components/schemas/Pet" }
server object

An object representing a message broker, a server or any other kind of computer program capable of sending and/or receiving data

Examples:
  • { "url": "development.gigantic-server.com", "description": "Development server", "protocol": "kafka", "protocolVersion": "1.0.0" }
url string required

A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the AsyncAPI document is being served.

protocol string required

The protocol this URL supports for connection. Supported protocol include, but are not limited to: amqp, amqps, http, https, ibmmq, jms, kafka, kafka-secure, anypointmq, mqtt, secure-mqtt, solace, stomp, stomps, ws, wss, mercure, googlepubsub.

description string

An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.

protocolVersion string

The version of the protocol used for connection. For instance: AMQP 0.9.1, HTTP 2.0, Kafka 1.0.0, etc.

variables Record<string, Reference | serverVariable>

A map between a variable name and its value. The value is used for substitution in the server's URL template.

security SecurityRequirement[]

A declaration of which security mechanisms can be used with this server. The list of values includes alternative security requirement objects that can be used.

bindings object

Map describing protocol-specific definitions for a server.

18 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
tags tag[]

A list of tags for logical grouping and categorization of servers.

uniqueItems=true
serverVariables Record<string, Reference | serverVariable>

A map between a variable name and its value. The value is used for substitution in the server's URL template.

serverVariable object

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

enum string[]

An enumeration of string values to be used if the substitution options are from a limited set.

uniqueItems=true
default string

The default value to use for substitution, and to send, if an alternate value is not supplied.

description string

An optional description for the server variable.

examples string[]

An array of examples of the server variable.

SecurityRequirement Record<string, string[]>

Lists of the required security schemes that can be used to execute an operation

Examples:
  • { "petstore_auth": [ "write:pets", "read:pets" ] }
bindingsObject object

Map describing protocol-specific definitions for a server.

http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
tag object

Allows adding meta data to a single tag.

Examples:
  • { "name": "user", "description": "User-related messages" }
name string required

The name of the tag.

description string

A short description for the tag.

externalDocs object

Allows referencing an external resource for extended documentation.

Examples: {"description":"Find more info here","url":"https://example.com"}
2 nested properties
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

externalDocs object

Allows referencing an external resource for extended documentation.

Examples:
  • { "description": "Find more info here", "url": "https://example.com" }
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

channels Record<string, object>

Holds the relative paths to the individual channel and their operations. Channel paths are relative to servers.

Examples:
  • { "user/signedup": { "subscribe": { "message": { "$ref": "#/components/messages/userSignedUp" } } } }
channelItem object

Describes the operations available on a single channel.

Examples:
  • { "description": "This channel is used to exchange messages about users signing up", "subscribe": { "summary": "A user signed up.", "message": { "description": "A longer description of the message", "payload": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/user" }, "signup": { "$ref": "#/components/schemas/signup" } } } } }, "bindings": { "amqp": { "is": "queue", "queue": { "exclusive": true } } } }
  • { "subscribe": { "message": { "oneOf": [ { "$ref": "#/components/messages/signup" }, { "$ref": "#/components/messages/login" } ] } } }
  • { "description": "This application publishes WebUICommand messages to an AMQP queue on RabbitMQ brokers in the Staging and Production environments.", "servers": [ "rabbitmqBrokerInProd", "rabbitmqBrokerInStaging" ], "subscribe": { "message": { "$ref": "#/components/messages/WebUICommand" } }, "bindings": { "amqp": { "is": "queue" } } }
$ref string

A simple object to allow referencing other components in the specification, internally and externally.

Examples: {"$ref":"#/components/schemas/Pet"}
format=uri-reference
parameters Record<string, Reference | parameter>

JSON objects describing reusable channel parameters.

Examples: {"user/{userId}/signup":{"parameters":{"userId":{"description":"Id of the user.","schema":{"type":"string"}}},"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
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

Describes a publish or a subscribe operation. This provides a place to document how and why messages are sent and received.

Examples: {"user/signedup":{"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
9 nested properties
traits Reference | operationTrait[]

A list of traits to apply to the operation object.

summary string

A short summary of what the operation is about.

description string

A verbose explanation of the operation.

security SecurityRequirement[]

A declaration of which security mechanisms are associated with this operation.

tags tag[]

A list of tags for logical grouping and categorization of operations.

uniqueItems=true
externalDocs object

Allows referencing an external resource for extended documentation.

Examples: {"description":"Find more info here","url":"https://example.com"}
2 nested properties
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

operationId string
bindings object

Map describing protocol-specific definitions for a server.

18 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
message Reference | object | object

Describes a message received on a given channel and operation.

Examples: {"messageId":"userSignup","name":"UserSignup","title":"User signup","summary":"Action to sign a user up.","description":"A longer description","contentType":"application/json","tags":[{"name":"user"},{"name":"signup"},{"name":"register"}],"headers":{"type":"object","properties":{"correlationId":{"description":"Correlation ID set by application","type":"string"},"applicationInstanceId":{"description":"Unique identifier for a given instance of the publishing application","type":"string"}}},"payload":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/userCreate"},"signup":{"$ref":"#/components/schemas/signup"}}},"correlationId":{"description":"Default Correlation ID","location":"$message.header#/correlationId"},"traits":[{"$ref":"#/components/messageTraits/commonHeaders"}],"examples":[{"name":"SimpleSignup","summary":"A simple UserSignup example message","headers":{"correlationId":"my-correlation-id","applicationInstanceId":"myInstanceId"},"payload":{"user":{"someUserKey":"someUserValue"},"signup":{"someSignupKey":"someSignupValue"}}}]}, {"messageId":"userSignup","name":"UserSignup","title":"User signup","summary":"Action to sign a user up.","description":"A longer description","tags":[{"name":"user"},{"name":"signup"},{"name":"register"}],"schemaFormat":"application/vnd.apache.avro+json;version=1.9.0","payload":{"$ref":"path/to/user-create.avsc#/UserCreate"}}
subscribe object

Describes a publish or a subscribe operation. This provides a place to document how and why messages are sent and received.

Examples: {"user/signedup":{"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
9 nested properties
traits Reference | operationTrait[]

A list of traits to apply to the operation object.

summary string

A short summary of what the operation is about.

description string

A verbose explanation of the operation.

security SecurityRequirement[]

A declaration of which security mechanisms are associated with this operation.

tags tag[]

A list of tags for logical grouping and categorization of operations.

uniqueItems=true
externalDocs object

Allows referencing an external resource for extended documentation.

Examples: {"description":"Find more info here","url":"https://example.com"}
2 nested properties
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

operationId string
bindings object

Map describing protocol-specific definitions for a server.

18 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
message Reference | object | object

Describes a message received on a given channel and operation.

Examples: {"messageId":"userSignup","name":"UserSignup","title":"User signup","summary":"Action to sign a user up.","description":"A longer description","contentType":"application/json","tags":[{"name":"user"},{"name":"signup"},{"name":"register"}],"headers":{"type":"object","properties":{"correlationId":{"description":"Correlation ID set by application","type":"string"},"applicationInstanceId":{"description":"Unique identifier for a given instance of the publishing application","type":"string"}}},"payload":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/userCreate"},"signup":{"$ref":"#/components/schemas/signup"}}},"correlationId":{"description":"Default Correlation ID","location":"$message.header#/correlationId"},"traits":[{"$ref":"#/components/messageTraits/commonHeaders"}],"examples":[{"name":"SimpleSignup","summary":"A simple UserSignup example message","headers":{"correlationId":"my-correlation-id","applicationInstanceId":"myInstanceId"},"payload":{"user":{"someUserKey":"someUserValue"},"signup":{"someSignupKey":"someSignupValue"}}}]}, {"messageId":"userSignup","name":"UserSignup","title":"User signup","summary":"Action to sign a user up.","description":"A longer description","tags":[{"name":"user"},{"name":"signup"},{"name":"register"}],"schemaFormat":"application/vnd.apache.avro+json;version=1.9.0","payload":{"$ref":"path/to/user-create.avsc#/UserCreate"}}
deprecated boolean
Default: false
bindings object

Map describing protocol-specific definitions for a server.

18 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
parameters Record<string, Reference | parameter>

JSON objects describing reusable channel parameters.

Examples:
  • { "user/{userId}/signup": { "parameters": { "userId": { "description": "Id of the user.", "schema": { "type": "string" } } }, "subscribe": { "message": { "$ref": "#/components/messages/userSignedUp" } } } }
parameter object

Describes a parameter included in a channel name.

Examples:
  • { "user/{userId}/signup": { "parameters": { "userId": { "description": "Id of the user.", "schema": { "type": "string" }, "location": "$message.payload#/user/id" } }, "subscribe": { "message": { "$ref": "#/components/messages/userSignedUp" } } } }
description string

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

schema

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays.

Examples: {"type":"string","format":"email"}, {"type":"object","required":["name"],"properties":{"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"age":{"type":"integer","format":"int32","minimum":0}}}
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

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays.

Examples:
  • { "type": "string", "format": "email" }
  • { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "address": { "$ref": "#/components/schemas/Address" }, "age": { "type": "integer", "format": "int32", "minimum": 0 } } }
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

Describes a publish or a subscribe operation. This provides a place to document how and why messages are sent and received.

Examples:
  • { "user/signedup": { "subscribe": { "message": { "$ref": "#/components/messages/userSignedUp" } } } }
traits Reference | operationTrait[]

A list of traits to apply to the operation object.

summary string

A short summary of what the operation is about.

description string

A verbose explanation of the operation.

security SecurityRequirement[]

A declaration of which security mechanisms are associated with this operation.

tags tag[]

A list of tags for logical grouping and categorization of operations.

uniqueItems=true
externalDocs object

Allows referencing an external resource for extended documentation.

Examples: {"description":"Find more info here","url":"https://example.com"}
2 nested properties
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

operationId string
bindings object

Map describing protocol-specific definitions for a server.

18 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
message Reference | object | object

Describes a message received on a given channel and operation.

Examples: {"messageId":"userSignup","name":"UserSignup","title":"User signup","summary":"Action to sign a user up.","description":"A longer description","contentType":"application/json","tags":[{"name":"user"},{"name":"signup"},{"name":"register"}],"headers":{"type":"object","properties":{"correlationId":{"description":"Correlation ID set by application","type":"string"},"applicationInstanceId":{"description":"Unique identifier for a given instance of the publishing application","type":"string"}}},"payload":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/userCreate"},"signup":{"$ref":"#/components/schemas/signup"}}},"correlationId":{"description":"Default Correlation ID","location":"$message.header#/correlationId"},"traits":[{"$ref":"#/components/messageTraits/commonHeaders"}],"examples":[{"name":"SimpleSignup","summary":"A simple UserSignup example message","headers":{"correlationId":"my-correlation-id","applicationInstanceId":"myInstanceId"},"payload":{"user":{"someUserKey":"someUserValue"},"signup":{"someSignupKey":"someSignupValue"}}}]}, {"messageId":"userSignup","name":"UserSignup","title":"User signup","summary":"Action to sign a user up.","description":"A longer description","tags":[{"name":"user"},{"name":"signup"},{"name":"register"}],"schemaFormat":"application/vnd.apache.avro+json;version=1.9.0","payload":{"$ref":"path/to/user-create.avsc#/UserCreate"}}
operationTrait object

Describes a trait that MAY be applied to an Operation Object.

Examples:
  • { "bindings": { "amqp": { "ack": false } } }
summary string

A short summary of what the operation is about.

description string

A verbose explanation of the operation.

tags tag[]

A list of tags for logical grouping and categorization of operations.

uniqueItems=true
externalDocs object

Allows referencing an external resource for extended documentation.

Examples: {"description":"Find more info here","url":"https://example.com"}
2 nested properties
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

operationId string

Unique string used to identify the operation. The id MUST be unique among all operations described in the API.

security SecurityRequirement[]

A declaration of which security mechanisms are associated with this operation.

bindings object

Map describing protocol-specific definitions for a server.

18 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
message Reference | object | object

Describes a message received on a given channel and operation.

Examples:
  • { "messageId": "userSignup", "name": "UserSignup", "title": "User signup", "summary": "Action to sign a user up.", "description": "A longer description", "contentType": "application/json", "tags": [ { "name": "user" }, { "name": "signup" }, { "name": "register" } ], "headers": { "type": "object", "properties": { "correlationId": { "description": "Correlation ID set by application", "type": "string" }, "applicationInstanceId": { "description": "Unique identifier for a given instance of the publishing application", "type": "string" } } }, "payload": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/userCreate" }, "signup": { "$ref": "#/components/schemas/signup" } } }, "correlationId": { "description": "Default Correlation ID", "location": "$message.header#/correlationId" }, "traits": [ { "$ref": "#/components/messageTraits/commonHeaders" } ], "examples": [ { "name": "SimpleSignup", "summary": "A simple UserSignup example message", "headers": { "correlationId": "my-correlation-id", "applicationInstanceId": "myInstanceId" }, "payload": { "user": { "someUserKey": "someUserValue" }, "signup": { "someSignupKey": "someSignupValue" } } } ] }
  • { "messageId": "userSignup", "name": "UserSignup", "title": "User signup", "summary": "Action to sign a user up.", "description": "A longer description", "tags": [ { "name": "user" }, { "name": "signup" }, { "name": "register" } ], "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", "payload": { "$ref": "path/to/user-create.avsc#/UserCreate" } }
correlationId object

An object that specifies an identifier at design time that can used for message tracing and correlation.

Examples:
  • { "description": "Default Correlation ID", "location": "$message.header#/correlationId" }
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

Describes a trait that MAY be applied to a Message Object.

Examples:
  • { "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", "contentType": "application/json" }
schemaFormat string

A string containing the name of the schema format/language used to define the message payload.

contentType string

The content type to use when encoding/decoding a message's payload.

headers

Schema definition of the application headers.

All of: schema, variant
messageId string

Unique string used to identify the message. The id MUST be unique among all messages described in the API.

correlationId Reference | correlationId

Definition of the correlation ID used for message tracing or matching.

tags tag[]

A list of tags for logical grouping and categorization of messages.

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

Allows referencing an external resource for extended documentation.

Examples: {"description":"Find more info here","url":"https://example.com"}
2 nested properties
url string required

The URL for the target documentation. This MUST be in the form of an absolute URL.

format=uri
description string

A short description of the target documentation.

deprecated boolean
Default: false
examples object[]

List of examples.

bindings object

Map describing protocol-specific definitions for a server.

18 nested properties
http
ws
amqp
amqp1
mqtt
mqtt5
kafka
anypointmq
nats
jms
sns
sqs
stomp
redis
ibmmq
solace
googlepubsub
pulsar
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

Holds a set of reusable objects for different aspects of the AsyncAPI specification. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

Examples:
  • { "components": { "schemas": { "Category": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Tag": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "servers": { "development": { "url": "{stage}.gigantic-server.com:{port}", "description": "Development server", "protocol": "amqp", "protocolVersion": "0.9.1", "variables": { "stage": { "$ref": "#/components/serverVariables/stage" }, "port": { "$ref": "#/components/serverVariables/port" } } } }, "serverVariables": { "stage": { "default": "demo", "description": "This value is assigned by the service provider, in this example `gigantic-server.com`" }, "port": { "enum": [ "8883", "8884" ], "default": "8883" } }, "channels": { "user/signedup": { "subscribe": { "message": { "$ref": "#/components/messages/userSignUp" } } } }, "messages": { "userSignUp": { "summary": "Action to sign a user up.", "description": "Multiline description of what this action does.\nHere you have another line.\n", "tags": [ { "name": "user" }, { "name": "signup" } ], "headers": { "type": "object", "properties": { "applicationInstanceId": { "description": "Unique identifier for a given instance of the publishing application", "type": "string" } } }, "payload": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/userCreate" }, "signup": { "$ref": "#/components/schemas/signup" } } } } }, "parameters": { "userId": { "description": "Id of the user.", "schema": { "type": "string" } } }, "correlationIds": { "default": { "description": "Default Correlation ID", "location": "$message.header#/correlationId" } }, "messageTraits": { "commonHeaders": { "headers": { "type": "object", "properties": { "my-app-header": { "type": "integer", "minimum": 0, "maximum": 100 } } } } } } }
schemas Record<string, schema>

JSON objects describing schemas the API uses.

servers Record<string, Reference | server>

The Servers Object is a map of Server Objects.

Examples: {"development":{"url":"development.gigantic-server.com","description":"Development server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:development","description":"This environment is meant for developers to run their own tests"}]},"staging":{"url":"staging.gigantic-server.com","description":"Staging server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:staging","description":"This environment is a replica of the production environment"}]},"production":{"url":"api.gigantic-server.com","description":"Production server","protocol":"amqp","protocolVersion":"0.9.1","tags":[{"name":"env:production","description":"This environment is the live environment available for final users"}]}}
channels Record<string, object>

Holds the relative paths to the individual channel and their operations. Channel paths are relative to servers.

Examples: {"user/signedup":{"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
serverVariables Record<string, Reference | serverVariable>

A map between a variable name and its value. The value is used for substitution in the server's URL template.

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 reusable channel parameters.

Examples: {"user/{userId}/signup":{"parameters":{"userId":{"description":"Id of the user.","schema":{"type":"string"}}},"subscribe":{"message":{"$ref":"#/components/messages/userSignedUp"}}}}
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

Defines a security scheme that can be used by the operations.

Examples:
  • { "type": "userPassword" }
userPassword object
Examples:
  • { "type": "userPassword" }
type string required

The type of the security scheme.

Values: "userPassword"
description string

A short description for security scheme.

apiKey object
Examples:
  • { "type": "apiKey", "in": "user" }
type string required

The type of the security scheme.

Values: "apiKey"
in string required

The location of the API key.

Values: "user" "password"
description string

A short description for security scheme.

X509 object
Examples:
  • { "type": "X509" }
type string required

The type of the security scheme.

Values: "X509"
description string

A short description for security scheme.

symmetricEncryption object
Examples:
  • { "type": "symmetricEncryption" }
type string required

The type of the security scheme.

Values: "symmetricEncryption"
description string

A short description for security scheme.

asymmetricEncryption object
type string required

The type of the security scheme.

Values: "asymmetricEncryption"
description string

A short description for security scheme.

HTTPSecurityScheme NonBearerHTTPSecurityScheme | BearerHTTPSecurityScheme | APIKeyHTTPSecurityScheme
NonBearerHTTPSecurityScheme object
scheme string required

The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.

type string required

The type of the security scheme.

Values: "http"
description string

A short description for security scheme.

BearerHTTPSecurityScheme object
scheme string required

The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.

Values: "bearer"
type string required

The type of the security scheme.

Values: "http"
bearerFormat string

A hint to the client to identify how the bearer token is formatted.

description string

A short description for security scheme.

APIKeyHTTPSecurityScheme object
Examples:
  • { "type": "httpApiKey", "name": "api_key", "in": "header" }
type string required

The type of the security scheme.

Values: "httpApiKey"
name string required

The name of the header, query or cookie parameter to be used.

in string required

The location of the API key.

Values: "header" "query" "cookie"
description string

A short description for security scheme.

oauth2Flows object

Allows configuration of the supported OAuth Flows.

type string required

A short description for security scheme.

Values: "oauth2"
flows object required
4 nested properties
implicit

Configuration for the OAuth Implicit flow.

All of: oauth2Flow object, variant, variant
password

Configuration for the OAuth Resource Owner Protected Credentials flow.

All of: oauth2Flow object, variant, variant
clientCredentials

Configuration for the OAuth Client Credentials flow.

All of: oauth2Flow object, variant, variant
authorizationCode

Configuration for the OAuth Authorization Code flow.

All of: oauth2Flow object, variant
description string

A short description for security scheme.

oauth2Flow object

Configuration details for a supported OAuth Flow

Examples:
  • { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "https://example.com/api/oauth/dialog", "scopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" } }, "authorizationCode": { "authorizationUrl": "https://example.com/api/oauth/dialog", "tokenUrl": "https://example.com/api/oauth/token", "scopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" } } } }
authorizationUrl string

The authorization URL to be used for this flow. This MUST be in the form of an absolute URL.

format=uri
tokenUrl string

The token URL to be used for this flow. This MUST be in the form of an absolute URL.

format=uri
refreshUrl string

The URL to be used for obtaining refresh tokens. This MUST be in the form of an absolute URL.

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
Examples:
  • { "type": "scramSha512" }
type string required

The type of the security scheme. Valid values

Values: "plain"
description string

A short description for security scheme.

SaslScramSecurityScheme object
Examples:
  • { "type": "scramSha512" }
type string required

The type of the security scheme.

Values: "scramSha256" "scramSha512"
description string

A short description for security scheme.

SaslGssapiSecurityScheme object
Examples:
  • { "type": "scramSha512" }
type string required

The type of the security scheme.

Values: "gssapi"
description string

A short description for security scheme.