Saltar al contenido

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

Interfaz: Schema3 ​

Definido en: packages/runtime/src/swagger/swagger.ts:399

Extensión ​

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

Indexable ​

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

Propiedades ​

$ref? ​

ts
optional $ref?: string;

Definido en: packages/runtime/src/swagger/swagger.ts:341

Inhered from ​

ts
Omit.$ref

additionalProperties? ​

ts
optional additionalProperties?: boolean | Schema3;

Definido en: packages/runtime/src/swagger/swagger.ts:402


allOf? ​

ts
optional allOf?: Schema3[];

Definido en: packages/runtime/src/swagger/swagger.ts:405


anyOf? ​

ts
optional anyOf?: Schema3[];

Definido en: packages/runtime/src/swagger/swagger.ts:404


default? ​

ts
optional default?: unknown;

Definido en: packages/runtime/src/swagger/swagger.ts:345

Inhered from ​

ts
Omit.default

deprecated? ​

ts
optional deprecated?: boolean;

Definido en: packages/runtime/src/swagger/swagger.ts:406


description? ​

ts
optional description?: string;

Definido en: packages/runtime/src/swagger/swagger.ts:343

Inhered from ​

ts
Omit.description

discriminator? ​

ts
optional discriminator?: string;

Definido en: packages/runtime/src/swagger/swagger.ts:365

Inhered from ​

ts
Omit.discriminator

enum? ​

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

Definido en: packages/runtime/src/swagger/swagger.ts:357

Inhered from ​

ts
Omit.enum

example? ​

ts
optional example?: unknown;

Definido en: packages/runtime/src/swagger/swagger.ts:369

Inhered from ​

ts
Omit.example

exclusiveMaximum? ​

ts
optional exclusiveMaximum?: boolean;

Definido en: packages/runtime/src/swagger/swagger.ts:407


exclusiveMinimum? ​

ts
optional exclusiveMinimum?: boolean;

Definido en: packages/runtime/src/swagger/swagger.ts:408


externalDocs? ​

ts
optional externalDocs?: ExternalDocs;

Definido en: packages/runtime/src/swagger/swagger.ts:368

Inhered from ​

ts
Omit.externalDocs

format? ​

ts
optional format?: DataFormat;

Definido en: packages/runtime/src/swagger/swagger.ts:340

Inhered from ​

ts
Omit.format

items? ​

ts
optional items?: Schema3;

Definido en: packages/runtime/src/swagger/swagger.ts:403


maximum? ​

ts
optional maximum?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:347

Inhered from ​

ts
Omit.maximum

maxItems? ​

ts
optional maxItems?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:352

Inhered from ​

ts
Omit.maxItems

maxLength? ​

ts
optional maxLength?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:349

Inhered from ​

ts
Omit.maxLength

maxProperties? ​

ts
optional maxProperties?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:355

Inhered from ​

ts
Omit.maxProperties

minimum? ​

ts
optional minimum?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:348

Inhered from ​

ts
Omit.minimum

minItems? ​

ts
optional minItems?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:353

Inhered from ​

ts
Omit.minItems

minLength? ​

ts
optional minLength?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:350

Inhered from ​

ts
Omit.minLength

minProperties? ​

ts
optional minProperties?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:356

Inhered from ​

ts
Omit.minProperties

multipleOf? ​

ts
optional multipleOf?: number;

Definido en: packages/runtime/src/swagger/swagger.ts:346

Inhered from ​

ts
Omit.multipleOf

nullable? ​

ts
optional nullable?: boolean;

Definido en: packages/runtime/src/swagger/swagger.ts:401


pattern? ​

ts
optional pattern?: string;

Definido en: packages/runtime/src/swagger/swagger.ts:351

Inhered from ​

ts
Omit.pattern

properties? ​

ts
optional properties?: object;

Definido en: packages/runtime/src/swagger/swagger.ts:409

Index Signature ​

ts
[propertyName: string]: Schema3

readOnly? ​

ts
optional readOnly?: boolean;

Definido en: packages/runtime/src/swagger/swagger.ts:366

Inhered from ​

ts
Omit.readOnly

required? ​

ts
optional required?: string[];

Definido en: packages/runtime/src/swagger/swagger.ts:370

Inhered from ​

ts
Omit.required

title? ​

ts
optional title?: string;

Definido en: packages/runtime/src/swagger/swagger.ts:342

Inhered from ​

ts
Omit.title

type? ​

ts
optional type?: DataType;

Definido en: packages/runtime/src/swagger/swagger.ts:400


uniqueItems? ​

ts
optional uniqueItems?: boolean;

Definido en: packages/runtime/src/swagger/swagger.ts:354

Inhered from ​

ts
Omit.uniqueItems

xml? ​

ts
optional xml?: XML;

Definido en: packages/runtime/src/swagger/swagger.ts:367

Inhered from ​

ts
Omit.xml

Contributors

No contributors

Changelog

No recent changes

Generación de OpenAPI, generación de rutas y validación en tiempo de ejecución con prioridad en TypeScript.