Fix docs about heartbeat status on warnings (200, not 5XX) (#99)

* Fix docs about heartbeat status on warnings (200, not 5XX) * Trailing space
mozilla-services · Feb 26, 2024 · c939637 · c939637
1 parent e695de7
commit c939637
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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)