Modelina
    Preparing search index...

    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
    Index

    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? maximum? maxItems? maxLength? maxProperties? minimum? minItems? minLength? minProperties? multipleOf? not? oneOf? pattern? patternProperties? properties? propertyNames? readOnly? required? then? title? type? uniqueItems? writeOnly?

    Methods

    toSchema

    Constructors

    Properties

    $comment?: string
    $id?: string
    $ref?: string
    $schema?: string
    additionalItems?: boolean | AsyncapiV2Schema
    additionalProperties?: boolean | AsyncapiV2Schema
    allOf?: (boolean | AsyncapiV2Schema)[]
    anyOf?: (boolean | AsyncapiV2Schema)[]
    const?: any
    contains?: boolean | AsyncapiV2Schema
    contentEncoding?: string
    contentMediaType?: string
    default?: any
    definitions?: { [key: string]: boolean | AsyncapiV2Schema }
    dependencies?: { [key: string]: boolean | string[] | AsyncapiV2Schema }
    deprecated?: boolean
    description?: string
    discriminator?: string
    else?: boolean | AsyncapiV2Schema
    enum?: any[]
    examples?: any[]
    exclusiveMaximum?: number
    exclusiveMinimum?: number
    externalDocs?: AsyncapiV2ExternalDocumentation
    format?: string
    if?: boolean | AsyncapiV2Schema
    items?: boolean | AsyncapiV2Schema | AsyncapiV2Schema[]
    maximum?: number
    maxItems?: number
    maxLength?: number
    maxProperties?: number
    minimum?: number
    minItems?: number
    minLength?: number
    minProperties?: number
    multipleOf?: number
    not?: boolean | AsyncapiV2Schema
    oneOf?: (boolean | AsyncapiV2Schema)[]
    pattern?: string
    patternProperties?: { [key: string]: boolean | AsyncapiV2Schema }
    properties?: { [key: string]: boolean | AsyncapiV2Schema }
    propertyNames?: boolean | AsyncapiV2Schema
    readOnly?: boolean
    required?: string[]
    then?: boolean | AsyncapiV2Schema
    title?: string
    type?: string | string[]
    uniqueItems?: boolean
    writeOnly?: boolean

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods