Interface Schema

interface Schema {
    $ref?: string;
    additionalProperties?: boolean | Swagger.BaseSchema;
    default?: unknown;
    description?: string;
    discriminator?: string;
    enum?: (null | string | number | boolean)[];
    example?: unknown;
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    externalDocs?: Swagger.ExternalDocs;
    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;
    properties?: {
        [propertyName: string]: Swagger.Schema3;
    };
    readOnly?: boolean;
    required?: string[];
    title?: string;
    type?: Swagger.DataType;
    uniqueItems?: boolean;
    x-enum-varnames?: string[];
    xml?: Swagger.XML;
}

Hierarchy (view full)

Properties

$ref? additionalProperties? default? description? discriminator? enum? example? exclusiveMaximum? exclusiveMinimum? externalDocs? format? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? pattern? properties? readOnly? required? title? type? uniqueItems? x-enum-varnames? xml?

Properties

Optional $ref

$ref?: string

Optional additionalProperties

additionalProperties?: boolean | Swagger.BaseSchema

Optional default

default?: unknown

Optional description

description?: string

Optional discriminator

discriminator?: string

Optional enum

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

Optional example

example?: unknown

Optional exclusiveMaximum

exclusiveMaximum?: number

Optional exclusiveMinimum

exclusiveMinimum?: number

Optional externalDocs

externalDocs?: Swagger.ExternalDocs

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 properties

properties?: {
    [propertyName: string]: Swagger.Schema3;
}

Type declaration

Optional readOnly

readOnly?: boolean

Optional required

required?: string[]

Optional title

title?: string

Optional type

type?: Swagger.DataType

Optional uniqueItems

uniqueItems?: boolean

Optional x-enum-varnames

x-enum-varnames?: string[]

Optional xml

xml?: Swagger.XML

Settings

Member Visibility

Theme

On This Page

$refadditionalPropertiesdefaultdescriptiondiscriminatorenumexampleexclusiveMaximumexclusiveMinimumexternalDocsformatitemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfpatternpropertiesreadOnlyrequiredtitletypeuniqueItemsx-enum-varnamesxml

Generated using TypeDoc