tsoa-next / tsoa-next / Swagger / Schema31

Interface: Schema31

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

Extends

• Omit<Schema3, | "items" | "properties" | "additionalProperties" | "discriminator" | "anyOf" | "allOf" | "exclusiveMaximum" | "exclusiveMinimum">

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 | Schema31;

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

---

allOf?

optional allOf?: Schema31[];

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

---

anyOf?

optional anyOf?: Schema31[];

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

---

contains?

optional contains?: Schema31;

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

---

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

Inherited from

Schema3.deprecated

---

description?

optional description?: string;

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

Inherited from

Omit.description

---

discriminator?

optional discriminator?: object;

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

mapping?

optional mapping?: Record<string, string>;

propertyName

propertyName: string;

---

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

---

examples?

optional examples?: unknown[];

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

---

exclusiveMaximum?

optional exclusiveMaximum?: number;

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

---

exclusiveMinimum?

optional exclusiveMinimum?: number;

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

---

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?: false | Schema31;

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

---

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

---

not?

optional not?: Schema31;

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

---

nullable?

optional nullable?: boolean;

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

Inherited from

Schema3.nullable

---

oneOf?

optional oneOf?: Schema31[];

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

---

pattern?

optional pattern?: string;

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

Inherited from

Omit.pattern

---

prefixItems?

optional prefixItems?: Schema31[];

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

---

properties?

optional properties?: object;

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

Index Signature

[key: string]: Schema31

---

propertyNames?

optional propertyNames?: Schema31;

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

---

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

Inherited from

Schema3.type

---

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