Skip to content

Conversation

@Narbe66
Copy link

@Narbe66 Narbe66 commented Nov 23, 2025

Added a new configOption to set return types of paginated operations. fixes #14062

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 WSL)
    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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Copilot AI review requested due to automatic review settings November 23, 2025 09:47
Copilot finished reviewing on behalf of Narbe66 November 23, 2025 09:51
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds support for configuring paginated return types in Spring code generation through a new paginatedReturnType configuration option. When operations use the x-spring-paginated vendor extension, developers can now choose whether collection responses should use List, Page, or Slice from Spring Data Domain.

Key Changes

  • Introduced PaginatedReturnType enum with three options: LIST (default), PAGE, and SLICE
  • Added logic to transform List container types to Page or Slice when x-spring-paginated is present
  • Included CLI option configuration and documentation for the new feature

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java Adds PaginatedReturnType enum, configuration option setup, and logic to transform return container types for paginated operations. Also includes several code style improvements (isEmpty, Collections.singletonList, etc.)
modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java Adds two test cases validating PAGE and SLICE return types for paginated operations
docs/generators/spring.md Documents the new paginatedReturnType configuration option and updates x-spring-paginated vendor extension description

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Narbe66 Narbe66 marked this pull request as draft November 23, 2025 18:34
…en/languages/SpringCodegen.java

Co-authored-by: Copilot <[email protected]>
@Narbe66 Narbe66 marked this pull request as ready for review November 23, 2025 19:49
@Narbe66
Copy link
Author

Narbe66 commented Nov 23, 2025

I'm not able to do the WSL part. Can some please do it for me.

@wing328
Copy link
Member

wing328 commented Nov 24, 2025

I'm not able to do the WSL part. Can some please do it for me.

ok. we will do it later. don't worry. thanks for the PR

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[REQ] [Java][Spring] Return 'Page<Model>' instead of 'List<Model>' when using 'x-spring-paginated'

2 participants