tsoa-next / @tsoa-next/runtime / Swagger / Header

Interface: Header

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

Properties

collectionFormat?

optional collectionFormat?: "csv" | "ssv" | "tsv" | "pipes" | "multi";

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

---

default?

optional default?: unknown;

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

---

description?

optional description?: string;

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

---

enum?

optional enum?: (string | number | null)[];

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

---

exclusiveMaximum?

optional exclusiveMaximum?: boolean;

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

---

exclusiveMinimum?

optional exclusiveMinimum?: boolean;

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

---

format?

optional format?: string;

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

---

items?

optional items?: BaseSchema<unknown>;

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

---

maximum?

optional maximum?: number;

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

---

maxItems?

optional maxItems?: number;

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

---

maxLength?

optional maxLength?: number;

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

---

minimum?

optional minimum?: number;

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

---

minItems?

optional minItems?: number;

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

---

minLength?

optional minLength?: number;

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

---

multipleOf?

optional multipleOf?: number;

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

---

pattern?

optional pattern?: string;

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

---

type

type: "string" | "number" | "boolean" | "integer" | "array";

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

---

uniqueItems?

optional uniqueItems?: boolean;

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