diff options
author | Ronny Berndt <ronny@apache.org> | 2022-09-09 10:17:16 +0200 |
---|---|---|
committer | Nick Vatamaniuc <nickva@users.noreply.github.com> | 2022-09-21 22:18:13 -0400 |
commit | 344ae9320aacb8f17770f49e308d99bea9be01ff (patch) | |
tree | 27678bd392bf7d8f3bd55086654b93fe95af741c | |
parent | c4e8f59569d35bb02538a446d6ab8bcc4bdddf10 (diff) | |
download | couchdb-344ae9320aacb8f17770f49e308d99bea9be01ff.tar.gz |
Document _versions endpoint
-rw-r--r-- | src/docs/src/api/server/common.rst | 61 | ||||
-rw-r--r-- | src/docs/src/config/auth.rst | 4 |
2 files changed, 64 insertions, 1 deletions
diff --git a/src/docs/src/api/server/common.rst b/src/docs/src/api/server/common.rst index c73bd7c7a..371511500 100644 --- a/src/docs/src/api/server/common.rst +++ b/src/docs/src/api/server/common.rst @@ -1967,6 +1967,67 @@ See :ref:`Configuration of Prometheus Endpoint <config/prometheus>` for details. :code 200: Request completed successfully +.. _api/server/versions: + +================================ +``/_node/{node-name}/_versions`` +================================ + +.. http:get:: /_node/{node-name}/_versions + :synopsis: Returns system-level server version informations + + The ``_versions`` resource returns a JSON object containing various + system-level informations for the running server. + + The literal string ``_local`` serves as an alias for the local node name, so + for all stats URLs, ``{node-name}`` may be replaced with ``_local``, to + interact with the local node's informations. + + :<header Accept: - :mimetype:`application/json` + - :mimetype:`text/plain` + :>header Content-Type: - :mimetype:`application/json` + :code 200: Request completed successfully + + **Request**: + + .. code-block:: http + + GET /_node/_local/_versions HTTP/1.1 + Accept: application/json + Host: localhost:5984 + + **Response**: + + .. code-block:: http + + HTTP/1.1 200 OK + Cache-Control: must-revalidate + Content-Length: 368 + Content-Type: application/json + Date: Sat, 03 Sep 2022 08:12:12 GMT + Server: CouchDB/3.2.2-ea382cf (Erlang OTP/25) + + { + "javascript_engine": { + "version": "91", + "name": "spidermonkey" + }, + "erlang": { + "version": "25.0.4", + "supported_hashes": [ + "sha", + "sha224", + "sha256", + ] + }, + "collation_driver": { + "name": "libicu", + "library_version": "70.1", + "collator_version": "153.112", + "collation_algorithm_version": "14" + } + } + .. _api/server/search_analyze: ========================================== diff --git a/src/docs/src/config/auth.rst b/src/docs/src/config/auth.rst index cb92f3188..ada470cd0 100644 --- a/src/docs/src/config/auth.rst +++ b/src/docs/src/config/auth.rst @@ -216,7 +216,9 @@ Authentication Configuration To retrieve a complete list of supported hash algorithms you can use our ``bin/remsh`` script and retrieve a full list of available hash algorithms - with ``crypto:supports(hashs).``. + with ``crypto:supports(hashs).`` or use the + :ref:`_node/$node/_versions <api/server/versions>` endpoint to retrieve the + hashes. .. warning:: We do not recommend using the following hash algorithms: :: |