docs: document /health and /health/ready probes (closes #16)#45
Merged
Conversation
The readiness endpoint already shipped (SELECT 1 against Postgres, 503 on failure, separate from the static liveness probe). The only unmet acceptance criterion in #16 was documentation: add a Health & probes subsection to the README API reference explaining the liveness-vs-readiness split and where to point orchestrator probes vs. load-balancer / deploy gates. Closes #16 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #16. The readiness endpoint it asks for already shipped —
/health/readyopens Postgres, runsSELECT 1, returns200 {"status":"ready"}when reachable and503 {"status":"unavailable"}otherwise, kept deliberately separate from the cheap static/healthliveness probe (so a DB blip drains traffic instead of restart-looping). It already has test coverage (HealthEndpointTestsexercises the 503 failure path).The only unmet acceptance criterion was documentation. This PR adds a Health & probes subsection to the README API reference explaining the liveness-vs-readiness split and where to point orchestrator probes vs. load-balancer / deploy gates, and updates the intro line to note both probes are open.
Docs-only change; no code touched.
🤖 Generated with Claude Code