Uh oh!
There was an error while loading. Please reload this page.
docs: replace stale GET /health references with /livez and /admin/v1/health - #294
Conversation
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Free Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation updates across API reference, configuration, and operational guides replace ChangesDocumentation Update for /livez Endpoint
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Note 🎁 Summarized by CodeRabbit FreeYour organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above. Comment |
There was a problem hiding this comment.
Pull request overview
This PR updates customer-facing documentation to reflect the post-#257 public liveness route rename from GET /health to GET /livez, while preserving the authenticated operator health endpoint GET /admin/v1/health for admin-only diagnostics.
Changes:
- Replaces stale
GET /healthreferences withGET /livezin configuration, operations, and reference docs. - Updates example
curlcommands and operator checklists to probe/livezon both proxy (:3000) and admin (:3001) listeners. - Keeps
/admin/v1/healthreferences intact as the authenticated operator-facing health surface.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/configuration/admin-api.md | Updates public admin-listener route references from /health to /livez and adjusts guidance text accordingly. |
| docs/configuration/bootstrap-config.md | Updates bootstrap verification curl examples to use /livez on both listeners. |
| docs/reference/admin-api-reference.md | Updates the “Public Admin-Listener Routes” list to reference GET /livez instead of GET /health. |
| docs/operations/production-deployment.md | Updates production verification checklist to probe /livez instead of /health. |
| docs/operations/network-and-security.md | Updates the list of intentionally-unauthenticated admin-listener routes to include /livez instead of /health. |
| docs/operations/upgrades-and-compatibility.md | Updates upgrade verification checklist to probe /livez instead of /health. |
| docs/operations/troubleshooting.md | Updates the fast triage steps to check /livez (and preserves the /admin/v1/health follow-up). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.
Summary
GET /healthreferences in customer-facing docs with/livez(unauthenticated liveness) orGET /admin/v1/health(authenticated operator-facing health) per context.fix(health): rename public liveness route to /livez) which renamed the route in code; the docs rebuild in docs: rebuild customer-facing docs across overview, config, cloud, ops, reference, and tutorials #249 introduced the now-stale text.Changes
docs/configuration/admin-api.md-GET /health→ `- `GET /livez(public-routes list entries)docs/configuration/admin-api.mdPublic routes such as /health, /metrics, …→Public routes such as /livez, /metrics, …docs/configuration/admin-api.mdUse GET /health for simple admin-listener reachability.→Use GET /livez for simple admin-listener reachability.(the trailing/admin/v1/healthreference is unchanged)docs/configuration/bootstrap-config.mdcurl -s http://127.0.0.1:300{0,1}/health→… /livez(proxy and admin verification examples)docs/reference/admin-api-reference.md-GET /health→ `- `GET /livez(Public Admin-Listener Routes entry)docs/operations/production-deployment.mdGET /health returns 200(proxy + admin) →GET /livez returns 200docs/operations/network-and-security.mdintentionally leaves /health, /metrics, …→intentionally leaves /livez, /metrics, …docs/operations/upgrades-and-compatibility.mdGET /health(proxy + admin) →GET /livezdocs/operations/troubleshooting.mdcheck GET /health/check admin-listener GET /health→… /livez; the trailingthen GET /admin/v1/health in standalone modeon line 95 is unchanged/admin/v1/healthreferences throughout these files remain unchanged — those point to the authenticated operator endpoint that PR #257 did not rename.Test plan
Docs-only diff — no
.rsfiles, no schemas, no configs, no test fixtures touched. Localcargopre-flight (fmt --check/clippy --workspace --all-targets -- -D warnings/test --workspace) was skipped because the toolchain isn't installed on the authoring environment; repo CI runs all three on every PR and is the canonical gate. E2E fixtures don't reference any of the 7 affected pages, sopnpm testundertests/e2e/is not applicable.Local verification that was run:
grep -rn --include='*.md' -P '(?<!v1)/health(?![a-z0-9_-])' docs/after the edits returns zero matches — confirms no stale standalone/healthreferences remain indocs/.grep -rn --include='*.md' '/admin/v1/health' docs/returns the same set of lines before and after the edits — confirms the authenticated endpoint references were preserved.grep -rln --include='*.{ts,js,json}' <each-page>.md tests/e2e/returns empty for all 7 affected pages — no e2e assertion can regress from this diff.References
fix(health): rename public liveness route to /livez(the rename itself; branchfix/issue-253-rename-health-to-livez)docs: rebuild customer-facing docs across overview, config, cloud, ops, reference, and tutorials(the rebuild that introduced the stale text)Closes#293.
Summary by CodeRabbit