Summary
The health check endpoint is used by deployment infrastructure to determine if the server is ready to receive traffic. Its response fields are undocumented so operators do not know what each field means or what values indicate a healthy vs degraded state.
Scope
- Document all fields in the health check response: database connectivity, indexer lag, cache status, uptime
- Define what values indicate healthy, degraded, and unhealthy for each field
- Explain the difference between the liveness and readiness checks if both exist
- Add a note on which field causes a non-200 response
Acceptance Criteria
ETA: 12 hours
Coordinate on Telegram
Summary
The health check endpoint is used by deployment infrastructure to determine if the server is ready to receive traffic. Its response fields are undocumented so operators do not know what each field means or what values indicate a healthy vs degraded state.
Scope
Acceptance Criteria
ETA: 12 hours
Coordinate on Telegram