Warning about /healthcheck
Add a warning in the doc to explain '/healthcheck' doesn't provide any sort of check if the API actually works. Change-Id: Ib4a065f31140f885d3de53e2423e7b4a6635f345
This commit is contained in:
parent
e413cb73de
commit
b1ce931100
@ -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"
|
||||
|
Loading…
x
Reference in New Issue
Block a user