diff --git a/doc/sources/admin/checkstate.rst b/doc/sources/admin/checkstate.rst index 2d7d64470..9db402ca6 100644 --- a/doc/sources/admin/checkstate.rst +++ b/doc/sources/admin/checkstate.rst @@ -25,6 +25,23 @@ GET Parameter Need Value ``password`` optional ============= ======== ============================================================ +Response +-------- + +The plugin will respond to the HTTP request with: + +* HTTP code 500 if something went wrong +* HTTP code 200 and the following JSON content if something went right + +``` +{"result":1,"version":"2.0.14"} +``` + +.. versionadded:: 2.0.14 + The *version* key is returned + + + Example ~~~~~~~ diff --git a/doc/sources/admin/upgrade_2_0_x.rst b/doc/sources/admin/upgrade_2_0_x.rst index 66d760d43..59c94c28b 100644 --- a/doc/sources/admin/upgrade_2_0_x.rst +++ b/doc/sources/admin/upgrade_2_0_x.rst @@ -29,6 +29,27 @@ None 2.0.14 ------ +LemonLDAP::NG version is returned by the CheckState plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you use the `/checkstate` URL to monitor LemonLDAP::NG, you may notice a slight change in the output format: + +*2.0.13* : + +``` +{"result":1} +``` + +*2.0.14* : + +``` +{"result":1,"version":"2.0.14"} +``` + +Depending on your load balancer or monitoring configuration, this can cause false negatives. + +This plugin is disabled by default, and you may use a shared secret to hide this information to regular users and bots, please check the :doc:`checkstate` documentation for more information. + Empty scopes now rejected in OAuth2.0 grants ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~