Skip to content

[Java][Spring] remove 'size', 'page' and 'sort' query params if using 'x-spring-paginated' (#8315) #21016

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

30p87
Copy link

@30p87 30p87 commented Apr 2, 2025

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 the spring or java-camel generator, Pageable is generated as an additional controller argument.

Spring Data Pageable is designed to consume the query paramters page, size and sort 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:

public ResponseEntity<List<Model>> getAllModels(Integer page, Integer size, String sort, Pageable pageable) {
    ...
}

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:

public ResponseEntity<List<Model>> getAllModels(Pageable pageable) {
    int page = pageable.getPageNumber();
    int size = pageable.getPageSize();
    Sort sort = pageable.getSort();
}

This PR does exactly that - it removes the page, size and sort query params when x-spring-paginated is used with the spring or java-camel generator and Pageable is generated.


PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@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)

@wing328
Copy link
Member

wing328 commented Apr 9, 2025

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.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328
Copy link
Member

wing328 commented Apr 9, 2025

also please fix the build failure when you've time

@30p87
Copy link
Author

30p87 commented Apr 9, 2025

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™

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants