Interface BaseSchema

interface BaseSchema {
    $ref?: string;
    default?: unknown;
    description?: string;
    enum?: (null | string | number | boolean)[];
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    format?: Swagger.DataFormat;
    items?: Swagger.BaseSchema;
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    maximum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    minimum?: number;
    multipleOf?: number;
    pattern?: string;
    title?: string;
    type?: string;
    uniqueItems?: boolean;
    x-enum-varnames?: string[];
    [ext: `x-${string}`]: unknown;
}

Hierarchy (view full)

Indexable

[ext: `x-${string}`]: unknown

Properties

$ref? default? description? enum? exclusiveMaximum? exclusiveMinimum? format? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? pattern? title? type? uniqueItems? x-enum-varnames?

Properties

Optional $ref

$ref?: string

Optional default

default?: unknown

Optional description

description?: string

Optional enum

enum?: (null | string | number | boolean)[]

Optional exclusiveMaximum

exclusiveMaximum?: number

Optional exclusiveMinimum

exclusiveMinimum?: number

Optional format

format?: Swagger.DataFormat

Optional items

items?: Swagger.BaseSchema

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 pattern

pattern?: string

Optional title

title?: string

Optional type

type?: string

Optional uniqueItems

uniqueItems?: boolean

Optional x-enum-varnames

x-enum-varnames?: string[]

Settings

Member Visibility

Theme

On This Page

$refdefaultdescriptionenumexclusiveMaximumexclusiveMinimumformatitemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfpatterntitletypeuniqueItemsx-enum-varnames

Generated using TypeDoc