docs: sync from backend 8e03360 — auth health hotfix

This commit is contained in:
Siavash Sameni
2026-05-31 16:28:09 +04:00
parent 35640e38cc
commit e8a1bba471
3 changed files with 23 additions and 5 deletions

View File

@@ -67,10 +67,10 @@ The `GET /api/health` endpoint was shipped in backend 2.6.49. It is public, rate
**Shape of the endpoint:**
```ts
// GET /api/health (public, rate-limited but not auth-gated)
// GET /api/health (public, skipped by the global rate limiter)
{
"status": "ok" | "degraded" | "down",
"version": "2.6.48",
"version": "2.6.84",
"uptimeSec": 12345,
"checks": {
"db": { "ok": true, "latencyMs": 4 },
@@ -82,7 +82,7 @@ The `GET /api/health` endpoint was shipped in backend 2.6.49. It is public, rate
}
```
Each `checks.*.ok` must reflect the actual current state, not a cached one. If any check fails, `status` flips to `degraded`. If `db.ok === false`, `status` flips to `down`.
Each `checks.*.ok` reflects the current backend state, except `rnApi`, which is cached for 60 seconds as of backend `2.6.84` to avoid monitoring-induced upstream rate limits. `rnApi.status === 429` is treated as reachable because Request Network answered; 5xx/timeouts still degrade the report. If any non-DB check fails, `status` flips to `degraded`. If `db.ok === false`, `status` flips to `down`.
**Why this shape rather than per-check endpoints:**
- One probe, all invariants — cheaper for Gatus and clearer in the dashboard.