Skip to content

docs: replace stale GET /health references with /livez and /admin/v1/health - #294

Merged
moonming merged 3 commits into
mainfrom
docs/issue-293-replace-health-references-with-livez
May 18, 2026
Merged

docs: replace stale GET /health references with /livez and /admin/v1/health#294
moonming merged 3 commits into
mainfrom
docs/issue-293-replace-health-references-with-livez

Conversation

@janiussyafiq

@janiussyafiq janiussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Changes

File Lines Edit
docs/configuration/admin-api.md 31, 54 - GET /health → `- `GET /livez (public-routes list entries)
docs/configuration/admin-api.md 100 Public routes such as /health, /metrics, …Public routes such as /livez, /metrics, …
docs/configuration/admin-api.md 102 Use GET /health for simple admin-listener reachability.Use GET /livez for simple admin-listener reachability. (the trailing /admin/v1/health reference is unchanged)
docs/configuration/bootstrap-config.md 210, 216 curl -s http://127.0.0.1:300{0,1}/health… /livez (proxy and admin verification examples)
docs/reference/admin-api-reference.md 9 - GET /health → `- `GET /livez (Public Admin-Listener Routes entry)
docs/operations/production-deployment.md 88, 89 GET /health returns 200 (proxy + admin) → GET /livez returns 200
docs/operations/network-and-security.md 23 intentionally leaves /health, /metrics, …intentionally leaves /livez, /metrics, …
docs/operations/upgrades-and-compatibility.md 21, 22 GET /health (proxy + admin) → GET /livez
docs/operations/troubleshooting.md 94, 95 check GET /health / check admin-listener GET /health… /livez; the trailing then GET /admin/v1/health in standalone mode on line 95 is unchanged

/admin/v1/health references throughout these files remain unchanged — those point to the authenticated operator endpoint that PR #257 did not rename.

Test plan

Docs-only diff — no .rs files, no schemas, no configs, no test fixtures touched. Local cargo pre-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, so pnpm test under tests/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 /health references remain in docs/.
  • 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

Closes #293.

Summary by CodeRabbit

  • Documentation
    • Switched documented liveness checks from /health to /livez across operational guides and API docs.
    • Clarified unauthenticated liveness (/livez) versus authenticated per-model health (/admin/v1/health).
    • Updated verification examples, deployment checklists, troubleshooting steps, and upgrade guidance to use /livez.
    • Added reminder to update tooling and monitoring to avoid 404s after upgrading.

Review Change Stack

Copilot AI review requested due to automatic review settings May 15, 2026 20:58
@coderabbitai

coderabbitai Bot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: b315b243-bd9e-4cff-9d42-477aef81ed7e

📥 Commits

Reviewing files that changed from the base of the PR and between 0491692 and c816715.

📒 Files selected for processing (1)
  • docs/operations/upgrades-and-compatibility.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/operations/upgrades-and-compatibility.md

📝 Walkthrough

Walkthrough

Documentation updates across API reference, configuration, and operational guides replace /health with /livez for unauthenticated liveness checks and clarify that /admin/v1/health remains the authenticated per-model health endpoint.

Changes

Documentation Update for /livez Endpoint

Layer / File(s) Summary
API documentation and reference
docs/configuration/admin-api.md, docs/reference/admin-api-reference.md
Admin API documentation updates public routes to list GET /livez instead of GET /health, clarifies unauthenticated public-route behavior in error envelopes, and distinguishes liveness checks from authenticated per-model health via GET /admin/v1/health.
Operational guides and startup verification
docs/configuration/bootstrap-config.md, docs/operations/network-and-security.md, docs/operations/production-deployment.md, docs/operations/troubleshooting.md, docs/operations/upgrades-and-compatibility.md
Startup verification examples, listener exposure guidance, production checks, triage checklists, and upgrade steps are updated to use GET /livez instead of GET /health for liveness verification.

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.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Note

🎁 Summarized by CodeRabbit Free

Your 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 @coderabbitai help to get the list of available commands and usage tips.

@janiussyafiq janiussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 /health references with GET /livez in configuration, operations, and reference docs.
  • Updates example curl commands and operator checklists to probe /livez on both proxy (:3000) and admin (:3001) listeners.
  • Keeps /admin/v1/health references 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.

Copilot AI review requested due to automatic review settings May 15, 2026 21:08

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit 6bd66bd into main May 18, 2026
10 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-293-replace-health-references-with-livez branch June 25, 2026 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: replace GET /health references with /livez and /admin/v1/health across configuration, reference, and operations docs

3 participants