Skip to content

docs: document /health and /health/ready probes (closes #16) #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CryptoJones merged 1 commit into from
Jun 20, 2026
Merged

docs: document /health and /health/ready probes (closes #16) #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,19 @@ All configuration is environment variables (see [`.env.example`](./.env.example)
## API reference

All `/api/*` routes except the auth handshake require a valid session cookie;
unauthenticated calls get **401** with a `{"detail": "..."}` body. `/health` is
open. Error bodies are uniform `{"detail": "..."}` across 400/404/409/500.
unauthenticated calls get **401** with a `{"detail": "..."}` body. The `/health`
and `/health/ready` probes are open. Error bodies are uniform `{"detail": "..."}`
across 400/404/409/500.

### Health & probes

Two unauthenticated endpoints, split so a database hiccup drains traffic without
killing the process:

| Method | Path | Notes |
| --- | --- | --- |
| `GET` | `/health` | **Liveness.** Cheap and static — `200 {"status":"ok"}`. Never touches the database, so a transient DB blip can't trip it into a restart loop. Point your orchestrator's liveness probe here. |
| `GET` | `/health/ready` | **Readiness.** Opens Postgres and runs `SELECT 1`. `200 {"status":"ready","database":"connected"}` when the DB is reachable (and startup migrations have run); `503 {"status":"unavailable","database":"disconnected"}` otherwise. Point load balancers / deploy gates here so traffic only arrives once the DB is up. |

### Auth

Expand Down