Interface EndpointMetadata

Authorization roles required for this endpoint.

• null → no authorization required (public)
• [] → any authenticated user
• ['admin', ...] → user must have at least one of these roles

Cache tags declared via .clearsCacheTag(), providing tag-based cache key computation for the client middleware.

Callbacks declared via .callbacks(), emitted as callbacks on the OpenAPI Operation Object.

A single example value for the request body, emitted as example on the OpenAPI Media Type Object.

A map of named examples for the request body, emitted as examples on the OpenAPI Media Type Object. Each entry follows the OpenAPI Example Object shape.

External documentation URL for this operation, emitted as externalDocs on the OpenAPI Operation Object.

When set, the endpoint accepts multipart/form-data uploads. The configuration controls max file size, allowed MIME types, etc.

Response links declared via .links(), emitted under the primary success response's links map in the OpenAPI spec.

Multiple response content types for content-negotiated endpoints. Keys are MIME types; an optional schema overrides the default response schema for that content type. When set alongside .producesFile(), producesFile takes precedence.

When set, the endpoint produces a binary file response instead of JSON. The OpenAPI spec will emit the appropriate binary content type.

Schema describing response headers emitted on every response code. Each property in the object schema becomes a header name with its sub-schema and optional description.

Per-status-code response schemas declared via .responses(). When non-null, takes precedence over responseSchema for OpenAPI generation and constrains the handler return type to the declared codes. A null schema value means the response has no body (e.g. 204).