[Java][Spring] remove 'size', 'page' and 'sort' query params if using 'x-spring-paginated' (#8315)#21016
Conversation
… 'x-spring-paginated' (#8315)
|
Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors. Let me know if you need help fixing it. |
|
also please fix the build failure when you've time |
|
Should be fixed now™, I naively adapted parts of the original commits, without checking for plausibility, and they edited the templates (samples/*/petstore/) instead of the templates for the templates (modules/openapi-generator/src/test/resources/3_0/spring). Changed that and explicitly executed generate-samples and utils/ensure-up-to-date, everything is now fine on my machine™ |
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-paginatedwith thespringorjava-camelgenerator,Pageableis generated as an additional controller argument.Spring Data
Pageableis designed to consume the query paramterspage,sizeandsortduring 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
Pageablecontroller argument, as the original values of the query params can be retrieved from it:This PR does exactly that - it removes the
page,sizeandsortquery params whenx-spring-paginatedis used with thespringorjava-camelgenerator andPageableis 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.0minor 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)