tsoa-next / @tsoa-next/runtime / Swagger / BaseSchema

Interface: BaseSchema<P>

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

Type Parameters

P

P = unknown

Indexable

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

Properties

$ref?

optional $ref?: string;

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

---

additionalProperties?

optional additionalProperties?: boolean | BaseSchema<unknown>;

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

---

default?

optional default?: unknown;

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

---

description?

optional description?: string;

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

---

discriminator?

optional discriminator?: string;

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

---

enum?

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

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

---

example?

optional example?: unknown;

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

---

externalDocs?

optional externalDocs?: ExternalDocs;

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

---

format?

optional format?: DataFormat;

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

---

items?

optional items?: BaseSchema<unknown>;

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

---

maximum?

optional maximum?: number;

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

---

maxItems?

optional maxItems?: number;

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

---

maxLength?

optional maxLength?: number;

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

---

maxProperties?

optional maxProperties?: number;

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

---

minimum?

optional minimum?: number;

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

---

minItems?

optional minItems?: number;

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

---

minLength?

optional minLength?: number;

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

---

minProperties?

optional minProperties?: number;

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

---

multipleOf?

optional multipleOf?: number;

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

---

pattern?

optional pattern?: string;

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

---

properties?

optional properties?: object;

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

Index Signature

[propertyName: string]: P

---

readOnly?

optional readOnly?: boolean;

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

---

required?

optional required?: string[];

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

---

title?

optional title?: string;

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

---

type?

optional type?: string;

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

---

uniqueItems?

optional uniqueItems?: boolean;

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

---

x-enum-varnames?

optional x-enum-varnames?: string[];

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

---

xml?

optional xml?: XML;

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