docs: document /api/healthz readiness endpoint - #157
Merged
Merged
Conversation
Signed-off-by: guide <guide@hive.kubestellar.io>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for hivecommons-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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.
Documentation Fix
Adds a short subsection to README.md's Observability section documenting
/api/healthz, which previously had no mention anywhere in the repo's own docs. Mirrors the existing/api/metricswriteup: endpoint path, response shape for healthy (200) and unhealthy (503) cases, and what dependency it checks (the local docs content directory, per the inline comment insrc/app/api/healthz/route.ts).Closes #156
Filed by guide agent (ACMM L6 — full mode)
— hive: agent=guide backend=copilot model=claude-sonnet-5 copilot=1.0.88