Merge pull request #2490 from tisnik/proper-description-for-liveness-rest-api-endpoint

Proper description for liveness REST API endpoint

Author: openshift-merge-bot[bot]

docs/openapi.json

@@ -333,7 +333,7 @@
                 "operationId": "liveness_probe_get_method_liveness_get",
                 "responses": {
                     "200": {
-                        "description": "Successful Response",
+                        "description": "Service is alive",
                         "content": {
                             "application/json": {
                                 "schema": {

ols/app/endpoints/health.py

@@ -117,7 +117,15 @@ def readiness_probe_get_method() -> ReadinessResponse:
     return ReadinessResponse(ready=True, reason="service is ready")
 
 
-@router.get("/liveness")
+get_liveness_responses: dict[int | str, dict[str, Any]] = {
+    200: {
+        "description": "Service is alive",
+        "model": LivenessResponse,
+    },
+}
+
+
+@router.get("/liveness", responses=get_liveness_responses)
 def liveness_probe_get_method() -> LivenessResponse:
     """Live status of service."""
     return LivenessResponse(alive=True)