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

Use exchange rather than operation to refer to a request and response #733

Open
wilkinsona opened this issue Jun 15, 2021 · 0 comments
Open
Labels
type: enhancement Enhancement that adds a new feature

Comments

@wilkinsona
Copy link
Member

When REST Docs began there was no term in the Spring portfolio describing a request being sent to an endpoint and a response being received so "operation" was used. Since then, "exchange" has been adopted in Spring Framework. I'd like REST Docs to switch to using "exchange", primarily because I think consistency across the two projects is important but also because I think exchange is a better term anyway.

To ease migration, I'd like to introduce the use of exchange in 2.1 and deprecate the use of operation. I'm not sure how complex this will prove to be. There's quite a bit of code in the org.springframework.restdocs.operation and org.springframework.restdocs.operation.preprocess packages although not all of it is public or commonly used. There's also the operation Asciidoctor macro to consider.

@wilkinsona wilkinsona added this to the 2.1.0-RC1 milestone Jun 15, 2021
@wilkinsona wilkinsona added the type: enhancement Enhancement that adds a new feature label Jun 15, 2021
@wilkinsona wilkinsona removed this from the 2.1.0-RC1 milestone Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Enhancement that adds a new feature
Projects
None yet
Development

No branches or pull requests

1 participant