Skip to content

Feature/add enum validation for pageable#23518

Draft
Picazsoo wants to merge 5 commits intoOpenAPITools:masterfrom
Picazsoo:feature/add-enum-validation-for-pageable
Draft

Feature/add enum validation for pageable#23518
Picazsoo wants to merge 5 commits intoOpenAPITools:masterfrom
Picazsoo:feature/add-enum-validation-for-pageable

Conversation

@Picazsoo
Copy link
Copy Markdown
Contributor

@Picazsoo Picazsoo commented Apr 10, 2026

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.

Summary by cubic

Adds sort enum validation for Pageable in kotlin-spring (spring-boot) by generating a @ValidSort annotation and applying it to paginated operations whose sort parameter has enum values. This blocks invalid sort columns at request time.

  • New Features

    • New option generateSortValidation (requires beanValidations=true and library=spring-boot) to generate ValidSort.kt with @ValidSort and SortValidator in configPackage.
    • Detects pageable operations (x-spring-paginated: true or via autoXSpringPaginated) and injects @ValidSort(allowedValues=[...]) when sort has inline or $ref enum values; skipped for non-paginated ops or when sort lacks an enum.
    • Added kotlin-spring/validSort.mustache, test spec petstore-sort-validation.yaml, generator tests, and a sample at samples/server/petstore/kotlin-springboot-sort-validation; CI updated to compile it.
  • Migration

    • Enable with generateSortValidation: "true", beanValidations: "true", and library: spring-boot (optionally autoXSpringPaginated: "true").
    • ValidSort.kt is generated under your configPackage; set this if you need a custom package.
    • Add enum values to your sort query parameter to activate validation.

Written for commit 58fe32b. Summary will update on new commits.

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.

1 participant