Skip to content

Fix typos in actuator docs for "when_authorized" #42700

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
wants to merge 1 commit into from

Conversation

t0r0X
Copy link

@t0r0X t0r0X commented Oct 15, 2024

This PR fixes two typos in documentation of actuator health endpoints:
"Spring Boot > Reference > Production-ready Features > Endpoints"

https://docs.spring.io/spring-boot/reference/actuator/endpoints.html#actuator.endpoints.health

Wrong: when-authorized
Correct: when_authorized

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 15, 2024
@philwebb
Copy link
Member

Thanks, but we prefer kebab case in properties and both of those should work in that form.

@philwebb philwebb closed this Oct 15, 2024
@philwebb philwebb added status: declined A suggestion or change that we don't feel we should currently apply and removed status: waiting-for-triage An issue we've not yet triaged labels Oct 15, 2024
@t0r0X
Copy link
Author

t0r0X commented Oct 16, 2024

I did know that kebab-case is preferred for properties names, does this also apply to properties values?
The PR is about the value of property management.endpoint.health.show-details, not the name. Its own documentation says:

Values:
    never:           ...
    when_authorized: ...
    always:          ...

Also please note that in this section https://docs.spring.io/spring-boot/reference/actuator/endpoints.html#actuator.endpoints.sanitization there are already two usages of the enum value, but with upper case: show-values: WHEN_AUTHORIZED (backed by enum org.springframework.boot.actuate.endpoint.Show)

@philwebb
Copy link
Member

Yes, we generally use it for both. That's the format used in the configuration properties metadata file. Thanks for pointing out the issue with the "Sanitize Sensitive Values" section, I've fixed that in #42702

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: declined A suggestion or change that we don't feel we should currently apply
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants