fix: conditionally add jackson JsonIgnoreProperties for base class polymorphism

dnowo · dnowo · commit 4e06221dd915 · 2025-12-10T22:49:15.000+01:00
diff --git a/docs/generators/groovy.md b/docs/generators/groovy.md
@@ -69,6 +69,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
+
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-camel.md b/docs/generators/java-camel.md
@@ -116,6 +116,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useTags|use tags for creating interface and controller classnames| |false|
 |virtualService|Generates the virtual service. For more details refer - https://github.com/virtualansoftware/virtualan/wiki| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-dubbo.md b/docs/generators/java-dubbo.md
@@ -82,6 +82,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |useTags|use tags for creating interface and controller classnames| |true|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-helidon-client.md b/docs/generators/java-helidon-client.md
@@ -68,6 +68,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 |x-helidon-groupBy|Selects how to group operations into APIs|<dl><dt>**tags**</dt><dd>Use the 'tags' settings on each operation</dd><dt>**first-path-segment**</dt><dd>Use the first segment of the path</dd></dl>|tags|
 |x-helidon-useOptional|Wrap optional parameters in an Optional (Helidon 4 and later)| |true|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-helidon-server.md b/docs/generators/java-helidon-server.md
@@ -71,6 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 |x-helidon-groupBy|Selects how to group operations into APIs|<dl><dt>**tags**</dt><dd>Use the 'tags' settings on each operation</dd><dt>**first-path-segment**</dt><dd>Use the first segment of the path</dd></dl>|tags|
 |x-helidon-useOptional|Wrap optional parameters in an Optional (Helidon 4 and later)| |true|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-inflector.md b/docs/generators/java-inflector.md
@@ -71,6 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-micronaut-client.md b/docs/generators/java-micronaut-client.md
@@ -92,6 +92,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |visitable|Generate visitor for subtypes with a discriminator| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 |wrapInHttpResponse|Wrap the response in HttpResponse object| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-micronaut-server.md b/docs/generators/java-micronaut-server.md
@@ -91,6 +91,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |visitable|Generate visitor for subtypes with a discriminator| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 |wrapInHttpResponse|Wrap the response in HttpResponse object| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-microprofile.md b/docs/generators/java-microprofile.md
@@ -109,6 +109,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |webclientBlockingOperations|Making all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be sync| |false|
 |withAWSV4Signature|whether to include AWS v4 signature support (only available for okhttp-gson library)| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-msf4j.md b/docs/generators/java-msf4j.md
@@ -77,6 +77,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |useTags|use tags for creating interface and controller classnames| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-pkmst.md b/docs/generators/java-pkmst.md
@@ -78,6 +78,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 |zipkinUri|Zipkin URI| |null|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-play-framework.md b/docs/generators/java-play-framework.md
@@ -81,6 +81,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useSwaggerUI|Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies| |true|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 |wrapCalls|Add a wrapper to each controller function to handle things like metrics, response modification, etc..| |true|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-undertow-server.md b/docs/generators/java-undertow-server.md
@@ -71,6 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-vertx-web.md b/docs/generators/java-vertx-web.md
@@ -71,6 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-vertx.md b/docs/generators/java-vertx.md
@@ -74,6 +74,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |vertxSwaggerRouterVersion|Specify the version of the swagger router library| |null|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java-wiremock.md b/docs/generators/java-wiremock.md
@@ -71,6 +71,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/docs/generators/java.md b/docs/generators/java.md
@@ -109,6 +109,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |webclientBlockingOperations|Making all WebClient operations blocking(sync). Note that if on operation 'x-webclient-blocking: false' then such operation won't be sync| |false|
 |withAWSV4Signature|whether to include AWS v4 signature support (only available for okhttp-gson library)| |false|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
+|discriminatorFieldIgnore| whether to add jackson @JsonIgnoreProperties for discriminator in base class                                                                                                                                                                                                                                                                       | |false|
 
 ## SUPPORTED VENDOR EXTENSIONS
 
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java
@@ -102,6 +102,7 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
     public static final String JAVAX_PACKAGE = "javaxPackage";
     public static final String USE_JAKARTA_EE = "useJakartaEe";
     public static final String CONTAINER_DEFAULT_TO_NULL = "containerDefaultToNull";
+    public static final String DISCRIMINATOR_FIELD_IGNORE = "discriminatorFieldIgnore";
 
     public static final String CAMEL_CASE_DOLLAR_SIGN = "camelCaseDollarSign";
     public static final String USE_ONE_OF_INTERFACES = "useOneOfInterfaces";
@@ -198,6 +199,8 @@ protected enum ENUM_PROPERTY_NAMING_TYPE {MACRO_CASE, legacy, original}
     protected boolean jackson = false;
     @Getter @Setter
     protected boolean generateBuilders;
+    @Getter @Setter
+    protected boolean discriminatorFieldIgnore = false;
     /**
      * useBeanValidation has been moved from child generators to AbstractJavaCodegen.
      * The reason is that getBeanValidation needs it
@@ -345,6 +348,7 @@ public AbstractJavaCodegen() {
         cliOptions.add(CliOption.newBoolean(CONTAINER_DEFAULT_TO_NULL, "Set containers (array, set, map) default to null"));
         cliOptions.add(CliOption.newBoolean(GENERATE_CONSTRUCTOR_WITH_ALL_ARGS, "whether to generate a constructor for all arguments").defaultValue(Boolean.FALSE.toString()));
         cliOptions.add(CliOption.newBoolean(GENERATE_BUILDERS, "Whether to generate builders for models").defaultValue(Boolean.FALSE.toString()));
+        cliOptions.add(CliOption.newBoolean(DISCRIMINATOR_FIELD_IGNORE, "Ignore discriminator field allOf, oneOf for Jackson serialization", discriminatorFieldIgnore));
 
         cliOptions.add(CliOption.newString(CodegenConstants.PARENT_GROUP_ID, CodegenConstants.PARENT_GROUP_ID_DESC));
         cliOptions.add(CliOption.newString(CodegenConstants.PARENT_ARTIFACT_ID, CodegenConstants.PARENT_ARTIFACT_ID_DESC));
@@ -424,6 +428,7 @@ public void processOpts() {
 
         convertPropertyToBooleanAndWriteBack(GENERATE_CONSTRUCTOR_WITH_ALL_ARGS, this::setGenerateConstructorWithAllArgs);
         convertPropertyToBooleanAndWriteBack(GENERATE_BUILDERS, this::setGenerateBuilders);
+        convertPropertyToBooleanAndWriteBack(DISCRIMINATOR_FIELD_IGNORE, this::setDiscriminatorFieldIgnore);
         if (StringUtils.isEmpty(System.getenv("JAVA_POST_PROCESS_FILE"))) {
             LOGGER.info("Environment variable JAVA_POST_PROCESS_FILE not defined so the Java code may not be properly formatted. To define it, try 'export JAVA_POST_PROCESS_FILE=\"/usr/local/bin/clang-format -i\"' (Linux/Mac)");
             LOGGER.info("NOTE: To enable file post-processing, 'enablePostProcessFile' must be set to `true` (--enable-post-process-file for CLI).");
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
@@ -151,6 +151,7 @@ public class JavaClientCodegen extends AbstractJavaCodegen
     @Setter protected boolean supportVertxFuture = false;
     @Setter protected boolean useSealedOneOfInterfaces = false;
     @Setter protected boolean useUnaryInterceptor = false;
+
     protected String authFolder;
     /**
      * Serialization library.
diff --git a/modules/openapi-generator/src/main/resources/Java/typeInfoAnnotation.mustache b/modules/openapi-generator/src/main/resources/Java/typeInfoAnnotation.mustache
@@ -1,9 +1,12 @@
 {{#jackson}}
 
+{{^discriminatorFieldIgnore}}
 @JsonIgnoreProperties(
   value = "{{{discriminator.propertyBaseName}}}", // ignore manually set {{{discriminator.propertyBaseName}}}, it will be automatically generated by Jackson during serialization
   allowSetters = true // allows the {{{discriminator.propertyBaseName}}} to be set during deserialization
 )
+{{/discriminatorFieldIgnore}}
+
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "{{{discriminator.propertyBaseName}}}", visible = true)
 {{#discriminator.mappedModels}}
 {{#-first}}
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/AbstractJavaCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/AbstractJavaCodegenTest.java
@@ -46,6 +46,7 @@
 import java.util.stream.Collectors;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.openapitools.codegen.languages.AbstractJavaCodegen.DISCRIMINATOR_FIELD_IGNORE;
 
 public class AbstractJavaCodegenTest {
 
@@ -968,6 +969,15 @@ public void AnnotationsContainerTest() {
         Assert.assertEquals(defaultValue, "List<@Max(10)Integer>");
     }
 
+    @Test
+    public void discriminatorFieldIgnoreFlagTest() {
+        codegen.additionalProperties().put(DISCRIMINATOR_FIELD_IGNORE, true);
+
+        codegen.preprocessOpenAPI(FLATTENED_SPEC.get("3_0/petstore"));
+
+        Assert.assertTrue((boolean) codegen.additionalProperties().get(DISCRIMINATOR_FIELD_IGNORE));
+    }
+
     @Test
     public void removeAnnotationsTest() {
         Assert.assertEquals(codegen.removeAnnotations("@Min(0) @Max(10)Integer"), "Integer");
diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java
diff --git a/modules/openapi-generator/src/test/resources/3_0/java/issue12777.yaml b/modules/openapi-generator/src/test/resources/3_0/java/issue12777.yaml
