docs: health endpoints are status-only; details need admin (#51) - #21
Merged
Merged
Conversation
phoenixml main 170adf3. /health, /health/live and /health/ready return only Healthy/Degraded/Unhealthy (200, or 503 when unhealthy). The detailed JSON moved to /health/details behind RequireAdmin. /health/ready now runs the database and engine checks, where it used to always return 200. No health response carries exception text; the report uses fixed codes. Verified in Program.cs and the three health checks at 170adf3. This replaces a Health Endpoint example showing an invented JSON body with version and uptime fields. Also adds a "Breaking for monitoring" entry to the unreleased database-server notes. Facts from the db-engine session, each verified in source. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019zMS2EzLV6KZG6ooYco8Uf
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.
Documents the status-only health endpoints and admin-only
/health/details(phoenixmlmain170adf3, #51), with probe guidance, and adds a Breaking for monitoring release-notes entry. Replaces an invented JSON example. Verified in source.🤖 Generated with Claude Code
https://claude.ai/code/session_019zMS2EzLV6KZG6ooYco8Uf