Interface Parameter

interface Parameter {
    default?: unknown;
    deprecated: boolean;
    description?: string;
    example?: {
        [exampleName: string]: Swagger.Example3;
    }[];
    exampleLabels?: (undefined | string)[];
    in: "request" | "body" | "path" | "query" | "header" | "formData" | "queries" | "body-prop" | "request-prop" | "res";
    name: string;
    parameterName: string;
    required?: boolean;
    type: Tsoa.Type;
    validators: Partial<Record<Tsoa.ValidatorKey, {
        errorMsg?: string;
        value?: unknown;
    }>>;
}

Hierarchy (view full)

Properties

default?: unknown
deprecated: boolean
description?: string
example?: {
    [exampleName: string]: Swagger.Example3;
}[]

Type declaration

exampleLabels?: (undefined | string)[]
in: "request" | "body" | "path" | "query" | "header" | "formData" | "queries" | "body-prop" | "request-prop" | "res"
name: string
parameterName: string
required?: boolean
type: Tsoa.Type
validators: Partial<Record<Tsoa.ValidatorKey, {
    errorMsg?: string;
    value?: unknown;
}>>

Generated using TypeDoc