Commit 80199ded authored by Frank Dietrich's avatar Frank Dietrich
Browse files

add health-interface to interface documentation

parent dec601ec
Loading
Loading
Loading
Loading
+39 −0
Original line number Diff line number Diff line
@@ -348,5 +348,44 @@ This service returns all users belonging to the specified role.

*Remarks*:

=== Get health state
This service returns the health state of this module.

*URL:* /healthcheck/pretty=true

*Method:* GET



*Request-Headers*:

* Authorization – none


*Produces*: application/json

*Response*:

If the module is healthy then...
[source,json]
----
{"Keycloak present":{"healthy":true}}
----

If the module is *not* healthy...
[source,json]
----
{
    "Keycloak present":
    {
        "healthy":false,
        "message":"<Error message>"
    }
}
----


*Remarks*: