Skip to content

Restricted Java oneOf imports to Jackson only when needed (#21404) #21405

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Restricted Java oneOf imports to Jackson only when needed (#21404) #21405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
602713b
Fixed issue #21404 - Restricted Java oneOf imports to Jackson when ne…
DavidGrath Jun 10, 2025
5e6dafb
Fix TODOs
DavidGrath Jun 10, 2025
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
12 changes: 7 additions & 5 deletions ...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1230,11 +1230,13 @@ public String toApiVarName(String name) {

@Override
public void addImportsToOneOfInterface(List<Map<String, String>> imports) {
for (String i : Arrays.asList("JsonSubTypes", "JsonTypeInfo", "JsonIgnoreProperties")) {
Map<String, String> oneImport = new HashMap<>();
oneImport.put("import", importMapping.get(i));
if (!imports.contains(oneImport)) {
imports.add(oneImport);
if(additionalProperties.containsKey(SERIALIZATION_LIBRARY_JACKSON)) {
for (String i : Arrays.asList("JsonSubTypes", "JsonTypeInfo", "JsonIgnoreProperties")) {
Map<String, String> oneImport = new HashMap<>();
oneImport.put("import", importMapping.get(i));
if (!imports.contains(oneImport)) {
imports.add(oneImport);
}
}
}
}
Expand Down
12 changes: 7 additions & 5 deletions ...-generator/src/main/java/org/openapitools/codegen/languages/JavaHelidonClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,11 +479,13 @@ public String toApiVarName(String name) {

@Override
public void addImportsToOneOfInterface(List<Map<String, String>> imports) {
for (String i : Arrays.asList("JsonSubTypes", "JsonTypeInfo", "JsonIgnoreProperties")) {
Map<String, String> oneImport = new HashMap<>();
oneImport.put("import", importMapping.get(i));
if (!imports.contains(oneImport)) {
imports.add(oneImport);
if(additionalProperties.containsKey(SERIALIZATION_LIBRARY_JACKSON)) {
for (String i : Arrays.asList("JsonSubTypes", "JsonTypeInfo", "JsonIgnoreProperties")) {
Map<String, String> oneImport = new HashMap<>();
oneImport.put("import", importMapping.get(i));
if (!imports.contains(oneImport)) {
imports.add(oneImport);
}
}
}
}
Expand Down
25 changes: 25 additions & 0 deletions .../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3699,4 +3699,29 @@ public void testNativeClientWithUseSingleRequestParameter() {
TestUtils.assertFileNotContains(output.resolve("src/main/java/xyz/abcdef/api/PetApi.java"),
"public record DeletePetRequest(Long petId, String apiKey){}");
}

@Test(dataProvider = "librariesNotSupportingJackson")
public void givenOneOfUsesInterfacesAndLibraryNotJacksonWhenGenerateThenOneOfInterfaceDoesNotHaveJacksonImports(Library library) throws Exception {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();

Map<String, Object> properties = new HashMap<>();
properties.put(USE_ONE_OF_INTERFACES, true);

Generator generator = new DefaultGenerator();
CodegenConfigurator configurator = new CodegenConfigurator()
.setInputSpec("src/test/resources/3_0/oneOf.yaml")
.setGeneratorName("java")
.setLibrary(library.value)
.setAdditionalProperties(properties)
.setOutputDir(output.getAbsolutePath());
ClientOptInput clientOptInput = configurator.toClientOptInput();
generator.opts(clientOptInput)
.generate();
String outputPath = output.getAbsolutePath() + "/src/main/java/org/openapitools";
File testModel = new File(outputPath, "/client/model/Fruit.java");
String fileContent = Files.readString(testModel.toPath());
TestUtils.assertValidJavaSourceCode(fileContent);
TestUtils.assertFileNotContains(testModel.toPath(), "com.fasterxml.jackson");
}
}
Loading