feat(api): add health check endpoints with appropriate tags for service monitoring

This commit is contained in:
Abhimanyu Saharan
2026-02-15 02:22:28 +05:30
parent 3bfefeda9f
commit d906e9a770

View File

@@ -41,6 +41,12 @@ if TYPE_CHECKING:
configure_logging()
logger = get_logger(__name__)
OPENAPI_TAGS = [
{
"name": "health",
"description": (
"Service liveness/readiness probes used by infrastructure and runtime checks."
),
},
{
"name": "agent",
"description": (
@@ -112,19 +118,19 @@ else:
install_error_handling(app)
@app.get("/health")
@app.get("/health", tags=["health"])
def health() -> dict[str, bool]:
"""Lightweight liveness probe endpoint."""
return {"ok": True}
@app.get("/healthz")
@app.get("/healthz", tags=["health"])
def healthz() -> dict[str, bool]:
"""Alias liveness probe endpoint for platform compatibility."""
return {"ok": True}
@app.get("/readyz")
@app.get("/readyz", tags=["health"])
def readyz() -> dict[str, bool]:
"""Readiness probe endpoint for service orchestration checks."""
return {"ok": True}