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

[tofi86]

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 this - 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

• [x] Read the contribution guidelines.
• [x] 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.
• [x] Run the following to build the project and update samples:

  ./mvnw clean package 
  ./bin/generate-samples.sh
  ./bin/utils/export_docs_generators.sh
  

  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*. For Windows users, please run the script in Git BASH.
• [x] File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
• [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09)

[ilopezv]

there is an estimated date to release this change?

[borsch]

@ilopezv could you please update your branch with latest master?

UPD: currently this seems to be a breaking change because this would break compilation for users who use x-spring-paginated. So this change can be merged only for 7.0.0. My proposition would be to add configuration property which will control whether to remove or not those three parameters and default behavior would be to keep them

[ilopezv]

@ilopezv could you please update your branch with latest master?

UPD: currently this seems to be a breaking change because this would break compilation for users who use x-spring-paginated. So this change can be merged only for 7.0.0. My proposition would be to add configuration property which will control whether to remove or not those three parameters and default behavior would be to keep them

sorry @borsch , i´m not the owner of the pull request.

[daniel-shuy]

I'm sad that this wasn't included as part of 7.0.0...

Since 7.1.0 introduces breaking changes, maybe this can be part of 7.2.0? 😬

[ritwik3856]

I want to use this feature is it available for is there any alternative to this because in my case also it was returning the List<Model> but I want Page<Model>.Till when it available to use publicly

[Dimibe]

Any update on this issue?