Feature/add enum validation for pageable#23518
Draft
Picazsoo wants to merge 5 commits intoOpenAPITools:masterfrom
Draft
Feature/add enum validation for pageable#23518Picazsoo wants to merge 5 commits intoOpenAPITools:masterfrom
Picazsoo wants to merge 5 commits intoOpenAPITools:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Adds sort enum validation for
Pageableinkotlin-spring(spring-boot) by generating a@ValidSortannotation and applying it to paginated operations whosesortparameter has enum values. This blocks invalid sort columns at request time.New Features
generateSortValidation(requiresbeanValidations=trueandlibrary=spring-boot) to generateValidSort.ktwith@ValidSortandSortValidatorinconfigPackage.x-spring-paginated: trueor viaautoXSpringPaginated) and injects@ValidSort(allowedValues=[...])whensorthas inline or$refenum values; skipped for non-paginated ops or whensortlacks an enum.kotlin-spring/validSort.mustache, test specpetstore-sort-validation.yaml, generator tests, and a sample atsamples/server/petstore/kotlin-springboot-sort-validation; CI updated to compile it.Migration
generateSortValidation: "true",beanValidations: "true", andlibrary: spring-boot(optionallyautoXSpringPaginated: "true").ValidSort.ktis generated under yourconfigPackage; set this if you need a custom package.sortquery parameter to activate validation.Written for commit 58fe32b. Summary will update on new commits.