imbajin commented on code in PR #3358: URL: https://github.com/apache/hugegraph/pull/3358#discussion_r4299331770
########## hugegraph-pd/docs/api-reference.md: ########## @@ -809,7 +809,7 @@ Two unauthenticated endpoints are meant for probes and startup gates: | Endpoint | Meaning | Status | |----------|---------|--------| -| `GET /v1/health` | Liveness: the REST listener is up. Does not consult raft. | always `200` | +| `GET /v1/health` | Liveness: the REST listener is up and Raft has no terminal error. Empty text body. | `503` for `STATE_ERROR` or `STATE_SHUTDOWN`, `200` otherwise | Review Comment: 🧹 Minor. Blocking: no. Summary: This table now documents /v1/health as returning 503 for a terminal Raft error or shutdown, but hugegraph-pd/README.md:311 and helm/hugegraph/docs/operations.md:127 still describe it as confirming only a live listener. Please update both descriptions to clarify that elections and temporary quorum loss remain healthy while terminal error or shutdown returns 503. Evidence: those exact-head operator docs contradict the API contract added here. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
