tsoa-next
    Preparing search index...

    Interface BaseSchema<P>

    interface BaseSchema<P = unknown> {
        $ref?: string;
        additionalProperties?: boolean | Swagger.BaseSchema<unknown>;
        default?: unknown;
        description?: string;
        discriminator?: string;
        enum?: (string | number | boolean | null)[];
        example?: unknown;
        externalDocs?: Swagger.ExternalDocs;
        format?: Swagger.DataFormat;
        items?: Swagger.BaseSchema<unknown>;
        maximum?: number;
        maxItems?: number;
        maxLength?: number;
        maxProperties?: number;
        minimum?: number;
        minItems?: number;
        minLength?: number;
        minProperties?: number;
        multipleOf?: number;
        pattern?: string;
        properties?: { [propertyName: string]: P };
        readOnly?: boolean;
        required?: string[];
        title?: string;
        type?: string;
        uniqueItems?: boolean;
        "x-enum-varnames"?: string[];
        xml?: Swagger.XML;
        [ext: `x-${string}`]: unknown;
    }

    Type Parameters

    • P = unknown

    Indexable

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

    Properties

    $ref?: string
    additionalProperties?: boolean | Swagger.BaseSchema<unknown>
    default?: unknown
    description?: string
    discriminator?: string
    enum?: (string | number | boolean | null)[]
    example?: unknown
    externalDocs?: Swagger.ExternalDocs
    items?: Swagger.BaseSchema<unknown>
    maximum?: number
    maxItems?: number
    maxLength?: number
    maxProperties?: number
    minimum?: number
    minItems?: number
    minLength?: number
    minProperties?: number
    multipleOf?: number
    pattern?: string
    properties?: { [propertyName: string]: P }
    readOnly?: boolean
    required?: string[]
    title?: string
    type?: string
    uniqueItems?: boolean
    "x-enum-varnames"?: string[]
    xml?: Swagger.XML