Saltar al contenido

tsoa-next / tsoa-next / Swagger / BaseSchema

Interfaz: BaseSchema<P>

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

Parámetros tipo

P

P = unknown

Indexable

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

Propiedades

$ref?

ts
optional $ref?: string;

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


additionalProperties?

ts
optional additionalProperties?: boolean | BaseSchema<unknown>;

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


default?

ts
optional default?: unknown;

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


description?

ts
optional description?: string;

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


discriminator?

ts
optional discriminator?: string;

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


enum?

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

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


example?

ts
optional example?: unknown;

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


externalDocs?

ts
optional externalDocs?: ExternalDocs;

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


format?

ts
optional format?: DataFormat;

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


items?

ts
optional items?: BaseSchema<unknown>;

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


maximum?

ts
optional maximum?: number;

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


maxItems?

ts
optional maxItems?: number;

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


maxLength?

ts
optional maxLength?: number;

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


maxProperties?

ts
optional maxProperties?: number;

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


minimum?

ts
optional minimum?: number;

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


minItems?

ts
optional minItems?: number;

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


minLength?

ts
optional minLength?: number;

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


minProperties?

ts
optional minProperties?: number;

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


multipleOf?

ts
optional multipleOf?: number;

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


pattern?

ts
optional pattern?: string;

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


properties?

ts
optional properties?: object;

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

Index Signature

ts
[propertyName: string]: P

readOnly?

ts
optional readOnly?: boolean;

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


required?

ts
optional required?: string[];

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


title?

ts
optional title?: string;

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


type?

ts
optional type?: string;

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


uniqueItems?

ts
optional uniqueItems?: boolean;

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


x-enum-varnames?

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

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


xml?

ts
optional xml?: XML;

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

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.