tsoa-next / @tsoa-next/runtime / Swagger / Schema3

Interface: Schema3

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

Extends

• Omit<BaseSchema, "additionalProperties" | "items" | "properties" | "type">

Indexable

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

Properties

$ref?

optional $ref?: string;

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

Inherited from

Omit.$ref

---

additionalProperties?

optional additionalProperties?: boolean | Schema3;

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

---

allOf?

optional allOf?: Schema3[];

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

---

anyOf?

optional anyOf?: Schema3[];

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

---

default?

optional default?: unknown;

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

Inherited from

Omit.default

---

deprecated?

optional deprecated?: boolean;

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

---

description?

optional description?: string;

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

Inherited from

Omit.description

---

discriminator?

optional discriminator?: string;

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

Inherited from

Omit.discriminator

---

enum?

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

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

Inherited from

Omit.enum

---

example?

optional example?: unknown;

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

Inherited from

Omit.example

---

exclusiveMaximum?

optional exclusiveMaximum?: boolean;

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

---

exclusiveMinimum?

optional exclusiveMinimum?: boolean;

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

---

externalDocs?

optional externalDocs?: ExternalDocs;

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

Inherited from

Omit.externalDocs

---

format?

optional format?: DataFormat;

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

Inherited from

Omit.format

---

items?

optional items?: Schema3;

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

---

maximum?

optional maximum?: number;

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

Inherited from

Omit.maximum

---

maxItems?

optional maxItems?: number;

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

Inherited from

Omit.maxItems

---

maxLength?

optional maxLength?: number;

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

Inherited from

Omit.maxLength

---

maxProperties?

optional maxProperties?: number;

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

Inherited from

Omit.maxProperties

---

minimum?

optional minimum?: number;

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

Inherited from

Omit.minimum

---

minItems?

optional minItems?: number;

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

Inherited from

Omit.minItems

---

minLength?

optional minLength?: number;

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

Inherited from

Omit.minLength

---

minProperties?

optional minProperties?: number;

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

Inherited from

Omit.minProperties

---

multipleOf?

optional multipleOf?: number;

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

Inherited from

Omit.multipleOf

---

nullable?

optional nullable?: boolean;

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

---

pattern?

optional pattern?: string;

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

Inherited from

Omit.pattern

---

properties?

optional properties?: object;

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

Index Signature

[propertyName: string]: Schema3

---

readOnly?

optional readOnly?: boolean;

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

Inherited from

Omit.readOnly

---

required?

optional required?: string[];

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

Inherited from

Omit.required

---

title?

optional title?: string;

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

Inherited from

Omit.title

---

type?

optional type?: DataType;

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

---

uniqueItems?

optional uniqueItems?: boolean;

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

Inherited from

Omit.uniqueItems

---

xml?

optional xml?: XML;

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

Inherited from

Omit.xml