flimzy commented on a change in pull request #258: Document /_up endpoint
URL:
https://github.com/apache/couchdb-documentation/pull/258#discussion_r175257623
##########
File path: src/api/server/common.rst
##########
@@ -1452,6 +1452,41 @@ is as follows:
:>header Last-Modified: Static files modification timestamp
:code 200: Request completed successfully
+.. _api/server/up:
+
+========
+``/_up``
+========
+
+.. versionadded:: 2.0
+
+.. http:get:: /_up
+ :synopsis: Health check endpoint
+
+ Confirms that the server is up, running, and ready to respond to requests.
+ If the server is in ``true`` or ``nolb``
+ :config:option:`maintenance_mode <couchdb/maintenance_mode>`, the endpoint
+ will return a 404 response.
Review comment:
I wonder if something like this would be more clear?
> If maintenance mode is ``true`` or ``nolb``, the endpoint will return a
404 response.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
