Interface ResParameter

interface ResParameter {
    default?: unknown;
    deprecated: boolean;
    description: string;
    example?: {
        [exampleName: string]: Swagger.Example3;
    }[];
    exampleLabels?: (undefined | string)[];
    examples?: {
        [exampleName: string]: Swagger.Example3;
    }[];
    headers?: Tsoa.HeaderType;
    in: "res";
    name: string;
    parameterName: string;
    produces?: string[];
    required?: boolean;
    schema?: Tsoa.Type;
    type: Tsoa.Type;
    validators: Partial<Record<Tsoa.ValidatorKey, {
        errorMsg?: string;
        value?: unknown;
    }>>;
}

Hierarchy (view full)

Properties

default? deprecated description example? exampleLabels? examples? headers? in name parameterName produces? required? schema? type validators

Properties

Optional default

default?: unknown

deprecated

deprecated: boolean

description

description: string

Optional example

example?: {
    [exampleName: string]: Swagger.Example3;
}[]

Type declaration

Optional exampleLabels

exampleLabels?: (undefined | string)[]

Optional examples

examples?: {
    [exampleName: string]: Swagger.Example3;
}[]

Type declaration

Optional headers

headers?: Tsoa.HeaderType

in

in: "res"

name

name: string

parameterName

parameterName: string

Optional produces

produces?: string[]

Optional required

required?: boolean

Optional schema

schema?: Tsoa.Type

type

type: Tsoa.Type

validators

validators: Partial<Record<Tsoa.ValidatorKey, {
    errorMsg?: string;
    value?: unknown;
}>>

Settings

Member Visibility

Theme

On This Page

defaultdeprecateddescriptionexampleexampleLabelsexamplesheadersinnameparameterNameproducesrequiredschematypevalidators

Generated using TypeDoc