Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leplatrem merged 2 commits into from
Feb 26, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9a2fa3
Fix docs about heartbeat status on warnings (200, not 5XX)
leplatrem Feb 23, 2024
f670e83
Trailing space
leplatrem Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/django.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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__

Expand Down
2 changes: 1 addition & 1 deletion docs/fastapi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__
Expand Down
4 changes: 2 additions & 2 deletions docs/flask.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__

Expand Down
4 changes: 2 additions & 2 deletions docs/sanic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__

Expand Down