Skip to content

fix(spring): Add Nullable import for array-type models (#22788) #22844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 11 commits into from
Feb 4, 2026
+61 −10
Merged

fix(spring): Add Nullable import for array-type models (#22788) #22844

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6a5d888
fix(spring): Add Nullable import for array-type models (#22788)
spider-yamet Jan 28, 2026
9e47b88
Merge branch 'master' into fix/nullable-import-array-models
spider-yamet Jan 29, 2026
1815a8e
refactor(spring): Extract helper methods for Nullable import logic (DRY)
spider-yamet Jan 29, 2026
2c985ad
chore: Regenerate Spring samples after Nullable import fix
spider-yamet Jan 30, 2026
feb87f5
Update sample files after regeneration
spider-yamet Feb 1, 2026
554fc76
Fix phpunit.xml.dist: replace literal backslashes with forward slashe…
spider-yamet Feb 1, 2026
59c9b0c
Add JavaDoc comment for addSpringNullableImportForOperation method
spider-yamet Feb 2, 2026
40b0922
Fix line endings: replace CRLF (\r\n) with LF (\n) in exampleJson str…
spider-yamet Feb 2, 2026
e07e395
Remove unused Nullable imports from PR-related Spring sample files
spider-yamet Feb 2, 2026
bdc2ed5
Revert date/time example value changes (regeneration artifacts)
spider-yamet Feb 2, 2026
328be02
Fix: Skip Nullable import for enum models
spider-yamet Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...les/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,11 +968,6 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
if (model.getVendorExtensions().containsKey("x-jackson-optional-nullable-helpers")) {
model.imports.add("Arrays");
}

// to prevent inheritors (JavaCamelServerCodegen etc.) mistakenly use it
if (getName().contains("spring")) {
model.imports.add("Nullable");
}
Copy link
Copy Markdown
Member

@wing328 wing328 Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @slobodator who made these changes.

Copy link
Copy Markdown
Contributor Author

@spider-yamet spider-yamet Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wing328 Let me share my opinion
Why the code was moved (not removed)
The problem (Issue #22788):
Array-type models like ResultCodes (type: array) were missing the Nullable import
The code was in postProcessModelProperty, which is called per property
Array-type models may have no properties or not trigger postProcessModelProperty the same way
Result: array-type models didn't get the Nullable import → compilation error
The solution:
Move the code from postProcessModelProperty to fromModel
fromModel is called once per model, regardless of properties
This ensures all models (including array-type) get the Nullable import
Why not keep it in both places?
It would add the import twice for regular models
fromModel is the right place because it handles all models uniformly
Current state:
The code is in fromModel (line 987-990)
It includes the enum check to skip enum models
Array-type models now get the import correctly
The code wasn't removed; it was moved to fix the array-type model bug.

Copy link
Copy Markdown
Member

@wing328 wing328 Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for sharing more

}

@Override
Expand All @@ -989,6 +984,11 @@ public CodegenModel fromModel(String name, Schema model) {
codegenModel.imports.remove("Schema");
}

// Add Nullable import for all models including array-type models (issue #22788)
if (getName().contains("spring")) {
codegenModel.imports.add("Nullable");
}

return codegenModel;
}

Expand Down
33 changes: 33 additions & 0 deletions ...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6223,4 +6223,37 @@ public void testExtensionsOnSchema_issue9183() throws IOException {
));
}

@Test
public void shouldAddNullableImportForArrayTypeModels() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();

final OpenAPI openAPI = TestUtils.parseFlattenSpec(
"src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing-with-spring-pageable.yaml");
final SpringCodegen codegen = new SpringCodegen();
codegen.setOpenAPI(openAPI);
codegen.setOutputDir(output.getAbsolutePath());
codegen.additionalProperties().put(INTERFACE_ONLY, "true");
codegen.additionalProperties().put(CodegenConstants.GENERATE_ALIAS_AS_MODEL, "true");

ClientOptInput input = new ClientOptInput();
input.openAPI(openAPI);
input.config(codegen);

DefaultGenerator generator = new DefaultGenerator();
generator.setGenerateMetadata(false);
generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "true");
generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_TESTS, "false");
generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_DOCS, "false");

Map<String, File> files = generator.opts(input).generate().stream()
.collect(Collectors.toMap(File::getName, Function.identity()));

// AnimalFarm is an array-type model with no properties (issue #22788)
JavaFileAssert.assertThat(files.get("AnimalFarm.java"))
.hasImports("org.springframework.lang.Nullable");
JavaFileAssert.assertThat(files.get("Pet.java"))
.hasImports("org.springframework.lang.Nullable");
}

}
Loading