[java-spring;kotlin-spring] - feature: validate Pageable params [size, page, sort] and preserve defaults; Add 'autoXSpringPaginated' to java-spring

.github/workflows/samples-kotlin-server-jdk17.yaml

@@ -11,6 +11,7 @@ on:
       - 'samples/server/petstore/kotlin-server-required-and-nullable-properties/**'
       - 'samples/server/petstore/kotlin-spring-declarative*/**'
       - 'samples/server/petstore/kotlin-spring-sealed-interfaces/**'
+      - 'samples/server/petstore/kotlin-springboot-sort-validation/**'
       # comment out due to gradle build failure
       # - samples/server/petstore/kotlin-spring-default/**
   pull_request:
@@ -23,6 +24,7 @@ on:
       - 'samples/server/petstore/kotlin-server-required-and-nullable-properties/**'
       - 'samples/server/petstore/kotlin-spring-declarative*/**'
       - 'samples/server/petstore/kotlin-spring-sealed-interfaces/**'
+      - 'samples/server/petstore/kotlin-springboot-sort-validation/**'
       # comment out due to gradle build failure
       # - samples/server/petstore/kotlin-spring-default/**
 
@@ -62,6 +64,7 @@ jobs:
           - samples/server/petstore/kotlin-spring-declarative-interface-reactive-reactor-wrapped
           - samples/server/petstore/kotlin-spring-declarative-interface-wrapped
           - samples/server/petstore/kotlin-spring-sealed-interfaces
+          - samples/server/petstore/kotlin-springboot-sort-validation
           # comment out due to gradle build failure
           # - samples/server/petstore/kotlin-spring-default/
     steps:

.github/workflows/samples-spring-jdk17.yaml

@@ -14,6 +14,7 @@ on:
       - samples/server/petstore/springboot-lombok-tostring/**
       - samples/server/petstore/springboot-file-delegate-optional/**
       - samples/server/petstore/springboot-petstore-with-api-response-examples/**
+      - samples/server/petstore/springboot-sort-validation/**
       - samples/openapi3/server/petstore/spring-boot-oneof-sealed/**
       - samples/openapi3/server/petstore/spring-boot-oneof-interface/**
   pull_request:
@@ -29,6 +30,7 @@ on:
       - samples/server/petstore/springboot-lombok-tostring/**
       - samples/server/petstore/springboot-file-delegate-optional/**
       - samples/server/petstore/springboot-petstore-with-api-response-examples/**
+      - samples/server/petstore/springboot-sort-validation/**
       - samples/openapi3/server/petstore/spring-boot-oneof-sealed/**
       - samples/openapi3/server/petstore/spring-boot-oneof-interface/**
 jobs:
@@ -52,6 +54,7 @@ jobs:
           - samples/server/petstore/springboot-lombok-tostring
           - samples/server/petstore/springboot-file-delegate-optional
           - samples/server/petstore/springboot-petstore-with-api-response-examples
+          - samples/server/petstore/springboot-sort-validation
           - samples/openapi3/server/petstore/spring-boot-oneof-sealed
           - samples/openapi3/server/petstore/spring-boot-oneof-interface
     steps:

bin/configs/kotlin-spring-boot-3-no-response-entity.yaml

@@ -9,6 +9,6 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   useSpringBoot3: "true"
   requestMappingMode: api_interface

bin/configs/kotlin-spring-boot-3.yaml

@@ -9,6 +9,6 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   useSpringBoot3: "true"
   requestMappingMode: api_interface

bin/configs/kotlin-spring-boot-4.yaml

@@ -9,7 +9,7 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   useSpringBoot4: "true"
   useJackson3: "true"
   requestMappingMode: api_interface

bin/configs/kotlin-spring-boot-additionalproperties.yaml

@@ -9,6 +9,6 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   useSpringBoot3: "true"
   requestMappingMode: api_interface

bin/configs/kotlin-spring-boot-delegate-nodefaults.yaml

@@ -9,6 +9,6 @@ additionalProperties:
   useSwaggerUI: "true"
   delegatePattern: "true"
   skipDefaultInterface: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   requestMappingMode: "api_interface"
   useSpringBoot3: "true"

bin/configs/kotlin-spring-boot-delegate.yaml

@@ -9,5 +9,5 @@ additionalProperties:
   useSwaggerUI: "true"
   delegatePattern: "true"
   appendRequestToHandler: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   requestMappingMode: none

bin/configs/kotlin-spring-boot-include-http-request-context-delegate.yaml

@@ -11,7 +11,7 @@ additionalProperties:
   skipDefaultInterface: true
   interfaceOnly: false
   serializableModel: true
-  beanValidations: true
+  useBeanValidation: true
   includeHttpRequestContext: true
   reactive: true
   delegatePattern: true

bin/configs/kotlin-spring-boot-modelMutable.yaml

@@ -9,5 +9,5 @@ additionalProperties:
   useSwaggerUI: "true"
   serializableModel: "true"
   serviceImplementation: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   modelMutable: "true"

bin/configs/kotlin-spring-boot-no-response-entity-delegate.yaml

@@ -9,7 +9,7 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   useResponseEntity: "false"
   delegatePattern: true
   requestMappingMode: controller

bin/configs/kotlin-spring-boot-no-response-entity.yaml

@@ -9,6 +9,6 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   useResponseEntity: "false"
   requestMappingMode: controller

bin/configs/kotlin-spring-boot-reactive-without-flow.yaml

@@ -9,5 +9,5 @@ additionalProperties:
   useSwaggerUI: "true"
   serviceImplementation: "true"
   reactive: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   useFlowForArrayReturnType: "false"

bin/configs/kotlin-spring-boot-reactive.yaml

@@ -9,6 +9,6 @@ additionalProperties:
   useSwaggerUI: "true"
   serviceImplementation: "true"
   reactive: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   # the following option is set to true by default
   #useFlowForArrayReturnType: "true"

bin/configs/kotlin-spring-boot-sort-validation.yaml

@@ -0,0 +1,18 @@
+generatorName: kotlin-spring
+outputDir: samples/server/petstore/kotlin-springboot-sort-validation
+library: spring-boot
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-sort-validation.yaml
+templateDir: modules/openapi-generator/src/main/resources/kotlin-spring
+additionalProperties:
+  documentationProvider: none
+  annotationLibrary: none
+  useSwaggerUI: "false"
+  serviceImplementation: "false"
+  serializableModel: "true"
+  useBeanValidation: "true"
+  interfaceOnly: "true"
+  useSpringBoot3: "true"
+  generateSortValidation: "true"
+  generatePageableConstraintValidation: "true"
+  useTags: "true"
+  requestMappingMode: api_interface

bin/configs/kotlin-spring-boot-source-swagger1.yaml

@@ -9,5 +9,5 @@ additionalProperties:
   useSwaggerUI: "true"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   implicitHeaders: "true"

bin/configs/kotlin-spring-boot-source-swagger2.yaml

@@ -9,5 +9,5 @@ additionalProperties:
   useSwaggerUI: "true"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   implicitHeaders: "true"

bin/configs/kotlin-spring-boot-x-kotlin-implements.yaml

@@ -11,7 +11,7 @@ additionalProperties:
   skipDefaultInterface: true
   interfaceOnly: true
   serializableModel: true
-  beanValidations: true
+  useBeanValidation: true
   includeHttpRequestContext: true
   schemaImplements:
     Pet: com.some.pack.WithId

bin/configs/kotlin-spring-boot.yaml

@@ -9,5 +9,5 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   requestMappingMode: controller

bin/configs/kotlin-spring-cloud.yaml

@@ -8,5 +8,5 @@ additionalProperties:
   annotationLibrary: none
   useSwaggerUI: "false"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   interfaceOnly: "true"

bin/configs/kotlin-spring-declarative-interface-reactive-coroutines.yaml

@@ -8,7 +8,7 @@ additionalProperties:
   annotationLibrary: swagger2
   useSwaggerUI: "false"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   interfaceOnly: true
   reactive: true
   useResponseEntity: false

bin/configs/kotlin-spring-declarative-interface-reactive-reactor-wrapped.yaml

@@ -8,7 +8,7 @@ additionalProperties:
   annotationLibrary: swagger2
   useSwaggerUI: "false"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   interfaceOnly: true
   reactive: true
   useResponseEntity: true

bin/configs/kotlin-spring-declarative-interface-wrapped.yaml

@@ -8,7 +8,7 @@ additionalProperties:
   annotationLibrary: swagger2
   useSwaggerUI: "false"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   interfaceOnly: true
   reactive: false
   useResponseEntity: true

bin/configs/kotlin-spring-declarative-interface.yaml

@@ -8,7 +8,7 @@ additionalProperties:
   annotationLibrary: swagger2
   useSwaggerUI: "false"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"
   interfaceOnly: true
   reactive: false
   useResponseEntity: true

bin/configs/kotlin-spring-default.yaml

@@ -10,5 +10,5 @@ templateDir: modules/openapi-generator/src/main/resources/kotlin-spring
 #  useSwaggerUI: "false"
 #  serviceImplementation: "true"
 #  serializableModel: "true"
-#  beanValidations: "true"
+#  useBeanValidation: "true"
 #  useSpringBoot3: "true"

bin/configs/spring-boot-sort-validation.yaml

@@ -0,0 +1,20 @@
+generatorName: spring
+outputDir: samples/server/petstore/springboot-sort-validation
+library: spring-boot
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-sort-validation.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  documentationProvider: none
+  annotationLibrary: none
+  useSwaggerUI: "false"
+  serviceImplementation: "false"
+  serializableModel: "true"
+  useBeanValidation: "true"
+  interfaceOnly: "false"
+  skipDefaultInterface: "true"
+  useSpringBoot3: "true"
+  generateSortValidation: "true"
+  hideGenerationTimestamp: "true"
+  generatePageableConstraintValidation: "true"
+  useTags: "true"
+  requestMappingMode: api_interface

bin/configs/unmaintained/kotlin-spring-boot-reactive.yaml

@@ -9,4 +9,4 @@ additionalProperties:
   useSwaggerUI: "true"
   serviceImplementation: "true"
   reactive: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"

bin/configs/unmaintained/kotlin-spring-boot.yaml

@@ -9,4 +9,4 @@ additionalProperties:
   useSwaggerUI: "false"
   serviceImplementation: "true"
   serializableModel: "true"
-  beanValidations: "true"
+  useBeanValidation: "true"

docs/generators/java-camel.md

@@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
 |artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.| |1.0.0|
 |async|use async Callable controllers| |false|
+|autoXSpringPaginated|Automatically add x-spring-paginated to operations that have 'page', 'size', and 'sort' query parameters. When enabled, operations with all three parameters will have Pageable support automatically applied. Operations with x-spring-paginated explicitly set to false will not be auto-detected. Only applies when library=spring-boot.| |false|
 |basePackage|base package (invokerPackage) for generated code| |org.openapitools|
 |bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
 |booleanGetterPrefix|Set booleanGetterPrefix| |get|
@@ -62,6 +63,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |generateBuilders|Whether to generate builders for models| |false|
 |generateConstructorWithAllArgs|whether to generate a constructor for all arguments| |false|
 |generateGenericResponseEntity|Use a generic type for the `ResponseEntity` wrapping return values of generated API methods. If enabled, method are generated with return type ResponseEntity<?>| |false|
+|generatePageableConstraintValidation|Generate a @ValidPageable annotation and PageableConstraintValidator class, and apply @ValidPageable to the injected Pageable parameter of operations whose 'page' or 'size' parameter specifies a maximum constraint. The annotation enforces those constraints on the Pageable object that replaces the individual page/size query parameters. Requires useBeanValidation=true and library=spring-boot.| |false|
+|generateSortValidation|Generate a @ValidSort annotation and SortValidator class, and apply @ValidSort to the injected Pageable parameter of operations whose 'sort' parameter has enum values. The annotation validates that sort values in the Pageable object match the allowed enum values from the spec. Requires useBeanValidation=true and library=spring-boot.| |false|
 |generatedConstructorWithRequiredArgs|Whether to generate constructors with required args for models| |true|
 |groupId|groupId in generated pom.xml| |org.openapitools|
 |hateoas|Use Spring HATEOAS library to allow adding HATEOAS links| |false|

docs/generators/kotlin-spring.md

@@ -34,6 +34,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |documentationProvider|Select the OpenAPI documentation provider.|<dl><dt>**none**</dt><dd>Do not publish an OpenAPI specification.</dd><dt>**source**</dt><dd>Publish the original input OpenAPI specification.</dd><dt>**springdoc**</dt><dd>Generate an OpenAPI 3 specification using SpringDoc.</dd></dl>|springdoc|
 |enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |original|
 |exceptionHandler|generate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )| |true|
+|generatePageableConstraintValidation|Generate a @ValidPageable annotation and PageableConstraintValidator class, and apply @ValidPageable to the injected Pageable parameter of operations whose 'page' or 'size' parameter specifies a maximum constraint. The annotation enforces those constraints on the Pageable object that replaces the individual page/size query parameters. Requires useBeanValidation=true and library=spring-boot.| |false|
+|generateSortValidation|Generate a @ValidSort annotation and SortValidator class, and apply @ValidSort to the injected Pageable parameter of operations whose 'sort' parameter has enum values. The annotation validates that sort values in the Pageable object match the allowed enum values from the spec. Requires useBeanValidation=true and library=spring-boot.| |false|
 |gradleBuildFile|generate a gradle build file using the Kotlin DSL| |true|
 |groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
 |implicitHeaders|Skip header parameters in the generated API methods.| |false|

docs/generators/spring.md

@@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
 |artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename. If not provided, uses the version from the OpenAPI specification file. If that's also not present, uses the default value of the artifactVersion option.| |1.0.0|
 |async|use async Callable controllers| |false|
+|autoXSpringPaginated|Automatically add x-spring-paginated to operations that have 'page', 'size', and 'sort' query parameters. When enabled, operations with all three parameters will have Pageable support automatically applied. Operations with x-spring-paginated explicitly set to false will not be auto-detected. Only applies when library=spring-boot.| |false|
 |basePackage|base package (invokerPackage) for generated code| |org.openapitools|
 |bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
 |booleanGetterPrefix|Set booleanGetterPrefix| |get|
@@ -55,6 +56,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |generateBuilders|Whether to generate builders for models| |false|
 |generateConstructorWithAllArgs|whether to generate a constructor for all arguments| |false|
 |generateGenericResponseEntity|Use a generic type for the `ResponseEntity` wrapping return values of generated API methods. If enabled, method are generated with return type ResponseEntity<?>| |false|
+|generatePageableConstraintValidation|Generate a @ValidPageable annotation and PageableConstraintValidator class, and apply @ValidPageable to the injected Pageable parameter of operations whose 'page' or 'size' parameter specifies a maximum constraint. The annotation enforces those constraints on the Pageable object that replaces the individual page/size query parameters. Requires useBeanValidation=true and library=spring-boot.| |false|
+|generateSortValidation|Generate a @ValidSort annotation and SortValidator class, and apply @ValidSort to the injected Pageable parameter of operations whose 'sort' parameter has enum values. The annotation validates that sort values in the Pageable object match the allowed enum values from the spec. Requires useBeanValidation=true and library=spring-boot.| |false|
 |generatedConstructorWithRequiredArgs|Whether to generate constructors with required args for models| |true|
 |groupId|groupId in generated pom.xml| |org.openapitools|
 |hateoas|Use Spring HATEOAS library to allow adding HATEOAS links| |false|

docs/usage.md

@@ -555,7 +555,7 @@ openapi-generator-cli generate \
     -i petstore.yaml \
     -g kotlin-spring \
     -o out \
-    --additional-properties=library=spring-boot,beanValidations=true,serviceImplementation=true \
+    --additional-properties=library=spring-boot,useBeanValidation=true,serviceImplementation=true \
     --import-mappings=DateTime=java.time.LocalDateTime \
     --type-mappings=DateTime=java.time.LocalDateTime
 ```