[FAB-17068] Add doc for /version endpoint

Signed-off-by: Brett Logan <Brett.T.Logan@ibm.com> Change-Id: I81e26dde3169096c2951ae69953733f6cb545b98
hyperledger · Nov 14, 2019 · a3a9485 · a3a9485
1 parent 95ffcdc
commit a3a9485
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/source/operations_service.rst b/docs/source/operations_service.rst
@@ -10,6 +10,7 @@ The API exposes the following capabilities:
 - Log level management
 - Health checks
 - Prometheus target for operational metrics (when configured)
+- Version information
 
 Configuring the Operations Service
 ----------------------------------
@@ -304,5 +305,12 @@ metrics.
 For a look at the different metrics that are generated, check out
 :doc:`metrics_reference`.
 
+Version
+-------
+
+The orderer and peer both expose a ``/version`` endpoint. This endpoint
+serves a JSON document containing the orderer or peer version and the commit
+SHA on which the release was cut.
+
 .. Licensed under Creative Commons Attribution 4.0 International License
    https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/whatsnew.rst b/docs/source/whatsnew.rst
@@ -75,6 +75,9 @@ is the recommended release for production operations.
   * The ``/metrics`` endpoint allows operators to utilize Prometheus to pull operational
     metrics from peer and orderer nodes. Metrics can also be pushed to StatsD.
 
+  * As of v1.4.4, the ``/version`` endpoint allows operators to query the release version
+    of the peer and orderer and the commit SHA from which the release was cut.
+
 Improved programming model for developing applications
 ------------------------------------------------------