tsoa-next / @tsoa-next/runtime / Swagger / Parameter3

Interface: Parameter3

Defined in: packages/runtime/src/swagger/swagger.ts:194

Extends

• ParameterCommonFields

Indexable

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

Properties

allowReserved?

optional allowReserved?: boolean;

Defined in: packages/runtime/src/swagger/swagger.ts:200

---

deprecated?

optional deprecated?: boolean;

Defined in: packages/runtime/src/swagger/swagger.ts:196

---

description?

optional description?: string;

Defined in: packages/runtime/src/swagger/swagger.ts:137

Inherited from

ParameterCommonFields.description

---

example?

optional example?: unknown;

Defined in: packages/runtime/src/swagger/swagger.ts:201

---

examples?

optional examples?: object;

Defined in: packages/runtime/src/swagger/swagger.ts:202

Index Signature

[name: string]: string | Example3

---

explode?

optional explode?: boolean;

Defined in: packages/runtime/src/swagger/swagger.ts:199

---

in

in: "cookie" | "path" | "query" | "header";

Defined in: packages/runtime/src/swagger/swagger.ts:195

---

name

name: string;

Defined in: packages/runtime/src/swagger/swagger.ts:135

Inherited from

ParameterCommonFields.name

---

required?

optional required?: boolean;

Defined in: packages/runtime/src/swagger/swagger.ts:136

Inherited from

ParameterCommonFields.required

---

schema

schema: Schema3;

Defined in: packages/runtime/src/swagger/swagger.ts:197

---

style?

optional style?: string;

Defined in: packages/runtime/src/swagger/swagger.ts:198