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

Clarify documentation on the usage of RestClient in POST scenarios without response body #34334

Closed
mrnst opened this issue Jan 29, 2025 · 2 comments
Assignees
Labels
in: web Issues in web modules (web, webmvc, webflux, websocket) type: documentation A documentation task
Milestone

Comments

@mrnst
Copy link

mrnst commented Jan 29, 2025

The documentation of Spring RestClient should reflect the change of behaviour in the RestClient's (or rather RestClient.RequestHeadersSpec's) retrieve() method since Spring Framework 6.2 more explicitly, especially its possible consequences in POST scenarios without response body.

The change is significant enough to break an application (which it did in my case, when I updated to Spring Boot 3.4). It took me quite some time and debugging to find out the reason although I immediately checked the above documentation.

I'm aware that the release notes for Spring Framework 6.2 and this javadoc describe the new behaviour.

But I think that an update to the above documentation would be very helpful for developers, because the current description appears to be misleading, and the new behaviour (which is: not to execute the request) is not necessarily what you would intuitively expect from a method named retrieve() and described as "Retrieve the response".

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Jan 29, 2025
@bclozel bclozel added type: documentation A documentation task in: web Issues in web modules (web, webmvc, webflux, websocket) and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Jan 29, 2025
@bclozel bclozel added this to the 6.2.3 milestone Jan 29, 2025
@bclozel bclozel self-assigned this Jan 29, 2025
@bclozel
Copy link
Member

bclozel commented Jan 29, 2025

Thanks for raising this. Changes should be visible in a few minutes in the SNAPSHOT reference docs.

@mrnst
Copy link
Author

mrnst commented Jan 30, 2025

Thank you, I appreciate that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: web Issues in web modules (web, webmvc, webflux, websocket) type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

3 participants