doc: update on /health and /api/config endpoints
All checks were successful
PR Tests / test (pull_request) Successful in 59s
NYX Security Scan / nyx-scan (pull_request) Successful in 6m52s

This commit is contained in:
Alpha Nerd 2026-05-18 17:03:04 +02:00
parent ea8cda73d9
commit 539d5f98a2
Signed by: alpha-nerd
SSH key fingerprint: SHA256:QkkAgVoYi9TQ0UKPkiKSfnerZy2h4qhi3SVPXJmBN+M
2 changed files with 8 additions and 0 deletions

View file

@ -206,6 +206,8 @@ The `/health` endpoint provides comprehensive health status:
}
```
For Ollama endpoints the probe is a parallel check of `/api/version` (liveness) and `/api/ps` (the route used by `choose_endpoint` when selecting a backend for a request). Reporting `ok` only when both succeed prevents the router from advertising an endpoint as healthy while completion calls dead-end on `/api/ps`. The same dual probe backs `/api/config`, which the dashboard uses to render endpoint health.
## Database Schema
The router uses SQLite for persistent storage:

View file

@ -29,6 +29,10 @@ Response:
- `200`: All endpoints healthy
- `503`: One or more endpoints unhealthy
**Probe scope per endpoint**:
- **Ollama endpoints** are probed at both `/api/version` (liveness) and `/api/ps` (model-introspection used by the router). If either fails the endpoint is reported as `error`; the response still includes `version` when the daemon is reachable so operators can tell a partial failure from a full outage. The `detail` field names the failing probe, e.g. `"/api/ps: 502 …"`.
- **OpenAI-compatible / llama-server endpoints** are probed at `/models`.
### Current Usage
```bash
@ -133,6 +137,8 @@ Response:
}
```
Uses the same dual-probe logic as `/health` (Ollama: `/api/version` + `/api/ps`; OpenAI-compatible: `/models`). An endpoint will report `error` whenever either probe fails. The dashboard renders the `detail` field as a tooltip on the status cell.
### Cache Statistics
```bash