From d9a2fa309e909989fc1494895dc39ee3dbe1d052 Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Fri, 23 Feb 2024 11:08:40 +0100 Subject: [PATCH 1/2] Fix docs about heartbeat status on warnings (200, not 5XX) --- docs/django.rst | 4 ++-- docs/fastapi.rst | 2 +- docs/flask.rst | 4 ++-- docs/sanic.rst | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/django.rst b/docs/django.rst index 292310d..89607c1 100644 --- a/docs/django.rst +++ b/docs/django.rst @@ -336,8 +336,8 @@ spec: } } - :statuscode 200: no error - :statuscode 500: there was a warning or error + :statuscode 200: no error, with potential warnings + :statuscode 500: there was an error .. http:get:: /__lbheartbeat__ diff --git a/docs/fastapi.rst b/docs/fastapi.rst index 9f15112..f34cede 100644 --- a/docs/fastapi.rst +++ b/docs/fastapi.rst @@ -241,7 +241,7 @@ spec: } } - :statuscode 200: no error + :statuscode 200: no error, with potential warnings :statuscode 500: there was an error .. http:get:: /__lbheartbeat__ diff --git a/docs/flask.rst b/docs/flask.rst index db11ea2..e11180f 100644 --- a/docs/flask.rst +++ b/docs/flask.rst @@ -389,8 +389,8 @@ spec: } } - :statuscode 200: no error - :statuscode 500: there was a warning or error + :statuscode 200: no error, with potential warnings + :statuscode 500: there was an error .. http:get:: /__lbheartbeat__ diff --git a/docs/sanic.rst b/docs/sanic.rst index 646bae6..37a4fb3 100644 --- a/docs/sanic.rst +++ b/docs/sanic.rst @@ -369,8 +369,8 @@ spec: } } - :statuscode 200: no error - :statuscode 500: there was a warning or error + :statuscode 200: no error, with potential warnings + :statuscode 500: there was an error .. http:get:: /__lbheartbeat__ From f670e83b9991be90a67ed5414a8e6f3629af0a7f Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Fri, 23 Feb 2024 11:08:52 +0100 Subject: [PATCH 2/2] Trailing space --- docs/django.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/django.rst b/docs/django.rst index 89607c1..9a14f87 100644 --- a/docs/django.rst +++ b/docs/django.rst @@ -287,7 +287,7 @@ spec: .. http:get:: /__heartbeat__ The heartbeat view will go through the list of configured Dockerflow - checks in the :ref:`DOCKERFLOW_CHECKS` setting, run each check, and, if + checks in the :ref:`DOCKERFLOW_CHECKS` setting, run each check, and, if `settings.DEBUG` is `True`, add their results to a JSON response. The view will return HTTP responses with either a status code of 200 if