covenix / OpenApiOptions
Interface: OpenApiOptions
Defined in: src/swagger.ts:19
Optional inputs for OpenAPI generation beyond the controllers themselves.
Properties
externalDocs?
optionalexternalDocs?:ExternalDocumentationObject
Defined in: src/swagger.ts:31
Top-level externalDocs for the document.
schemas?
optionalschemas?:ZodType<unknown,unknown,$ZodTypeInternals<unknown,unknown>>[]
Defined in: src/swagger.ts:43
Standalone schemas to emit under components.schemas, in addition to those referenced by routes. Each must be named via .meta({ id }). Useful for types not tied to any HTTP route (e.g. WebSocket message shapes) so client generators still produce them.
securitySchemes?
optionalsecuritySchemes?:SecuritySchemes
Defined in: src/swagger.ts:25
Security scheme definitions to emit under components.securitySchemes. The Covenix instance derives these from its security config; pass them explicitly to generateSwagger for instance-free generation.
servers?
optionalservers?:ServerObject[]
Defined in: src/swagger.ts:29
servers array for the document (base URLs).
specVersion?
optionalspecVersion?:SpecVersion
Defined in: src/swagger.ts:27
OpenAPI spec version to emit. Defaults to '3.1'.
tags?
optionaltags?:TagObject[]
Defined in: src/swagger.ts:36
Top-level tags array — tag definitions with descriptions. The tag names on operations come from @Tags; this adds their descriptions/metadata.