[JAVA-SPRING,KOTLIN-SPRING] - Enhance pageable validation by adding minSize and minPage constraints; Search also allOf references for constraints; fix PagedModel<T> substitution with 'modelNameSuffix' or 'modelNamePrefix'; add ValuedEnum<T> interface (#23694)

* Enhance pageable validation by adding minSize and minPage constraints. Search also allOf references for constraints and defaults

* update samples

* fix test

* use ModelUtils in SpringPageableScanUtils

* update tests in samples

* move reusable code to shared ModelUtils.java

* add tests

* fix CR suggestion and add tests

* suppress paged schemas correctly when modelNameSuffix/Prefix is set

* refactor: enhance pageable constraints handling with exclusive bounds support

* DRY code

* refactor: improve resolution of nested allOf constraints for maximum and minimum bounds

* re-enable test

* test: fix implementation and add unit test for resolving default in nested allOf schemas

* add comment to explain that behavior around default is undefined in open api spec

* pageable-scan-resolve-allof-constraints refactor: streamline pageable handling and enhance annotation application logic

* feat: add support for ValuedEnum interface in code generation for enums

* fix: remove Pageable support for non-spring-boot libraries and update related documentation

* update documentation

* fix: update default resolution logic for allOf schemas to last-writer-wins semantics

* fix: ensure correct parent reference ordering in allOf for default resolution

* DRY code

* DRY code

* revert default-resolution related changes as the behavior is unspecified and therefore dangerous

* add missing PetApiController implementations and validation tests for allOf-resolved constraints

* fix(kotlin-spring): container inline enums must not get `override val value`

EnumValueInterfaceUtils.injectInPostProcessModelsEnum() adds
ValuedEnum<...> to x-kotlin-implements only for `var.isEnum &&
!var.isContainer`, but dataClass.mustache emitted the `override` keyword
for every enum whenever useEnumValueInterface=true. Container inline
enums therefore produced uncompilable Kotlin (`overrides nothing`) since
the enum class did not actually implement any interface to override.

Gating the `override` token on `^isContainer` keeps the template in sync
with the util.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* feat(kotlin-spring and java-spring): add ValuedEnum interface and update related configurations to verify compilation success for both javax and jakarta setups in kotlin and java spring

* update samples

* update samples

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: Picazsoo

bin/configs/kotlin-spring-boot-integer-enum.yaml

@@ -11,3 +11,4 @@ additionalProperties:
   annotationLibrary: none
   documentationProvider: none
   enumPropertyNaming: UPPERCASE
+  useEnumValueInterface: "true"

bin/configs/kotlin-spring-boot.yaml

@@ -11,3 +11,5 @@ additionalProperties:
   serializableModel: "true"
   useBeanValidation: "true"
   requestMappingMode: controller
+  useEnumValueInterface: "true"
+  useSpringBoot3: "false"

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

@@ -15,3 +15,4 @@ additionalProperties:
   generateBuilders: true
   includeHttpRequestContext: "true"
   delegatePattern: true
+  useEnumValueInterface: "true"

bin/configs/spring-boot-4.yaml

@@ -15,3 +15,4 @@ additionalProperties:
   generateConstructorWithAllArgs: true
   generateBuilders: true
   openApiNullable: false
+  useEnumValueInterface: "true"

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

@@ -18,3 +18,4 @@ additionalProperties:
   generatePageableConstraintValidation: "true"
   useTags: "true"
   requestMappingMode: api_interface
+  useEnumValueInterface: "true"

bin/configs/spring-boot.yaml

@@ -9,3 +9,5 @@ additionalProperties:
   hideGenerationTimestamp: "true"
   camelCaseDollarSign: "true"
   modelNameSuffix: 'Dto'
+  useEnumValueInterface: "true"
+  useSpringBoot3: "false"

docs/generators/java-camel.md

@@ -112,6 +112,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useBeanValidation|Use BeanValidation API annotations| |true|
 |useDeductionForOneOfInterfaces|Annotate discriminator-free oneOf interfaces with Jackson's @JsonTypeInfo(use = Id.DEDUCTION) and @JsonSubTypes so the concrete subtype is resolved from the JSON field set rather than a type-tag property. Has no effect when a discriminator is present (name-based resolution is used instead). Requires subtypes to have structurally distinct sets of properties.| |false|
 |useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
+|useEnumValueInterface|Generate a ValuedEnum<T> interface in the config package and make all generated enums implement it, providing a common typed way to access the underlying enum value. Use `importMappings.ValuedEnum` to substitute a custom/library-provided interface instead of generating one.| |false|
 |useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
 |useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
 |useHttpServiceProxyFactoryInterfacesConfigurator|Generate HttpInterfacesAbstractConfigurator based on an HttpServiceProxyFactory instance (as opposed to a WebClient instance, when disabled) for generating Spring HTTP interfaces.| |false|
@@ -145,7 +146,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
 |x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
 |x-operation-extra-annotation|List of custom annotations to be added to operation|OPERATION|null
-|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
+|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object. Only applies when `library=spring-boot`; ignored for client libraries (spring-cloud, spring-declarative-http-interface).|OPERATION|false
 |x-version-param|Marker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/false|OPERATION_PARAMETER|null
 |x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
 |x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null

docs/generators/kotlin-spring.md

@@ -63,6 +63,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |title|server title name or client service name| |OpenAPI Kotlin Spring|
 |useBeanValidation|Use BeanValidation API annotations to validate data types| |true|
 |useDeductionForOneOfInterfaces|Annotate discriminator-free oneOf interfaces with Jackson's @JsonTypeInfo(use = Id.DEDUCTION) and @JsonSubTypes so the concrete subtype is resolved from the JSON field set rather than a type-tag property. Has no effect when a discriminator is present (name-based resolution is used instead). Requires subtypes to have structurally distinct sets of properties.| |false|
+|useEnumValueInterface|Generate a ValuedEnum<T> interface in the config package and make all generated enums implement it, providing a common typed way to access the underlying enum value. Use `importMappings.ValuedEnum` to substitute a custom/library-provided interface instead of generating one.| |false|
 |useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
 |useFlowForArrayReturnType|Whether to use Flow for array/collection return types when reactive is enabled. If false, will use List instead.| |true|
 |useJackson3|Use Jackson 3 dependencies (tools.jackson package). Only available with `useSpringBoot4`. Defaults to true when `useSpringBoot4` is enabled.| |false|
@@ -91,7 +92,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
 |x-kotlin-implements|Ability to specify interfaces that model must implement|MODEL|empty array
 |x-kotlin-implements-fields|Specify attributes that are implemented by the interface(s) added via `x-kotlin-implements`|MODEL|empty array
-|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
+|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object. Only applies when `library=spring-boot`; ignored for client libraries (spring-cloud, spring-declarative-http-interface).|OPERATION|false
 
 
 ## IMPORT MAPPING

docs/generators/spring.md

@@ -105,6 +105,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useBeanValidation|Use BeanValidation API annotations| |true|
 |useDeductionForOneOfInterfaces|Annotate discriminator-free oneOf interfaces with Jackson's @JsonTypeInfo(use = Id.DEDUCTION) and @JsonSubTypes so the concrete subtype is resolved from the JSON field set rather than a type-tag property. Has no effect when a discriminator is present (name-based resolution is used instead). Requires subtypes to have structurally distinct sets of properties.| |false|
 |useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
+|useEnumValueInterface|Generate a ValuedEnum<T> interface in the config package and make all generated enums implement it, providing a common typed way to access the underlying enum value. Use `importMappings.ValuedEnum` to substitute a custom/library-provided interface instead of generating one.| |false|
 |useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
 |useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
 |useHttpServiceProxyFactoryInterfacesConfigurator|Generate HttpInterfacesAbstractConfigurator based on an HttpServiceProxyFactory instance (as opposed to a WebClient instance, when disabled) for generating Spring HTTP interfaces.| |false|
@@ -138,7 +139,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |x-class-extra-annotation|List of custom annotations to be added to model|MODEL|null
 |x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
 |x-operation-extra-annotation|List of custom annotations to be added to operation|OPERATION|null
-|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
+|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object. Only applies when `library=spring-boot`; ignored for client libraries (spring-cloud, spring-declarative-http-interface).|OPERATION|false
 |x-version-param|Marker property that tells that this parameter would be used for endpoint versioning. Applicable for headers & query params. true/false|OPERATION_PARAMETER|null
 |x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
 |x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null

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

@@ -490,6 +490,13 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,
     public static final String X_MODEL_IS_MUTABLE = "x-model-is-mutable";
     public static final String X_IMPLEMENTS = "x-implements";
     public static final String X_IS_ONE_OF_INTERFACE = "x-is-one-of-interface";
+    public static final String USE_ENUM_VALUE_INTERFACE = "useEnumValueInterface";
+    public static final String USE_ENUM_VALUE_INTERFACE_DESC =
+            "Generate a ValuedEnum<T> interface in the config package and make all generated enums " +
+                    "implement it, providing a common typed way to access the underlying enum value. " +
+                    "Use `importMappings.ValuedEnum` to substitute a custom/library-provided interface " +
+                    "instead of generating one.";
+
     public static final String USE_DEDUCTION_FOR_ONE_OF_INTERFACES = "useDeductionForOneOfInterfaces";
     public static final String USE_DEDUCTION_FOR_ONE_OF_INTERFACES_DESC =
             "Annotate discriminator-free oneOf interfaces with Jackson's " +