Merge remote-tracking branch 'origin/feature/add-enum-validation-for-pageable' into feature/add-enum-validation-for-pageable

Author: Picazsoo

.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:

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringPageableScanUtils.java

@@ -24,15 +24,14 @@
 import io.swagger.v3.oas.models.parameters.Parameter;
 import org.openapitools.codegen.utils.ModelUtils;
 
-import java.math.BigDecimal;
 import java.util.*;
 import java.util.stream.Collectors;
 
 /**
  * Language-agnostic utility methods for scanning OpenAPI specs for Spring Pageable-related
  * features: sort enum validation, pageable defaults, and pageable constraints (max page/size).
  *
- * <p>Used by both {@link KotlinSpringServerCodegen} and (future) Java Spring codegen to share
+ * <p>Used by both kotlin {@link KotlinSpringServerCodegen} and java {@link SpringCodegen} to share
  * scan logic. Only the mustache templates and their registration remain language-specific.</p>
  */
 public final class SpringPageableScanUtils {

modules/openapi-generator/src/main/resources/JavaSpring/validPageable.mustache

@@ -66,6 +66,10 @@ public @interface ValidPageable {
                 return true;
             }
 
+            if (!pageable.isPaged()) {
+                return true;
+            }
+
             boolean valid = true;
             context.disableDefaultConstraintViolation();
 

modules/openapi-generator/src/main/resources/kotlin-spring/validPageable.mustache

@@ -53,6 +53,7 @@ class PageableConstraintValidator : ConstraintValidator<ValidPageable, Pageable>
 
     override fun isValid(pageable: Pageable?, context: ConstraintValidatorContext): Boolean {
         if (pageable == null) return true
+        if (!pageable.isPaged) return true
 
         var valid = true
         context.disableDefaultConstraintViolation()

samples/server/petstore/kotlin-springboot-sort-validation/src/main/kotlin/org/openapitools/configuration/ValidPageable.kt

@@ -53,6 +53,7 @@ class PageableConstraintValidator : ConstraintValidator<ValidPageable, Pageable>
 
     override fun isValid(pageable: Pageable?, context: ConstraintValidatorContext): Boolean {
         if (pageable == null) return true
+        if (!pageable.isPaged) return true
 
         var valid = true
         context.disableDefaultConstraintViolation()

samples/server/petstore/kotlin-springboot-sort-validation/src/test/kotlin/org/openapitools/api/PetApiValidationTest.kt

@@ -92,6 +92,14 @@ class PetApiValidationTest {
         }.andExpect { status { isBadRequest() } }
     }
 
+    @Test
+    fun `ValidPageable - unpaged Pageable is allowed (no params, no PageableDefault)`() {
+        // When no pagination parameters are supplied and no @PageableDefault is configured,
+        // Spring resolves Pageable.unpaged(). The validator must not throw and must return valid.
+        mockMvc.get("${PetApi.BASE_PATH}${PetApi.PATH_FIND_PETS_WITH_SIZE_CONSTRAINT}")
+            .andExpect { status { isOk() } }
+    }
+
     // ── @ValidPageable — size and page constraints combined ───────────────────
     // Endpoint: GET /pet/findWithPageAndSizeConstraint  maxSize = 50, maxPage = 999
 

samples/server/petstore/springboot-sort-validation/src/main/java/org/openapitools/configuration/ValidPageable.java

@@ -66,6 +66,10 @@ public boolean isValid(Pageable pageable, ConstraintValidatorContext context) {
                 return true;
             }
 
+            if (!pageable.isPaged()) {
+                return true;
+            }
+
             boolean valid = true;
             context.disableDefaultConstraintViolation();
 

samples/server/petstore/springboot-sort-validation/src/test/java/org/openapitools/api/PetApiValidationTest.java

@@ -96,6 +96,14 @@ void validPageable_sizeExceedsMaximumReturns400() throws Exception {
                 .andExpect(status().isBadRequest());
     }
 
+    @Test
+    void validPageable_unpagedPageableIsAllowed() throws Exception {
+        // When no pagination parameters are supplied and no @PageableDefault is configured,
+        // Spring resolves Pageable.unpaged(). The validator must not throw and must return valid.
+        mockMvc.perform(get(PetApi.PATH_FIND_PETS_WITH_SIZE_CONSTRAINT))
+                .andExpect(status().isOk());
+    }
+
     // ── @ValidPageable — size and page constraints combined ───────────────────
     // Endpoint: GET /pet/findWithPageAndSizeConstraint  maxSize = 50, maxPage = 999