Skip to content

docs: document /api/healthz readiness endpoint #157

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
hivecommons-hive merged 1 commit into from
Oct 2, 2026
Merged

docs: document /api/healthz readiness endpoint #157

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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,16 @@ deployment-supported collection path — for example, Netlify's platform-native
analytics, or an explicitly operator-configured scraper/aggregator that polls `/api/metrics`
across instances and persists data to a central observability backend.

**Readiness check:** `/api/healthz` reports whether the instance can actually serve
docs content. It verifies that the local docs content tree (`docsContentPath` in
`src/app/docs/page-map.ts`) exists, is a directory, and is non-empty — the dependency
every page render and `/api/search` read from at request time. It returns
`{"status": "ok"}` with HTTP 200 when that check passes, or
`{"status": "unhealthy", "reason": "<cause>"}` with HTTP 503 otherwise (for example a
bad build, a failed volume mount, or an incomplete version-branch checkout). This
guards against an instance returning 200 on its normal routes while actually serving
broken or empty documentation.

## Contributing

PRs welcome. Sign your commits (DCO): `git commit -s`.
Expand Down
Loading