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

Update documentation about endpoint enablement to reflect behaviour of @ConditionalOnAvailableEndpoint #18814

Closed
wilkinsona opened this issue Oct 30, 2019 · 12 comments
Assignees
Labels
type: documentation A documentation update

Comments

@wilkinsona
Copy link
Member

In 2.2, we introduced @ConditionalOnAvailableEndpoint so that an endpoint is now only auto-configured if it's available. Being available means that an endpoint is both enabled and exposed (made remotely accessible) over HTTP or JMX. The documentation is out of date at the moment as it states that an endpoint's enabled property "controls whether or not the endpoint is created and its bean exists in the application context".

@ericus20
Copy link
Contributor

ericus20 commented Jan 2, 2020

How can I take up this issue and work on it?

@mbhave
Copy link
Contributor

mbhave commented Jan 3, 2020

@ericus20 Sure, I've assigned it to spring-contributor to indicate that you're working on it.

@ericus20
Copy link
Contributor

This issue seems to be addressed already per the documentation I am seeing for https://docs.spring.io/spring-boot/docs/2.2.3.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/endpoint/condition/ConditionalOnAvailableEndpoint.html Please let me know if that is not correct.

@wilkinsona
Copy link
Member Author

@ericus20 Thanks for taking a look. The problem is with the reference documentation rather than the javadoc. The section that I quoted above can be found here.

@wilkinsona
Copy link
Member Author

How's it going, @ericus20?

@spencergibb
Copy link
Member

I think someone else needs to pick this up as we're seeing questions on the spring cloud side.

@ericus20
Copy link
Contributor

Let me wrap up my changes and submit it for review this weekend. I had an emergency and sorry for the late response.

@wilkinsona
Copy link
Member Author

wilkinsona commented Mar 25, 2020

Hi, @ericus20. How's it going? It's a weird time for everyone right now so no worries at all if you haven't been able to make the progress that you'd hoped to make. If you'd like someone else to pick this one up, please let us know.

@ericus20
Copy link
Contributor

Hello, @wilkinsona I haven't been able to make the progress I hoped due to certain procedures I went through but I am currently able and willing to take it from here and will update it accordingly as I am cleared to work.

@wilkinsona
Copy link
Member Author

Great stuff, thank you. We'll look forward to hearing from you soon. Please let us know if you have any questions.

@ericus20
Copy link
Contributor

ericus20 commented Apr 2, 2020

A PR has been created for this issue #20799

@wilkinsona
Copy link
Member Author

Closing in favour of #20799.

@wilkinsona wilkinsona removed this from the 2.2.x milestone Apr 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

5 participants