Skip to content

tsoa-next / tsoa-next / Swagger / Spec2

Interface: Spec2 ​

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

Extends ​

Properties ​

basePath? ​

ts
optional basePath?: string;

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


consumes? ​

ts
optional consumes?: string[];

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


definitions? ​

ts
optional definitions?: object;

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

Index Signature ​

ts
[name: string]: Schema2

externalDocs? ​

ts
optional externalDocs?: ExternalDocs;

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

Inherited from ​

Spec.externalDocs


host? ​

ts
optional host?: string;

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


info ​

ts
info: Info;

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

Inherited from ​

Spec.info


parameters? ​

ts
optional parameters?: object;

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

Index Signature ​

ts
[name: string]: Parameter2

paths ​

ts
paths: object;

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

Index Signature ​

ts
[name: string]: Path

produces? ​

ts
optional produces?: string[];

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


responses? ​

ts
optional responses?: object;

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

Index Signature ​

ts
[name: string]: Response

schemes? ​

ts
optional schemes?: Protocol[];

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


security? ​

ts
optional security?: Security[];

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


securityDefinitions? ​

ts
optional securityDefinitions?: object;

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

Index Signature ​

ts
[name: string]: SecuritySchemes

swagger ​

ts
swagger: "2.0";

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


tags? ​

ts
optional tags?: Tag[];

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

Inherited from ​

Spec.tags

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