Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spring Boot 2.x Actuator Endpoints #854

Open
mgardiner opened this issue Apr 24, 2018 · 4 comments
Open

Spring Boot 2.x Actuator Endpoints #854

mgardiner opened this issue Apr 24, 2018 · 4 comments

Comments

@mgardiner
Copy link

mgardiner commented Apr 24, 2018

Update Enunciate to support documenting Spring Boot's 2.x Actuator endpoints.

See https://docs.spring.io/spring-boot/docs/2.0.1.RELEASE/reference/htmlsingle/#production-ready-endpoints

@panchenko
Copy link
Contributor

IMHO that's already documented: https://docs.spring.io/spring-boot/docs/2.0.x/actuator-api/html/
@mgardiner what would like to achieve exactly?

@mgardiner
Copy link
Author

@panchenko, the idea is to have Enunciate "automatically" generate HTML documentation for the Spring Boot actuators that have been enabled within a Spring Boot application to provide visibility into which Spring Boot actuators have been made public.

For example, lets say I wish to only enable the /actuator/info and /actuator/healthcheck Spring Boot actuator endpoints for my application; I would expect Enunciate to detect that during build time and generate the appropriate API documentation along with all my other REST APIs that I have written.

@panchenko
Copy link
Contributor

panchenko commented Apr 25, 2018

Enunciate is indeed executed during build time, but you can change endpoint configuration after that. There is some mismatch here.

@mgardiner
Copy link
Author

I agree there is some mismatch in that it is possible to override which actuator endpoints are enabled or not but to do so requires access to the server / Docker instance which in our case we don't allow in our production instances.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants