diff --git a/server/AyaNova/Controllers/HealthController.cs b/server/AyaNova/Controllers/HealthController.cs index c5197c29..f0dcbde2 100644 --- a/server/AyaNova/Controllers/HealthController.cs +++ b/server/AyaNova/Controllers/HealthController.cs @@ -21,9 +21,10 @@ namespace AyaNova.Api.Controllers } /// - /// Get Health - /// Also available at /health on server root - /// confirms liveness and also db availability + /// Get Health (verify server AND database connection) + /// Note: for server monitoring or automation / orchestration use such as Docker prefer the mirror of this route at the server root: [api_server_url]/health + /// as it avoids API versioning issues + /// i.e. Docker: HEALTHCHECK CMD curl --fail http://localhost:5000/health || exit /// /// Provides an indication about the health of the API /// API is healthy