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

Support Spring REST Docs 3.0.0 (#211) #225

Merged

Conversation

tobiaskrauss
Copy link
Contributor

@tobiaskrauss tobiaskrauss commented Jan 24, 2023

According to spring-rest-docs 'requestParameters' are replaced by 'queryParameters' and 'formParameters'.
If 'requestParameters' are used to document the API, this must be replaced by one of the new functions

Upgrades (needed to use spring-rest-docs 3.0.0):

  • gradle 7.6
  • kotlin 1.7.10
  • spring-boot 3.0.2
  • java 17

Relates to #211

According to spring-rest-docs 'requestParameters' are replaced by
'queryParameters' and 'formParameters'.
If 'requestParameters' are used to document the API, this must be replaced
by one of the new functions

Upgrades (needed to use spring-rest-docs 3.0.0):
* gradle 7.6
* kotlin 1.7.10
* spring-boot 3.0.2
* java 17
@tobiaskrauss tobiaskrauss marked this pull request as draft January 24, 2023 10:21

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@tobiaskrauss tobiaskrauss force-pushed the upgrade-to-spring-restdocs-3.0.x branch from 33be220 to 3540b3a Compare January 24, 2023 10:44
@coveralls
Copy link

coveralls commented Jan 24, 2023

Coverage Status

Coverage: 92.327% (-0.7%) from 92.999% when pulling 0cf4133 on tobiaskrauss:upgrade-to-spring-restdocs-3.0.x into 9b84729 on ePages-de:master.

@tobiaskrauss tobiaskrauss marked this pull request as ready for review January 24, 2023 11:35
@ozscheyge ozscheyge self-assigned this Jan 24, 2023
@tobiaskrauss
Copy link
Contributor Author

I just figured out that I missed the plugin part at least. I gonna change this PR to a draft again. Sorry for any inconvenience.

@tobiaskrauss tobiaskrauss marked this pull request as draft January 24, 2023 14:22
@tobiaskrauss
Copy link
Contributor Author

Tested with upgraded sample app, which is not finally done but can be seen in this branch.
The generated files and diffs for the sample app are attached.
test-with-sample.zip

@tobiaskrauss tobiaskrauss force-pushed the upgrade-to-spring-restdocs-3.0.x branch from 56ed8e8 to 0cf4133 Compare January 30, 2023 13:02
@tobiaskrauss tobiaskrauss marked this pull request as ready for review January 30, 2023 16:16
@ozscheyge
Copy link
Contributor

Thanks a lot for this effort!
Checking the diffs, there seems to be an issue with the HAL links in the example app, but that's likely local to the example app upgrade and not this PR.

@tobiaskrauss
Copy link
Contributor Author

Thanks a lot for this effort! Checking the diffs, there seems to be an issue with the HAL links in the example app, but that's likely local to the example app upgrade and not this PR.

You are welcome. We are using this project for quite some time so thanks for maintaining.
Regarding the sample: I gonna try to fix the HAL links and create the PR after this is released.

@ozscheyge ozscheyge merged commit 2d5bb22 into ePages-de:master Jan 31, 2023
@tobiaskrauss tobiaskrauss deleted the upgrade-to-spring-restdocs-3.0.x branch January 31, 2023 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants