This repository was archived by the owner on May 14, 2025. It is now read-only.
Fix rest documentation for changes to spring-rest-docs #6012
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update request-parameters to query-parameters Added optional where applicable Added snippet template to query-parameters and updated template for path-parameters to improve readability. Fixes spring-attic#6008
cppwfs
suggested changes
Oct 24, 2024
| @@ -233,15 +233,18 @@ void listTaskExecutions() throws Exception { | |||
|
|
|||
| this.mockMvc.perform( | |||
| get("/tasks/executions") | |||
| .queryParam("page", "1") | |||
| .queryParam("size", "2")) | |||
| .queryParam("page", "0") | |||
There was a problem hiding this comment.
Just curious why the change in page and size?
There was a problem hiding this comment.
To ensure result has data we needed page=0.
I thought size=10 is a good consistent value across usages.
| .queryParam("page", "0") | ||
| .queryParam("size", "10") | ||
| .queryParam("sort", "END_TIME,desc") | ||
| ) | ||
| .andDo(print()) |
There was a problem hiding this comment.
nitpick: We can remove the print() statement. Let's save those for debugging.
There was a problem hiding this comment.
Removed print from all documentation classes.
| parameterWithName("size") | ||
| .description("The requested page size (optional)")), | ||
| .description("The requested page size")), |
There was a problem hiding this comment.
We are missing the .optional() method here.
|
@corneil Looks really good. Just a one small correction, one question, and a nitpick |
added 2 commits
October 25, 2024 13:09
Fixed missing optional Removed print()
cppwfs
approved these changes
Oct 25, 2024
|
@corneil thanks for the good work and investigation on this! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update request-parameters to query-parameters
Added optional where applicable
Added snippet template to query-parameters and updated template for path-parameters to improve readability.
Fixes #6008