doc(http): update health endpoint to include cryostatVersion

Signed-off-by: Thuan Vo <[email protected]>
cryostatio · Sep 15, 2023 · a40a77b · a40a77b
1 parent 0197f7b
commit a40a77b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/HTTP_API.md b/docs/HTTP_API.md
@@ -161,6 +161,7 @@
     `200` - The body is
     ```
         {
+          "cryostatVersion": "$CRYOSTAT_VERSION",
           "datasourceConfigured": $DATASOURCE_CONFIGURED,
           "datasourceAvailable": $DATASOURCE_AVAILABLE,
           "dashboardConfigured": $DASHBOARD_CONFIGURED,
@@ -169,6 +170,7 @@
           "reportsAvailable": $REPORTS_AVAILABLE
         }
     ```
+    `$CRYOSTAT_VERSION` is the version of the current Cryostat instance.
 
     `$DATASOURCE_CONFIGURED` is `true` if the relevant environment variable has
     been set to a non-empty value.