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

leplatrem · web-flow · commit c93963707645 · 2024-02-26T18:09:31.000+01:00
* Fix docs about heartbeat status on warnings (200, not 5XX)

* Trailing space
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)

Original file line number	Diff line number	Diff line change
`@@ -336,8 +336,8 @@ spec:`
`336`	`336`	`}`
`337`	`337`	`}`
`338`	`338`
`339`		`- :statuscode 200: no error`
`340`		`- :statuscode 500: there was a warning or error`
	`339`	`+ :statuscode 200: no error, with potential warnings`
	`340`	`+ :statuscode 500: there was an error`
`341`	`341`
`342`	`342`	.. note:: Failed status code can be configured with the ``DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE``
`343`	`343`	`setting (eg. 503 instead of 500)`
Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ spec:`
`241`	`241`	`}`
`242`	`242`	`}`
`243`	`243`
`244`		`- :statuscode 200: no error`
	`244`	`+ :statuscode 200: no error, with potential warnings`
`245`	`245`	`:statuscode 500: there was an error`
`246`	`246`
`247`	`247`	.. note:: Failed status code can be configured with the ``app.state.DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE``
Original file line number	Diff line number	Diff line change
`@@ -389,8 +389,8 @@ spec:`
`389`	`389`	`}`
`390`	`390`	`}`
`391`	`391`
`392`		`- :statuscode 200: no error`
`393`		`- :statuscode 500: there was a warning or error`
	`392`	`+ :statuscode 200: no error, with potential warnings`
	`393`	`+ :statuscode 500: there was an error`
`394`	`394`
`395`	`395`	.. note:: Failed status code can be configured with the ``DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE``
`396`	`396`	`setting (eg. 503 instead of 500)`
Original file line number	Diff line number	Diff line change
`@@ -369,8 +369,8 @@ spec:`
`369`	`369`	`}`
`370`	`370`	`}`
`371`	`371`
`372`		`- :statuscode 200: no error`
`373`		`- :statuscode 500: there was a warning or error`
	`372`	`+ :statuscode 200: no error, with potential warnings`
	`373`	`+ :statuscode 500: there was an error`
`374`	`374`
`375`	`375`	.. note:: Failed status code can be configured with the ``DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE``
`376`	`376`	`setting (eg. 503 instead of 500)`