api: add health endpoint for availability checks#701
Draft
nuclearcat wants to merge 1 commit into
Draft
Conversation
The root endpoint now serves the HTML landing page, so it should not be documented or tested as the machine-readable API availability check. Add GET /health for a stable JSON health response, update the root handler tests to assert the HTML contract, add health endpoint coverage, and point the local-instance docs at /latest/health. Fixes: kernelci#632 Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
nuclearcat
force-pushed
the
issue-632-health-endpoint-docs
branch
from
5655612 to
4ba85a7
Compare
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.
The root endpoint now serves the HTML landing page, so it should not be documented or tested as the machine-readable API availability check.
Add GET /health for a stable JSON health response, update the root handler tests to assert the HTML contract, add health endpoint coverage, and point the local-instance docs at /latest/health.
Fixes: #632