From f81360b2d0bb89f7c8a6d5d1a782bb381842868a Mon Sep 17 00:00:00 2001
From: John Cardinal <support@ayanova.com>
Date: Thu, 4 Jun 2020 22:19:27 +0000
Subject: [PATCH]

---
 server/AyaNova/Controllers/HealthController.cs | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

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
         }
 
         /// <summary>
-        /// 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
         /// </summary>
         /// <remarks>Provides an indication about the health of the API</remarks>
         /// <response code="200">API is healthy</response>