covenix / CovenixOptions
Interface: CovenixOptions
Defined in: src/covenix.ts:63
Options for constructing a Covenix instance.
Properties
externalDocs?
optionalexternalDocs?:ExternalDocumentationObject
Defined in: src/covenix.ts:69
Top-level externalDocs for the generated document.
info
info:
InfoObject
Defined in: src/covenix.ts:65
OpenAPI info block (title + version required; rest optional).
multipart?
optionalmultipart?:Options
Defined in: src/covenix.ts:79
multer options for multipart/form-data (file-upload) routes, passed straight through to multer. Defaults to in-memory storage, so handlers receive a File backed by the uploaded bytes. Set storage for disk/custom storage and limits.fileSize to reject oversized uploads before buffering (a per-field z.file().max() only runs once the bytes are in hand).
security?
optionalsecurity?:SecurityConfig
Defined in: src/covenix.ts:85
Named security schemes referenced by @Security. Each entry pairs an OpenAPI scheme definition with a runtime handler (use the bearer/apiKey/… builders). The scheme definitions are emitted under components.securitySchemes.
servers?
optionalservers?:ServerObject[]
Defined in: src/covenix.ts:67
servers array for the generated document (base URLs).
tags?
optionaltags?:TagObject[]
Defined in: src/covenix.ts:71
Top-level tags definitions (descriptions for the names used by @Tags).