Skip to content

Fix documentation inconsistencies - #50800

Merged
wilkinsona merged 1 commit into
spring-projects:mainfrom
doehyunbaek:report-candidates-doc-fixes
Jun 24, 2026
Merged

Fix documentation inconsistencies#50800
wilkinsona merged 1 commit into
spring-projects:mainfrom
doehyunbaek:report-candidates-doc-fixes

Conversation

@doehyunbaek

@doehyunbaek doehyunbaek commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

I found five documentation issues that still appear to be present on current main as of f71e797.

1. RestTemplateBuilder docs reference deprecated rootUri API

The @RestClientTest documentation still describes RestTemplateBuilder.rootUri(String) behavior:

When using a javadoc:org.springframework.boot.restclient.RestTemplateBuilder[] in the beans under test and `RestTemplateBuilder.rootUri(String rootUri)` has been called when building the javadoc:org.springframework.web.client.RestTemplate[], then the root URI should be omitted from the javadoc:org.springframework.test.web.client.MockRestServiceServer[] expectations as shown in the following example:
include-code::MyRestTemplateServiceTests[]
When using a javadoc:org.springframework.web.client.RestClient$Builder[] in the beans under test, or when using a javadoc:org.springframework.boot.restclient.RestTemplateBuilder[] without calling `rootUri(String rootURI)`, the full URI must be used in the javadoc:org.springframework.test.web.client.MockRestServiceServer[] expectations as shown in the following example:

But RestTemplateBuilder.rootUri(String) is deprecated in favor of RestTemplateBuilder.baseUri(String):

Introduced by:

2. LiveReload is documented as deprecated in one place but active elsewhere

The devtools reference documentation marks LiveReload as deprecated:

WARNING: Given its decrease in popularity and support, the LiveReload feature is deprecated as of Spring Boot 4.1.0 with no replacement.

But the Maven plugin and hotswapping documentation still present LiveReload as an active devtools feature without mentioning its deprecation:

Introduced by:

3. RabbitMQ Streams docs mention only the non-SSL port

The service connection docs state that RabbitMQ Streams containers need port 5552 exposed:

But when SSL is configured, the connection details code uses port 5551:

Introduced by:

4. Log4j2 rotation docs contain a typo

The logging documentation says Logback of Log4J2:

If you are using Logback of Log4J2, it is possible to fine-tune log rotation settings using your `application.properties` or `application.yaml` file.

This should be Logback or Log4j2.

Introduced by:

5. OAuth2 provider documentation omits x

OAuth2ClientProperties documents the common OAuth2 providers as google, github, facebook, and okta:

* Reference to the OAuth 2.0 provider to use. May reference one of the common
* providers (google, github, facebook, okta) or the ID of a custom provider

But Spring Security 7.1.0's CommonOAuth2Provider also includes X:

https://github.com/spring-projects/spring-security/blob/7.1.0/config/src/main/java/org/springframework/security/config/oauth2/client/CommonOAuth2Provider.java#L91-L102

Introduced by:

This PR fixes the above five issues.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 20, 2026
@wilkinsona

Copy link
Copy Markdown
Member

Thanks very much, @doehyunbaek. Of the 6 inconsistencies, 5 apply to main but one (number 5) applies to 4.0.x and main. Would you mind dropping 5 (commit a35391b) from this PR and opening a new PR for that change which uses 4.0.x as its base branch?

@wilkinsona wilkinsona added the status: waiting-for-feedback We need additional information before we can continue label Jun 24, 2026
@doehyunbaek
doehyunbaek force-pushed the report-candidates-doc-fixes branch from 11d99f1 to c66d494 Compare June 24, 2026 11:15
@doehyunbaek

Copy link
Copy Markdown
Contributor Author

Hi @wilkinsona. I opened a separate PR #50842 and made this PR contain only five commits bound to main. I'm not super confident I did everything right but hope I didn't mess up!

Thank you very much for reviewing my PR.

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Jun 24, 2026
@wilkinsona wilkinsona added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged status: feedback-provided Feedback has been provided labels Jun 24, 2026
@wilkinsona wilkinsona added this to the 4.1.x milestone Jun 24, 2026
@wilkinsona wilkinsona self-assigned this Jun 24, 2026
@wilkinsona
wilkinsona force-pushed the report-candidates-doc-fixes branch from c66d494 to f7c2c0b Compare June 24, 2026 14:44
@wilkinsona wilkinsona modified the milestones: 4.1.x, 4.1.1 Jun 24, 2026
@wilkinsona
wilkinsona merged commit f61b91c into spring-projects:main Jun 24, 2026
3 checks passed
@wilkinsona

Copy link
Copy Markdown
Member

You didn't mess up at all. Thanks very much for doing that and for the PR in general. Much appreciated.

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