Minima.js

Appearance

Minima.js API

Minima.js API / @minimajs/openapi / internal

Function: internal() ​

ts
function internal(isInternal): RouteMetaDescriptor;

Defined in: packages/openapi/src/internal.ts:18

Marks a route as internal, excluding it from the OpenAPI spec.

Parameters ​

isInternal ​

boolean = true

Returns ​

RouteMetaDescriptor

Example ​

typescript
import { internal } from "@minimajs/openapi";

// Health check - not part of public API
app.get("/health", internal(), () => "ok");

// Internal admin endpoint
app.get("/admin/metrics", internal(), () => getMetrics());