LCORE-286: update /liveness endpoint

Updated endpoint to never return 503 (cannot return it if service is unreachable). Updated tests and openapi docs accordingly

Author: are-ces

docs/openapi.json

@@ -665,16 +665,6 @@
                                 }
                             }
                         }
-                    },
-                    "503": {
-                        "description": "Service is not alive",
-                        "content": {
-                            "application/json": {
-                                "schema": {
-                                    "$ref": "#/components/schemas/LivenessResponse"
-                                }
-                            }
-                        }
                     }
                 }
             }

docs/openapi.md

@@ -376,7 +376,6 @@ Returns:
 | Status Code | Description | Component |
 |-------------|-------------|-----------|
 | 200 | Service is alive | [LivenessResponse](#livenessresponse) |
-| 503 | Service is not alive | [LivenessResponse](#livenessresponse) |
 ## POST `/authorized`
 
 > **Authorized Endpoint Handler**

docs/output.md

@@ -376,7 +376,6 @@ Returns:
 | Status Code | Description | Component |
 |-------------|-------------|-----------|
 | 200 | Service is alive | [LivenessResponse](#livenessresponse) |
-| 503 | Service is not alive | [LivenessResponse](#livenessresponse) |
 ## POST `/authorized`
 
 > **Authorized Endpoint Handler**
@@ -823,7 +822,8 @@ Example:
         status={
             "previous_status": true,
             "updated_status": false,
-            "updated_by": "user/test"
+            "updated_by": "user/test",
+            "timestamp": "2023-03-15 12:34:56"
         },
     )
     ```

src/app/endpoints/health.py

@@ -117,10 +117,7 @@ async def readiness_probe_get_method(
         "description": "Service is alive",
         "model": LivenessResponse,
     },
-    503: {
-        "description": "Service is not alive",
-        "model": LivenessResponse,
-    },
+    # HTTP_503_SERVICE_UNAVAILABLE will never be returned when unreachable
 }
 
 

tests/integration/test_openapi_json.py

@@ -70,7 +70,7 @@ def test_servers_section_present(spec: dict):
         ("/v1/conversations/{conversation_id}", "get", {"200", "404", "503", "422"}),
         ("/v1/conversations/{conversation_id}", "delete", {"200", "404", "503", "422"}),
         ("/readiness", "get", {"200", "503"}),
-        ("/liveness", "get", {"200", "503"}),
+        ("/liveness", "get", {"200"}),
         ("/authorized", "post", {"200", "400", "403"}),
         ("/metrics", "get", {"200"}),
     ],