interface RouteSecurityMetadata
Since 0.2.0

What a middleware function enforces, for documentation generators.

This is a description, not a mechanism: the middleware still performs the enforcement, and removing the metadata changes no runtime behaviour.

It deliberately carries authentication PRESENCE only. An OpenAPI security requirement names a scheme, and no declared scheme can be inferred from a role name, so roles and permissions are not represented here — see @setu-ts/openapi-plugin for what a generated document can and cannot say.

Properties

readonly
authenticated: boolean

true when the middleware requires an authenticated principal; false when it explicitly marks the route public.

Usage

import { type RouteSecurityMetadata } from "common/src/index.ts";