docs: correct top-level /health status values to healthy/degraded only#192
Merged
Merged
Conversation
The previous audit PRs (#183, #185) incorrectly introduced "unknown" as a possible value for the top-level `status` field. The actual code in automem/api/health.py@ebcf5f16 only ever sets status to "healthy" or "degraded"; "unknown" is the initial value for sync_status, not status. Flagged by Codex P2 review on PR #183. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FZm6MjhHYMw2kdTch7hXmV
Deploying automem-website with
|
| Latest commit: |
917cf32
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4d5742f4.automem-website.pages.dev |
| Branch Preview URL: | https://docs-fix-status-values-unkno.automem-website.pages.dev |
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
2 participants
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.
Follow-up to PRs #183 and #185 — corrects an error those PRs introduced.
What was wrong
Both
operations/health.mdandgetting-started/quick-start.mdwere updated to list"unknown"as a possible value for the top-levelstatusfield in the/healthresponse. That was incorrect.Verified against
automem/api/health.py@ebcf5f16: the endpoint only ever assigns"healthy"or"degraded"tostatus:"unknown"is the initial/fallback value forsync_status, not for the top-levelstatus. This was flagged by the Codex P2 review on PR #183.Files changed
operations/health.md"healthy","degraded", or"unknown"→"healthy"or"degraded"; Status Values table: removedunknowngetting-started/quick-start.md"healthy","degraded", or"unknown"→"healthy"or"degraded"Generated by Claude Code
Generated by Claude Code