This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb.git
The following commit(s) were added to refs/heads/main by this push:
new 3f11cfd90 Docs: Update the /_up endpoint docs to include status
response's
3f11cfd90 is described below
commit 3f11cfd90be79d7d046e493a80abd8516a3f1930
Author: James Mackenzie <[email protected]>
AuthorDate: Wed Oct 15 14:56:18 2025 +0100
Docs: Update the /_up endpoint docs to include status response's
The change in response body is not reflected in the docs at all.
Mentioning it here.
---
src/docs/src/api/server/common.rst | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/docs/src/api/server/common.rst
b/src/docs/src/api/server/common.rst
index 26b677e96..1376a6f20 100644
--- a/src/docs/src/api/server/common.rst
+++ b/src/docs/src/api/server/common.rst
@@ -2320,7 +2320,15 @@ See :ref:`Configuration of Prometheus Endpoint
<config/prometheus>` for details.
Confirms that the server is up, running, and ready to respond to requests.
If :config:option:`maintenance_mode <couchdb/maintenance_mode>` is
- ``true`` or ``nolb``, the endpoint will return a 404 response.
+ ``true`` or ``nolb``, the endpoint will return a 404 response. The status
field
+ in the response body also changes to reflect the current
``maintenance_mode``
+ defaulting to ``ok``.
+
+ If :config:option:`maintenance_mode <couchdb/maintenance_mode>` is
``true`` the status
+ field is set to ``maintenance_mode``.
+
+ If :config:option:`maintenance_mode <couchdb/maintenance_mode>` is set to
``nolb`` the
+ status field is set to ``nolb``.
:>header Content-Type: :mimetype:`application/json`
:code 200: Request completed successfully
