An info service API, perhaps at /info should be available.
Feature
This endpoint would fulfill a basic informational need about the running service, it would provide:
service version running
configuration excerpt (e.g. configured with dummy user/in-config-user-list/AD-connected)
~basic check that the API is up and running (loading this endpoint itself would prove that)~ -> implemented by #30
It is expected that this endpoint is available without authorization, so the information shared there should not be of sensitive nature.
Edit: As suggested by @TheLydonKing, the /info endpoint can also be implemented by the Spring actuator at /actuator/info. While not in SBT (examples in maven/gradle), this article nicely demonstrate some of the possibilities. Perhaps building this as part of the actuator could be easier.
The main points have not changed, we mainly need to include:
service version running (git hash would be nice, but not necessary
some form of configuration excerpt, e.g.:
{
"ldapUsed": true,
"localUsersDefined": 2
}
(the exact content is not too important, we can extend it later; the main point is to set up a way to expose certain fields/object from the configuration in the info (or related endpoint)
Background
An info service API, perhaps at
/infoshould be available.Feature
This endpoint would fulfill a basic informational need about the running service, it would provide:
It is expected that this endpoint is available without authorization, so the information shared there should not be of sensitive nature.
Edit: As suggested by @TheLydonKing, the /info endpoint can also be implemented by the Spring actuator at
/actuator/info. While not in SBT (examples in maven/gradle), this article nicely demonstrate some of the possibilities. Perhaps building this as part of the actuator could be easier.The main points have not changed, we mainly need to include: