[Java][Spring] remove 'size', 'page' and 'sort' query params if using 'x-spring-paginated' (#8315) #21016
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.
This PR is a revival of pull/14064, including resolving the merge conflicts.
Quoted from original PR:
This PR solves the issue #8315.
When using
x-spring-paginated
with thespring
orjava-camel
generator,Pageable
is generated as an additional controller argument.Spring Data
Pageable
is designed to consume the query paramterspage
,size
andsort
during request handling as described here or here.When following an API first development pattern, you would usually specify these query parameters in the spec which results in a controller method like the following:
While this approach and the spec is correct, this is normally not what you want to have as a Spring developer. You'd prefer just the
Pageable
controller argument, as the original values of the query params can be retrieved from it:This PR does exactly that - it removes the
page
,size
andsort
query params whenx-spring-paginated
is used with thespring
orjava-camel
generator andPageable
is generated.PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master
(upcoming7.x.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)