[JAVA-SPRING;KOTLIN-SPRING] bugfix - PagedModel<T> - default to custom DTO; allow override via import mapping and schema mapping; feature - allow for declarative http interfaces by Picazsoo · Pull Request #23601 · OpenAPITools/openapi-generator

Picazsoo · 2026-04-21T15:19:35Z

Fixes everything that this pr does #23599. And in addittion enables usage of PagedModel as return type in spring declarative interfaces. The change is limited to a couple of modified conditionals and some tests. As always it is opt-in (which seem to be a pretty good idea seeing how I always manage to sneak in at least some bugs - this way the bugs are tightly limited to the new functionality and do not cause regressions)

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
```
(For Windows users, please run the script in WSL)
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.
File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Defaulted paginated responses to a generated PagedModel<T> DTO and made it respect schema/import mappings (including the item type); also enabled this for declarative HTTP interfaces in Java and Kotlin Spring. This reduces Spring Data coupling and makes substituteGenericPagedModel work across Spring libraries.

New Features
- Enabled substituteGenericPagedModel for spring-http-interface (Java) and spring-declarative-http-interface (Kotlin).
- Generate configPackage.PagedModel by default (e.g., org.openapitools.configuration.PagedModel); override via importMappings.PagedModel.
- Honors schemaMappings for the item type and uses the simple name of a custom PagedModel FQCN in signatures/imports.
Migration
- To keep your own class, set importMappings.PagedModel=<your FQCN> (e.g., org.springframework.data.web.PagedModel) to prevent generating the file.
- Otherwise, APIs now return configPackage.PagedModel<T> and the generator adds that file to your project.

^{Written for commit ecf07b0. Summary will update on new commits.}

…generation fix(spring): enhance PagedModel handling with import mapping and schema mapping support

…can be replaced with custom one via importMapping)

add support for spring declarative interface

…chema-mapping

…' into bugfix/pagedModel-for-declarative-http-interface

…' into bugfix/pagedModel-for-declarative-http-interface # Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

Picazsoo · 2026-04-21T15:21:41Z

+        if (SPRING_BOOT.equals(library) || SPRING_HTTP_INTERFACE.equals(library)) {
+            convertPropertyToBooleanAndWriteBack(SUBSTITUTE_GENERIC_PAGED_MODEL, this::setSubstituteGenericPagedModel);
+        }
+


change relevant to enabling the functionality in spring declarative http interfaces

Picazsoo · 2026-04-21T15:21:57Z

        }
        writePropertyBack(GENERATE_PAGEABLE_CONSTRAINT_VALIDATION, generatePageableConstraintValidation);
-        if (additionalProperties.containsKey(SUBSTITUTE_GENERIC_PAGED_MODEL) && library.equals(SPRING_BOOT)) {
+        if (additionalProperties.containsKey(SUBSTITUTE_GENERIC_PAGED_MODEL) && (library.equals(SPRING_BOOT) || library.equals(SPRING_DECLARATIVE_HTTP_INTERFACE_LIBRARY))) {


change relevant to enabling the functionality in spring declarative http interfaces

Picazsoo · 2026-04-21T15:22:04Z

        }

-        if (SPRING_BOOT.equals(library) && substituteGenericPagedModel) {
+        if ((SPRING_BOOT.equals(library) || SPRING_DECLARATIVE_HTTP_INTERFACE_LIBRARY.equals(library)) && substituteGenericPagedModel) {


change relevant to enabling the functionality in spring declarative http interfaces

Picazsoo · 2026-04-21T15:22:16Z

        }

-        if (SPRING_BOOT.equals(library) && substituteGenericPagedModel) {
+        if ((SPRING_BOOT.equals(library) || SPRING_HTTP_INTERFACE.equals(library)) && substituteGenericPagedModel) {


change relevant to enabling the functionality in spring declarative http interfaces

cubic-dev-ai

1 issue found across 19 files

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java:1224">
P2: Unchecked insertion into global `importMapping` can collide with existing type/model keys and remap unrelated generated types.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

…' into bugfix/pagedModel-for-declarative-http-interface

wing328 · 2026-04-22T10:13:49Z

cc kotlin tc: @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) @dennisameling (2026/02)

java spring tc: @cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

Picazsoo and others added 11 commits April 21, 2026 15:14

fix(spring): ensure PagedModel uses mapped FQN for item type in code …

f7c827a

…generation fix(spring): enhance PagedModel handling with import mapping and schema mapping support

fix(spring): generate supporting PagedModel files in config package (…

42bd4e1

…can be replaced with custom one via importMapping)

update samples

5780ef7

improve test

2764446

add support for spring declarative interface

Merge branch 'master' into bugfix/pagedModel-use-import-mapping-and-s…

2267cbb

…chema-mapping

update documentation

c837967

Merge branch 'bugfix/pagedModel-use-import-mapping-and-schema-mapping…

5222df2

…' into bugfix/pagedModel-for-declarative-http-interface

update documentation

d3900d3

update documentation

7de158b

update documentation

a1fc411

Picazsoo marked this pull request as ready for review April 21, 2026 15:19

Picazsoo commented Apr 21, 2026

View reviewed changes

cubic-dev-ai Bot reviewed Apr 21, 2026

View reviewed changes

Comment thread ...pi-generator/src/main/java/org/openapitools/codegen/languages/KotlinSpringServerCodegen.java Outdated

Picazsoo mentioned this pull request Apr 21, 2026

[JAVA-SPRING;KOTLIN-SPRING] bugfix - PagedModel<T> - default to custom DTO; allow override via import mapping and schema mapping #23599

Closed

6 tasks

Picazsoo added 2 commits April 21, 2026 17:34

implement feedback from CR

93bc67a

Merge branch 'bugfix/pagedModel-use-import-mapping-and-schema-mapping…

ecf07b0

…' into bugfix/pagedModel-for-declarative-http-interface

wing328 added Issue: Bug Server: Java Server: Kotlin Server: Spring labels Apr 22, 2026

wing328 added this to the 7.22.0 milestone Apr 22, 2026

wing328 merged commit b063a67 into OpenAPITools:master Apr 22, 2026
116 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[JAVA-SPRING;KOTLIN-SPRING] bugfix - PagedModel<T> - default to custom DTO; allow override via import mapping and schema mapping; feature - allow for declarative http interfaces#23601

[JAVA-SPRING;KOTLIN-SPRING] bugfix - PagedModel<T> - default to custom DTO; allow override via import mapping and schema mapping; feature - allow for declarative http interfaces#23601
wing328 merged 13 commits intoOpenAPITools:masterfrom
Picazsoo:bugfix/pagedModel-for-declarative-http-interface

Picazsoo commented Apr 21, 2026 •

edited by cubic-dev-ai Bot

Loading

Uh oh!

Picazsoo Apr 21, 2026

Uh oh!

Picazsoo Apr 21, 2026

Uh oh!

Picazsoo Apr 21, 2026

Uh oh!

Picazsoo Apr 21, 2026

Uh oh!

cubic-dev-ai Bot left a comment

Uh oh!

Uh oh!

wing328 commented Apr 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Picazsoo commented Apr 21, 2026 • edited by cubic-dev-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Summary by cubic

Uh oh!

Picazsoo Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Picazsoo Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Picazsoo Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Picazsoo Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wing328 commented Apr 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Picazsoo commented Apr 21, 2026 •

edited by cubic-dev-ai Bot

Loading