Merge branch 'bugfix/pagedModel-use-import-mapping-and-schema-mapping' into bugfix/pagedModel-for-declarative-http-interface

Picazsoo · Picazsoo · commit 5222df217b8b · 2026-04-21T16:53:26.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -309,3 +309,6 @@ samples/client/petstore/ocaml-recursion-test/_build/
 
 # jetbrain http client
 samples/client/jetbrains/adyen/checkout71/http/client/Apis/http-client.private.env.json
+
+# Generated by the run-in-docker.sh
+\?/
diff --git a/docs/customization.md b/docs/customization.md
@@ -530,7 +530,7 @@ Another useful option is `inlineSchemaOptions`, which allows you to customize ho
 - `MAP_ITEM_SUFFIX` set the map item suffix
 - `SKIP_SCHEMA_REUSE=true` is a special value to skip reusing inline schemas during refactoring
 - `REFACTOR_ALLOF_INLINE_SCHEMAS=true` will restore the 6.x (or below) behaviour to refactor allOf inline schemas into $ref. (v7.0.0 will skip the refactoring of these allOf inline schemas by default)
-- `RESOLVE_INLINE_ENUMS=true` will refactor inline enum definitions into $ref. This must be activated to allow the renaming of inline enum definitions using `inlineSchemaMappings`.
+- `RESOLVE_INLINE_ENUMS=true` will refactor inline enum definitions into $ref. This must be activated to allow the renaming of inline enum definitions using `inlineSchemaNameMappings`.
 
 ## OpenAPI Normalizer
 
diff --git a/docs/generators/java-camel.md b/docs/generators/java-camel.md
@@ -104,7 +104,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |sourceFolder|source folder for generated code| |src/main/java|
 |springApiVersion|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).| |null|
-|substituteGenericPagedModel|Detect schemas that represent paginated responses (an object with a 'content' array property and a pagination-metadata property) and replace their generated references with org.springframework.data.web.PagedModel&lt;T&gt;. The detected page schemas and the pagination metadata schema are suppressed from code generation. Only applies when library=spring-boot.| |false|
+|substituteGenericPagedModel|Detect schemas that represent paginated responses (an object with a 'content' array property and a 'page' pagination-metadata property) and replace their generated references with PagedModel&lt;T&gt; generated into config package (default 'org.openapitools.configuration'). The detected page schemas and the pagination metadata schema are suppressed from code generation. Only applies when library=spring-boot.| |false|
 |testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
 |title|server title name or client service name| |OpenAPI Spring|
 |unhandledException|Declare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring `@ControllerAdvice` directives).| |false|
diff --git a/docs/generators/kotlin-spring.md b/docs/generators/kotlin-spring.md
@@ -58,7 +58,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
 |sourceFolder|source folder for generated code| |src/main/kotlin|
-|substituteGenericPagedModel|Detect schemas that represent paginated responses (an object with a 'content' array property and a pagination-metadata property) and replace their generated references with org.springframework.data.web.PagedModel&lt;T&gt;. The detected page schemas and the pagination metadata schema are suppressed from code generation. Only applies when library=spring-boot.| |false|
+|substituteGenericPagedModel|Detect schemas that represent paginated responses (an object with a 'content' array property and a 'page' pagination-metadata property) and replace their generated references with PagedModel&lt;T&gt; generated into config package (default 'org.openapitools.configuration'). The detected page schemas and the pagination metadata schema are suppressed from code generation. Only applies when library=spring-boot.| |false|
 |title|server title name or client service name| |OpenAPI Kotlin Spring|
 |useBeanValidation|Use BeanValidation API annotations to validate data types| |true|
 |useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
diff --git a/docs/generators/spring.md b/docs/generators/spring.md
@@ -97,7 +97,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |sourceFolder|source folder for generated code| |src/main/java|
 |springApiVersion|Value for 'version' attribute in @RequestMapping (for Spring 7 and above).| |null|
-|substituteGenericPagedModel|Detect schemas that represent paginated responses (an object with a 'content' array property and a pagination-metadata property) and replace their generated references with org.springframework.data.web.PagedModel&lt;T&gt;. The detected page schemas and the pagination metadata schema are suppressed from code generation. Only applies when library=spring-boot.| |false|
+|substituteGenericPagedModel|Detect schemas that represent paginated responses (an object with a 'content' array property and a 'page' pagination-metadata property) and replace their generated references with PagedModel&lt;T&gt; generated into config package (default 'org.openapitools.configuration'). The detected page schemas and the pagination metadata schema are suppressed from code generation. Only applies when library=spring-boot.| |false|
 |testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
 |title|server title name or client service name| |OpenAPI Spring|
 |unhandledException|Declare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring `@ControllerAdvice` directives).| |false|
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/TemplateManager.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/TemplateManager.java
@@ -12,6 +12,8 @@
 import org.slf4j.LoggerFactory;
 
 import java.io.*;
+import java.net.URL;
+import java.net.URLConnection;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -146,22 +148,28 @@ public Reader getTemplateReader(String name) {
         try {
             InputStream is = getInputStream(name);
             return new InputStreamReader(is, StandardCharsets.UTF_8);
-        } catch (FileNotFoundException e) {
+        } catch (IOException e) {
             LOGGER.error(e.getMessage());
             throw new RuntimeException("can't load template " + name);
         }
     }
 
-    private InputStream getInputStream(String name) throws FileNotFoundException {
-        InputStream is;
-        is = this.getClass().getClassLoader().getResourceAsStream(getCPResourcePath(name));
-        if (is == null) {
-            if (name == null || name.contains("..")) {
-                throw new IllegalArgumentException("Template location must be constrained to template directory.");
-            }
-            is = new FileInputStream(name); // May throw but never return a null value
+    private InputStream getInputStream(String name) throws IOException {
+        if (name == null || name.contains("..")) {
+            throw new IllegalArgumentException("Template location must be constrained to template directory.");
+        }
+        String cpResourcePath = getCPResourcePath(name);
+        URL resource = this.getClass().getClassLoader().getResource(cpResourcePath);
+        if (resource != null) {
+            // Open a fresh, non-cached connection each time.
+            // setUseCaches(false) prevents sharing the underlying JarFile across classloaders,
+            // which avoids "Stream closed" errors when concurrent Gradle workers use isolated
+            // classloaders that happen to point to the same JAR URL.
+            URLConnection conn = resource.openConnection();
+            conn.setUseCaches(false);
+            return conn.getInputStream();
         }
-        return is;
+        return new FileInputStream(name); // May throw but never return a null value
     }
 
     /**
@@ -180,15 +188,22 @@ public File write(Map<String, Object> data, String template, File target) throws
             return writeToFile(target.getPath(), templateContent);
         } else {
             // Do a straight copy of the file if not listed as supported by the template engine.
-            InputStream is;
+            String fullTemplatePath = null;
             try {
                 // look up the file using the same template resolution logic the adapters would use.
-                String fullTemplatePath = getFullTemplateFile(template);
-                is = getInputStream(fullTemplatePath);
+                fullTemplatePath = getFullTemplateFile(template);
             } catch (TemplateNotFoundException ex) {
-                is = new FileInputStream(Paths.get(template).toFile());
+                // not found on classpath; fall through to direct file read below
+            }
+            if (fullTemplatePath != null) {
+                try (InputStream is = getInputStream(fullTemplatePath)) {
+                    return writeToFile(target.getAbsolutePath(), IOUtils.toByteArray(is));
+                }
+            } else {
+                try (InputStream is = new FileInputStream(Paths.get(template).toFile())) {
+                    return writeToFile(target.getAbsolutePath(), IOUtils.toByteArray(is));
+                }
             }
-            return writeToFile(target.getAbsolutePath(), IOUtils.toByteArray(is));
         }
     }
 
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java
@@ -298,9 +298,9 @@ public KotlinSpringServerCodegen() {
         addSwitch(GENERATE_SORT_VALIDATION, "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.", generateSortValidation);
         addSwitch(GENERATE_PAGEABLE_CONSTRAINT_VALIDATION, "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.", generatePageableConstraintValidation);
         addSwitch(SUBSTITUTE_GENERIC_PAGED_MODEL,
-                "Detect schemas that represent paginated responses (an object with a 'content' array property and a "
+                "Detect schemas that represent paginated responses (an object with a 'content' array property and a 'page' "
                 + "pagination-metadata property) and replace their generated references with "
-                + "org.springframework.data.web.PagedModel<T>. The detected page schemas and the pagination metadata "
+                + "PagedModel<T> generated into config package (default 'org.openapitools.configuration'). The detected page schemas and the pagination metadata "
                 + "schema are suppressed from code generation. Only applies when library=spring-boot.",
                 substituteGenericPagedModel);
         addSwitch(COMPANION_OBJECT, "Whether to generate companion objects in data classes, enabling companion extensions.", companionObject);
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@@ -376,9 +376,9 @@ public SpringCodegen() {
                 + "Requires useBeanValidation=true and library=spring-boot.",
                 generatePageableConstraintValidation));
         cliOptions.add(CliOption.newBoolean(SUBSTITUTE_GENERIC_PAGED_MODEL,
-                "Detect schemas that represent paginated responses (an object with a 'content' array property and a "
+                "Detect schemas that represent paginated responses (an object with a 'content' array property and a 'page' "
                 + "pagination-metadata property) and replace their generated references with "
-                + "org.springframework.data.web.PagedModel<T>. The detected page schemas and the pagination metadata "
+                + "PagedModel<T> generated into config package (default 'org.openapitools.configuration'). The detected page schemas and the pagination metadata "
                 + "schema are suppressed from code generation. Only applies when library=spring-boot.",
                 substituteGenericPagedModel));
 
diff --git a/modules/openapi-generator/src/main/resources/JavaSpring/apiController.mustache b/modules/openapi-generator/src/main/resources/JavaSpring/apiController.mustache
@@ -81,11 +81,10 @@ public class {{classname}}Controller implements {{classname}} {
 {{^isDelegate}}
     {{^reactive}}
 
-    @Nullable
     private final NativeWebRequest request;
 
     @Autowired
-    public {{classname}}Controller(@Nullable NativeWebRequest request) {
+    public {{classname}}Controller(NativeWebRequest request) {
         this.request = request;
     }
 
diff --git a/modules/openapi-generator/src/main/resources/python-pydantic-v1/asyncio/rest.mustache b/modules/openapi-generator/src/main/resources/python-pydantic-v1/asyncio/rest.mustache
@@ -128,6 +128,8 @@ class RESTClientObject:
             if re.search('json', headers['Content-Type'], re.IGNORECASE):
                 if body is not None:
                     body = json.dumps(body)
+                if body is None and post_params:
+                    body = json.dumps(dict(post_params))
                 args["data"] = body
             elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
                 args["data"] = aiohttp.FormData(post_params)
diff --git a/modules/openapi-generator/src/main/resources/python-pydantic-v1/rest.mustache b/modules/openapi-generator/src/main/resources/python-pydantic-v1/rest.mustache
@@ -172,6 +172,8 @@ class RESTClientObject:
                     request_body = None
                     if body is not None:
                         request_body = json.dumps(body)
+                    if body is None and post_params:
+                        request_body = json.dumps(dict(post_params))
                     r = self.pool_manager.request(
                         method, url,
                         body=request_body,
diff --git a/modules/openapi-generator/src/main/resources/python-pydantic-v1/tornado/rest.mustache b/modules/openapi-generator/src/main/resources/python-pydantic-v1/tornado/rest.mustache
@@ -112,6 +112,8 @@ class RESTClientObject:
             if re.search('json', headers['Content-Type'], re.IGNORECASE):
                 if body:
                     body = json.dumps(body)
+                if body is None and post_params:
+                    body = json.dumps(dict(post_params))
                 request.body = body
             elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
                 request.body = urlencode(post_params)
diff --git a/modules/openapi-generator/src/main/resources/python/asyncio/rest.mustache b/modules/openapi-generator/src/main/resources/python/asyncio/rest.mustache
@@ -156,6 +156,8 @@ class RESTClientObject:
             if re.search('json', headers['Content-Type'], re.IGNORECASE):
                 if body is not None:
                     body = json.dumps(body)
+                if body is None and post_params:
+                    body = json.dumps(dict(post_params))
                 args["data"] = body
             elif headers['Content-Type'] == 'application/x-www-form-urlencoded':
                 args["data"] = aiohttp.FormData(post_params)
diff --git a/modules/openapi-generator/src/main/resources/python/httpx/rest.mustache b/modules/openapi-generator/src/main/resources/python/httpx/rest.mustache
@@ -128,6 +128,8 @@ class RESTClientObject:
             if re.search('json', headers['Content-Type'], re.IGNORECASE):
                 if body is not None:
                     args["json"] = body
+                if body is None and post_params:
+                    args["json"] = dict(post_params)
             elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
                 args["data"] = dict(post_params)
             elif headers['Content-Type'] == 'multipart/form-data':
diff --git a/modules/openapi-generator/src/main/resources/python/tornado/rest.mustache b/modules/openapi-generator/src/main/resources/python/tornado/rest.mustache
@@ -122,6 +122,8 @@ class RESTClientObject:
             if re.search('json', headers['Content-Type'], re.IGNORECASE):
                 if body:
                     body = json.dumps(body)
+                if body is None and post_params:
+                    body = json.dumps(dict(post_params))
                 request.body = body
             elif headers['Content-Type'] == 'application/x-www-form-urlencoded':
                 request.body = urlencode(post_params)
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/assertions/JavaFileAssert.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/assertions/JavaFileAssert.java
@@ -195,7 +195,7 @@ public JavaFileAssert fileContains(final String... lines) {
                 .toString();
         Assertions.assertThat(actualBody)
                 .withFailMessage(
-                        "File should contains lines\n====\n%s\n====\nbut actually was\n====\n%s\n====",
+                        "File should contain lines\n====\n%s\n====\nbut actually was\n====\n%s\n====",
                         Arrays.stream(lines).collect(Collectors.joining(System.lineSeparator())), actualBody
                 )
                 .contains(lines);
@@ -209,7 +209,7 @@ public JavaFileAssert fileDoesNotContain(final String... lines) {
                 .toString();
         Assertions.assertThat(actualBody)
                 .withFailMessage(
-                        "File should not contains lines\n====\n%s\n====\nbut actually was\n====\n%s\n====",
+                        "File should not contain lines\n====\n%s\n====\nbut actually was\n====\n%s\n====",
                         Arrays.stream(lines).collect(Collectors.joining(System.lineSeparator())), actualBody
                 )
                 .doesNotContain(lines);
@@ -227,11 +227,25 @@ public JavaFileAssert fileContainsPattern(final String pattern) {
                 .toString();
         Assertions.assertThat(actualBody)
                 .withFailMessage(
-                        "File should contains pattern\n====\n%s\n====\nbut actually was\n====\n%s\n====",
+                        "File should contain pattern\n====\n%s\n====\nbut actually was\n====\n%s\n====",
                         pattern, actualBody
                 )
                 .containsPattern(pattern);
 
         return this;
     }
+
+    public JavaFileAssert fileDoesNotContainPattern(final String pattern) {
+        final String actualBody = actual.getTokenRange()
+                .orElseThrow(() -> new IllegalStateException("Empty file"))
+                .toString();
+        Assertions.assertThat(actualBody)
+                .withFailMessage(
+                        "File should not contain pattern\n====\n%s\n====\nbut actually was\n====\n%s\n====",
+                        pattern, actualBody
+                )
+                .doesNotContainPattern(pattern);
+
+        return this;
+    }
 }
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/assertions/TypeAnnotationsAssert.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/assertions/TypeAnnotationsAssert.java
@@ -4,6 +4,7 @@
 import org.assertj.core.util.CanIgnoreReturnValue;
 
 import java.util.List;
+import java.util.regex.Pattern;
 
 @CanIgnoreReturnValue
 public class TypeAnnotationsAssert extends AbstractAnnotationsAssert<TypeAnnotationsAssert> {
@@ -18,4 +19,30 @@ protected TypeAnnotationsAssert(final JavaFileAssert fileAssert, final List<Anno
     public JavaFileAssert toType() {
         return fileAssert;
     }
+
+    /**
+     * assert that the annotation is not specifed in an import.
+     *
+     * @param name classname of the annotation. For example "Nullable" or a full qualified class name like "java.util.List"
+     */
+    public TypeAnnotationsAssert doesNotImportAnnotation(final String name) {
+        String pattern = "import\\s+" +
+                (name.contains(".")?"" : "[\\w.]+\\.") +
+                Pattern.quote(name) + ";";
+        this.toType().fileDoesNotContainPattern(pattern);
+        return this;
+    }
+
+    /**
+     * assert that the annotation is imported.
+     *
+     * @param name clasname of the annotation.  For example "Nullable" or a full qualified class name like "java.util.List"
+     */
+    public TypeAnnotationsAssert doesImportAnnotation(final String name) {
+        String pattern = "import\\s+" +
+                (name.contains(".")?"" : "[\\w.]+\\.") +
+                Pattern.quote(name) + ";";
+        this.toType().fileContainsPattern(pattern);
+        return this;
+    }
 }
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
diff --git a/samples/client/echo_api/python-pydantic-v1/openapi_client/rest.py b/samples/client/echo_api/python-pydantic-v1/openapi_client/rest.py
diff --git a/samples/openapi3/client/petstore/python-aiohttp/petstore_api/rest.py b/samples/openapi3/client/petstore/python-aiohttp/petstore_api/rest.py
diff --git a/samples/openapi3/client/petstore/python-httpx/petstore_api/rest.py b/samples/openapi3/client/petstore/python-httpx/petstore_api/rest.py
diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/rest.py b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/rest.py
diff --git a/samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/rest.py b/samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/rest.py
