Skip to content

docs: document the service_unavailable error code #85

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
smaramwbc merged 1 commit into from
Aug 30, 2026
Merged

docs: document the service_unavailable error code #85

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
4 changes: 3 additions & 1 deletion api/v1-contract.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@ All error responses use a consistent structured shape:
}
```

Standard error codes: `validation_error`, `not_found`, `conflict`, `internal_error`, `missing_api_key`, `invalid_api_key`, `rate_limited`, `missing_tenant`.
Standard error codes: `validation_error`, `not_found`, `conflict`, `internal_error`, `missing_api_key`, `invalid_api_key`, `rate_limited`, `missing_tenant`, `service_unavailable`.

A database outage (unreachable, restarting, connection dropped) returns `503` with code `service_unavailable` and a `Retry-After` header — the request is safe to retry after a short backoff, matching what `/readyz` reports for the same condition. Auth or configuration mistakes and genuine query errors keep their own codes and are not retryable.

---

Expand Down
Loading