covenix

Appearance

covenix / RouteMetadata

Interface: RouteMetadata ​

Defined in: src/metadata.ts:37

Assembled metadata for a single route, as returned by getRoutes.

Properties ​

body? ​

optional body?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: src/metadata.ts:53

@Body schema, if any.

cookies? ​

optional cookies?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: src/metadata.ts:51

@Cookies schema (validates req.cookies), if any.

deprecated? ​

optional deprecated?: boolean

Defined in: src/metadata.ts:65

Whether the operation is marked @Deprecated.

description? ​

optional description?: string

Defined in: src/metadata.ts:61

@Description text (the operation's long description), if any.

examples? ​

optional examples?: ExampleMetadata[]

Defined in: src/metadata.ts:67

Example values (from @Example) for the request body and/or responses.

handlerName ​

handlerName: string

Defined in: src/metadata.ts:43

Name of the controller method that handles the route.

headers? ​

optional headers?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: src/metadata.ts:49

@Headers schema (validates req.headers), if any.

method ​

method: HttpMethod

Defined in: src/metadata.ts:39

HTTP method.

middleware? ​

optional middleware?: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]

Defined in: src/metadata.ts:78

Express middleware (from @Use) to run before the handler — class-level first, then method-level, in source order.

operationId? ​

optional operationId?: string

Defined in: src/metadata.ts:63

@OperationId value (unique operation identifier), if any.

params? ​

optional params?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: src/metadata.ts:45

@Params schema, if any.

path ​

path: string

Defined in: src/metadata.ts:41

Route sub-path (controller prefix is applied separately).

query? ​

optional query?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: src/metadata.ts:47

@Query schema, if any.

responses ​

responses: Record<number, ResponseMetadata>

Defined in: src/metadata.ts:55

Declared responses, keyed by status code. One entry per declared status.

security? ​

optional security?: SecurityRequirement[]

Defined in: src/metadata.ts:73

Security requirements (from @Security), each a scheme name + required scopes. Stacked @Security decorators are alternatives (OR); the route is allowed if any one is satisfied. Empty/absent means the route is public.

summary? ​

optional summary?: string

Defined in: src/metadata.ts:59

@Summary text, if any.

tags? ​

optional tags?: string[]

Defined in: src/metadata.ts:57

Class-level @Tags, folded onto each route.