From a40a77bee92b69d4ca4465f0ffbed734bc6e819d Mon Sep 17 00:00:00 2001 From: Thuan Vo Date: Fri, 15 Sep 2023 12:30:02 -0700 Subject: [PATCH] doc(http): update health endpoint to include cryostatVersion Signed-off-by: Thuan Vo --- docs/HTTP_API.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/HTTP_API.md b/docs/HTTP_API.md index a63f31fd3a..9d17256279 100644 --- 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.