From 9d029985e4c05f100d20af718e7770036aecf0c6 Mon Sep 17 00:00:00 2001 From: Max Cao Date: Fri, 27 May 2022 18:38:56 -0400 Subject: [PATCH 1/2] fixed --- HTTP_API.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/HTTP_API.md b/HTTP_API.md index 2b97d7e0ad..344fc5ab7e 100644 --- a/HTTP_API.md +++ b/HTTP_API.md @@ -19,7 +19,6 @@ | Get the URL of Cryostat's Grafana dashboard | [`GrafanaDashboardUrlGetHandler`](#GrafanaDashboardUrlGetHandler) | | Get the URL of Cryostat's Grafana datasource | [`GrafanaDatasourceUrlGetHandler`](#GrafanaDatasourceUrlGetHandler) | | Check the status of Cryostat's Grafana datasource and dashboard | [`HealthGetHandler`](#HealthGetHandler) | -| Check the status of Cryostat itself | [`HealthLivenessGetHandler`](#HealthLivenessGetHandler) | | **Events and event templates** | | | Get a list of event types that can be produced by a target JVM | [`TargetEventsGetHandler`](#TargetEventsGetHandler) | | Get a list of event templates known to a target JVM | [`TargetTemplatesGetHandler`](#TargetTemplatesGetHandler) | @@ -202,24 +201,6 @@ ``` -* #### `HealthLivenessGetHandler` - - ###### synopsis - Returns whether or not Cryostat itself is running properly - by checking for a valid No Content response. - - ###### request - `GET /health/liveness` - - ###### response - `204` - There is no content to display. - - ###### example - ``` - $ curl localhost:8181/health/liveness - ``` - - * #### `StaticAssetsGetHandler` ###### synopsis @@ -1218,6 +1199,7 @@ The handler-specific descriptions below describe how each handler populates the | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------| | **Miscellaneous** | | | Check user authentication | [`AuthPostHandler`](#AuthPostHandler-1) | +| Check the status of Cryostat itself | [`HealthLivenessGetHandler`](#HealthLivenessGetHandler) | | **Target JVMs** | | | Add a custom target definition | [`TargetsPostHandler`](#TargetsPostHandler) | | Delete a custom target definition | [`TargetDeleteHandler`](#TargetDeleteHandler) | @@ -1273,6 +1255,24 @@ The handler-specific descriptions below describe how each handler populates the ``` +* #### `HealthLivenessGetHandler` + + ###### synopsis + Returns whether or not Cryostat itself is running properly + by checking for a valid No Content response. + + ###### request + `GET /health/liveness` + + ###### response + `204` - There is no content to display. + + ###### example + ``` + $ curl localhost:8181/health/liveness + ``` + + ### Target JVMs * #### `TargetsPostHandler` From b18417f44155ed7e6db7e2ce5d7b5df07d656cfc Mon Sep 17 00:00:00 2001 From: Max Cao Date: Fri, 27 May 2022 18:43:22 -0400 Subject: [PATCH 2/2] added note --- HTTP_API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HTTP_API.md b/HTTP_API.md index 344fc5ab7e..8dbf3a1401 100644 --- a/HTTP_API.md +++ b/HTTP_API.md @@ -1259,7 +1259,7 @@ The handler-specific descriptions below describe how each handler populates the ###### synopsis Returns whether or not Cryostat itself is running properly - by checking for a valid No Content response. + by checking for a valid No Content response (since: 2.2.0). ###### request `GET /health/liveness`