Modelina
    Preparing search index...

    Class OpenapiV3Schema

    OpenAPI 3.0 -> 3.0.4 schema model

    Based on Draft 6, but with restricted keywords and definitions Modifications

    • type, cannot be an array nor contain 'null'

    Restrictions (keywords not allowed)

    • patternProperties
    • not

    https://swagger.io/specification/#schema-object

    Indexable

    • [k: string]: any
    Index

    Constructors

    constructor

    Properties

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

    Methods

    toSchema

    Constructors

    Properties

    $id?: string
    $ref?: string
    $schema?: string
    additionalItems?: boolean | OpenapiV3Schema
    additionalProperties?: boolean | OpenapiV3Schema
    allOf?: (boolean | OpenapiV3Schema)[]
    anyOf?: (boolean | OpenapiV3Schema)[]
    const?: any
    contains?: boolean | OpenapiV3Schema
    contentEncoding?: string
    contentMediaType?: string
    default?: any
    definitions?: { [key: string]: boolean | OpenapiV3Schema }
    dependencies?: { [key: string]: boolean | string[] | OpenapiV3Schema }
    deprecated?: boolean
    description?: string
    discriminator?: OpenapiV3Discriminator
    enum?: any[]
    example?: any
    examples?: any
    exclusiveMaximum?: number | boolean
    exclusiveMinimum?: number | boolean
    externalDocs?: OpenAPIV3ExternalDocumentation
    format?: string
    items?: boolean | OpenapiV3Schema | OpenapiV3Schema[]
    maximum?: number
    maxItems?: number
    maxLength?: number
    maxProperties?: number
    minimum?: number
    minItems?: number
    minLength?: number
    minProperties?: number
    multipleOf?: number
    nullable?: boolean
    oneOf?: (boolean | OpenapiV3Schema)[]
    pattern?: string
    properties?: { [key: string]: boolean | OpenapiV3Schema }
    propertyNames?: boolean | OpenapiV3Schema
    readOnly?: boolean
    required?: string[]
    title?: string
    type?: string | string[]
    uniqueItems?: boolean
    writeOnly?: boolean
    xml?: OpenapiV3Xml

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods