Class AsyncapiV2Schema

AsyncAPI schema model

Based on Draft 7 with additions

https://www.asyncapi.com/docs/specifications/v2.0.0#schemaObject https://www.asyncapi.com/docs/specifications/v2.1.0#schemaObject https://www.asyncapi.com/docs/specifications/v2.2.0#schemaObject https://www.asyncapi.com/docs/specifications/v2.3.0#schemaObject

Indexable

[k: string]: any

Constructors

constructor

Properties

$comment? $id? $ref? $schema? additionalItems? additionalProperties? allOf? anyOf? const? contains? contentEncoding? contentMediaType? default? definitions? dependencies? deprecated? description? discriminator? else? enum? examples? exclusiveMaximum? exclusiveMinimum? externalDocs? format? if? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? not? oneOf? pattern? patternProperties? properties? propertyNames? readOnly? required? then? title? type? uniqueItems? writeOnly?

Methods

internalToSchema toSchema

Constructors

constructor

Properties

Optional $comment

$comment?: string

Optional $id

$id?: string

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: boolean | AsyncapiV2Schema

Optional additionalProperties

additionalProperties?: boolean | AsyncapiV2Schema

Optional allOf

allOf?: (boolean | AsyncapiV2Schema)[]

Optional anyOf

anyOf?: (boolean | AsyncapiV2Schema)[]

Optional const

const?: any

Optional contains

contains?: boolean | AsyncapiV2Schema

Optional contentEncoding

contentEncoding?: string

Optional contentMediaType

contentMediaType?: string

Optional default

default?: any

Optional definitions

definitions?: {
    [key: string]: AsyncapiV2Schema | boolean;
}

Type declaration

Optional dependencies

dependencies?: {
    [key: string]: AsyncapiV2Schema | boolean | string[];
}

Type declaration

Optional deprecated

deprecated?: boolean

Optional description

description?: string

Optional discriminator

discriminator?: string

Optional else

else?: boolean | AsyncapiV2Schema

Optional enum

enum?: any[]

Optional examples

examples?: any[]

Optional exclusiveMaximum

exclusiveMaximum?: number

Optional exclusiveMinimum

exclusiveMinimum?: number

Optional externalDocs

externalDocs?: AsyncapiV2ExternalDocumentation

Optional format

format?: string

Optional if

if?: boolean | AsyncapiV2Schema

Optional items

items?: boolean | AsyncapiV2Schema | AsyncapiV2Schema[]

Optional maxItems

maxItems?: number

Optional maxLength

maxLength?: number

Optional maxProperties

maxProperties?: number

Optional maximum

maximum?: number

Optional minItems

minItems?: number

Optional minLength

minLength?: number

Optional minProperties

minProperties?: number

Optional minimum

minimum?: number

Optional multipleOf

multipleOf?: number

Optional not

not?: boolean | AsyncapiV2Schema

Optional oneOf

oneOf?: (boolean | AsyncapiV2Schema)[]

Optional pattern

pattern?: string

Optional patternProperties

patternProperties?: {
    [key: string]: AsyncapiV2Schema | boolean;
}

Type declaration

Optional properties

properties?: {
    [key: string]: AsyncapiV2Schema | boolean;
}

Type declaration

Optional propertyNames

propertyNames?: boolean | AsyncapiV2Schema

Optional readOnly

readOnly?: boolean

Optional required

required?: string[]

Optional then

then?: boolean | AsyncapiV2Schema

Optional title

title?: string

Optional type

type?: string | string[]

Optional uniqueItems

uniqueItems?: boolean

Optional writeOnly

writeOnly?: boolean

Methods

Static Private internalToSchema

Static toSchema

Settings

Member Visibility

Theme

On This Page

constructor$comment$id$ref$schemaadditionalItemsadditionalPropertiesallOfanyOfconstcontainscontentEncodingcontentMediaTypedefaultdefinitionsdependenciesdeprecateddescriptiondiscriminatorelseenumexamplesexclusiveMaximumexclusiveMinimumexternalDocsformatifitemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfnotoneOfpatternpatternPropertiespropertiespropertyNamesreadOnlyrequiredthentitletypeuniqueItemswriteOnlyinternalToSchematoSchema