Skip to content

Provide examples of Actuator custom endpoints in the reference documentation #23028

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

Closed

Conversation

bedla
Copy link
Contributor

@bedla bedla commented Aug 20, 2020

Hi,
while creating custom actuator with write operation I found that it would be handy to show in documentation some code example to get idea at first glance.
What do you think?
Thx
Ivos

Emphasize that parameter name in source code have to match name in request JSON.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Aug 20, 2020
@snicoll
Copy link
Member

snicoll commented Aug 21, 2020

@bedla fair point although the same can be said for the most-popular @ReadOperation. We also try to not write code directly in the doc but move that to actual code we import. Thanks for reporting it and submitting a PR, I'll polish things up.

@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Aug 21, 2020
@snicoll snicoll added this to the 2.2.x milestone Aug 21, 2020
@snicoll snicoll changed the title Actuator write operation parameter names code example Provide examples of Actuator custom endpoints in the reference documentation Aug 21, 2020
@bedla
Copy link
Contributor Author

bedla commented Aug 23, 2020

cool, thx. I will do better next time :)

@snicoll
Copy link
Member

snicoll commented Aug 24, 2020

@bedla thank you for making your first contribution to Spring Boot.

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

Successfully merging this pull request may close these issues.

3 participants