tsoa-next / tsoa-next / Swagger / Parameter31

Interface: Parameter31

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

Extends

• Omit<Parameter3, "schema">

Indexable

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

Properties

allowReserved?

optional allowReserved?: boolean;

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

Inherited from

Parameter3.allowReserved

---

deprecated?

optional deprecated?: boolean;

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

Inherited from

Parameter3.deprecated

---

description?

optional description?: string;

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

Inherited from

Parameter3.description

---

example?

optional example?: unknown;

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

Inherited from

Parameter3.example

---

examples?

optional examples?: object;

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

Index Signature

[name: string]: string | Example3

Inherited from

Omit.examples

---

explode?

optional explode?: boolean;

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

Inherited from

Parameter3.explode

---

in

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

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

Inherited from

Omit.in

---

name

name: string;

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

Inherited from

Parameter3.name

---

required?

optional required?: boolean;

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

Inherited from

Parameter3.required

---

schema

schema: Schema31;

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

---

style?

optional style?: string;

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

Inherited from

Parameter3.style