Skip to content

tsoa-next / tsoa-next / Swagger / Operation

Interface: Operation

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

Indexable

ts
[key: string]: unknown

Properties

consumes?

ts
optional consumes?: string[];

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


deprecated?

ts
optional deprecated?: boolean;

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


description?

ts
optional description?: string;

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


externalDocs?

ts
optional externalDocs?: ExternalDocs;

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


operationId

ts
operationId: string;

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


parameters?

ts
optional parameters?: Parameter2[];

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


produces?

ts
optional produces?: string[];

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


responses

ts
responses: object;

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

Index Signature

ts
[name: string]: Response

schemes?

ts
optional schemes?: Protocol[];

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


security?

ts
optional security?: Security[];

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


summary?

ts
optional summary?: string;

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


tags?

ts
optional tags?: string[];

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

TypeScript-first OpenAPI generation, route generation, and runtime validation.