Skip to content

[SPRING;KOTLIN-SPRING] Fix: enhance pageable parameter detection with OpenAPI reference resolution - #24758

Merged
wing328 merged 2 commits into
OpenAPITools:masterfrom
Picazsoo:bugfix/24719
Aug 24, 2026
Merged

wing328 merged 2 commits into
OpenAPITools:masterfrom
Picazsoo:bugfix/24719

Conversation

@Picazsoo

@Picazsoo Picazsoo commented Aug 22, 2026 •

Copy link
Copy Markdown
Contributor

fixes #24719

PR checklist

  • Read the contribution guidelines.
  • 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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. - tagging @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10)

Summary by cubic

Fixes pageable auto-detection in Spring and Kotlin-Spring by resolving OpenAPI parameter refs. Previously, operations using #/components/parameters for page, size, or sort were not detected; now they inject Pageable and generate validations from referenced schemas.

  • SpringPageableScanUtils resolves refs via ModelUtils.getReferencedParameter; overloads willBePageable and applyAutoXSpringPaginatedIfNeeded to accept OpenAPI; scans for defaults, constraints, and sort enums resolve refs.
  • SpringCodegen and KotlinSpringServerCodegen now pass openAPI to applyAutoXSpringPaginatedIfNeeded.
  • Honors x-spring-paginated: false and AUTO_X_SPRING_PAGINATED; unresolved refs do not trigger detection.
  • Adds OAS 3.1 tests and a fixture validating ref-driven Pageable injection, defaults (@PageableDefault), constraints (@ValidPageable), and sort validation (@ValidSort), plus a test ensuring unresolved refs are ignored.

Written for commit eb4eda8. Summary will update on new commits.

Review in cubic

@Picazsoo Picazsoo changed the title fix(spring;kotlin-spring): enhance pageable parameter detection with … [SPRING;KOTLIN-SPRING] Fix: enhance pageable parameter detection with … Aug 22, 2026
@Picazsoo Picazsoo changed the title [SPRING;KOTLIN-SPRING] Fix: enhance pageable parameter detection with … [SPRING;KOTLIN-SPRING] Fix: enhance pageable parameter detection with OpenAPI reference resolution Aug 22, 2026
@Picazsoo
Picazsoo marked this pull request as ready for review August 22, 2026 23:18
@Picazsoo
Picazsoo marked this pull request as draft August 22, 2026 23:18

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 7 files

Re-trigger cubic

@Picazsoo
Picazsoo marked this pull request as ready for review August 22, 2026 23:25
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@wing328
wing328 merged commit da510a9 into OpenAPITools:master Aug 24, 2026
15 checks passed
@wing328 wing328 added this to the 7.25.0 milestone Aug 24, 2026
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.

[BUG][Spring] autoXSpringPaginated does not detect page/size/sort when the parameters are $ref'd in an OpenAPI 3.1 spec

2 participants