From c93963707645fb7ebdf353a76f13f4b204796c94 Mon Sep 17 00:00:00 2001 From: Mathieu Leplatre Date: Mon, 26 Feb 2024 18:09:31 +0100 Subject: [PATCH] Fix docs about heartbeat status on warnings (200, not 5XX) (#99) * Fix docs about heartbeat status on warnings (200, not 5XX) * Trailing space --- 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 7079f64..7af44c5 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 .. note:: Failed status code can be configured with the ``DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE`` setting (eg. 503 instead of 500) diff --git a/docs/fastapi.rst b/docs/fastapi.rst index f89c216..c48e202 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 .. note:: Failed status code can be configured with the ``app.state.DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE`` diff --git a/docs/flask.rst b/docs/flask.rst index ebd7806..e4cb86e 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 .. note:: Failed status code can be configured with the ``DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE`` setting (eg. 503 instead of 500) diff --git a/docs/sanic.rst b/docs/sanic.rst index cd7df6d..00feb68 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 .. note:: Failed status code can be configured with the ``DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE`` setting (eg. 503 instead of 500)