Fix healtcheck documentation.

Updated the output for the health check using the RPC implementation. Signed-off-by: Branislav Malo <[email protected]> Signed-off-by: Branislav Malo <[email protected]>
FRINXio · Sep 10, 2024 · 265546f · 265546f
1 parent 5a4a3f1
commit 265546f
Showing 1 changed file with 10 additions and 15 deletions.
diff --git a/...fig/user-guide/uniconfig-operations/uniconfig-node-manager/rpc_health/readme.md b/...fig/user-guide/uniconfig-operations/uniconfig-node-manager/rpc_health/readme.md
@@ -13,24 +13,16 @@ curl --location --request POST 'http://localhost:8181/rests/operations/uniconfig
 --header 'Content-Type: application/json'
 ```
 
-**Response if database persistence is disabled:**
-
-```json RPC Response, Status: 200
-{
-  "output": {
-    "healthy": true,
-    "message": "DB persistence is disabled"
-  }
-}
-```
-
 **Response if database persistence is enabled and the database connection is valid:**
 
 ```json RPC Response, Status: 200
 {
   "output": {
-    "healthy": true,
-    "message": "DB connection is alive"
+    "status": "UP",
+    "details": {
+      "state": "ACCEPTING_TRAFFIC",
+      "reason": "The application is ready to receive traffic and DB connection is alive"
+    }
   }
 }
 ```
@@ -40,8 +32,11 @@ curl --location --request POST 'http://localhost:8181/rests/operations/uniconfig
 ```json RPC Response, Status: 200
 {
   "output": {
-    "healthy": false,
-    "message": "Error connecting to DB"
+    "status": "DOWN",
+    "details": {
+      "state": "ACCEPTING_TRAFFIC",
+      "reason": "Error connecting to DB"
+    }
   }
 }
 ```