summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2021-04-21 18:29:51 +0000
committerGerrit Code Review <review@openstack.org>2021-04-21 18:29:51 +0000
commitb91fbcdf7e5146c6a95189d15a0eb0ab81f65c6c (patch)
tree3924fca2882dca2967bd4b01b4c2a19a99ad3992
parenta2e7f5496ec2a784d701403e18b6fc91b5406a98 (diff)
parentb1ce931100bf774f7a05bfbe5f45a511d8a0caeb (diff)
downloadoslo-middleware-b91fbcdf7e5146c6a95189d15a0eb0ab81f65c6c.tar.gz
Merge "Warning about /healthcheck"
-rw-r--r--oslo_middleware/healthcheck/__init__.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/oslo_middleware/healthcheck/__init__.py b/oslo_middleware/healthcheck/__init__.py
index 66c713e..5f97914 100644
--- a/oslo_middleware/healthcheck/__init__.py
+++ b/oslo_middleware/healthcheck/__init__.py
@@ -65,6 +65,12 @@ class Healthcheck(base.ConfigurableMiddleware):
the activity of the server.
* *(and more)*
+ .. note::
+
+ This middleware indicates that the API is accessible but it does
+ indicate that it is necessarily functional or that any other API
+ request will actually work.
+
Example requests/responses (**not** detailed mode)::
$ curl -i -X HEAD "http://0.0.0.0:8775/healthcheck"