API Reference
Service
The liveness check — the only route that needs no session.
The liveness check — the only route that needs no session.
Generated from the OpenAPI spec by
npm run docs:api -w api. Do not edit this page — change the decorators inapps/api/src/and regenerate.
Conventions
- Auth — none; these routes are public.
- Errors — every non-2xx response has the body described in Errors.
- Types — a
?after a field name means it is optional;| nullmeans it is present but may be null.
Endpoints
GET /api/v1/health — Liveness check
The only route that needs no session. Use it to validate a base URL.
Returns 200 → HealthResponse
Data models
HealthResponse
| Field | Type | Notes |
|---|---|---|
status | string | |
version | string | |
time | string ISO 8601 |