Skip to content

[java][jackson] fix: conditionally add jackson JsonIgnoreProperties for base class polymorphism fixes #12777 #22527#22528

Merged
wing328 merged 8 commits intoOpenAPITools:masterfrom
dnowo:fix_issue_12777
Jan 19, 2026
Merged

[java][jackson] fix: conditionally add jackson JsonIgnoreProperties for base class polymorphism fixes #12777 #22527#22528
wing328 merged 8 commits intoOpenAPITools:masterfrom
dnowo:fix_issue_12777

Conversation

@dnowo
Copy link
Contributor

@dnowo dnowo commented Dec 10, 2025

Adresses issues:

Flag added to config:
disableDiscriminatorFieldIgnore -> if true, it ignores, does not creates jakarta @JsonIgnoreProperties in parent class like so:

/**
 * BaseConfiguration
 */
@JsonPropertyOrder({
  BaseConfiguration.JSON_PROPERTY_ID,
  BaseConfiguration.JSON_PROPERTY_TYPE
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-12-10T23:17:17.750816900+01:00[Europe/Warsaw]", comments = "Generator version: 7.18.0-SNAPSHOT")

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true)
@JsonSubTypes({
  @JsonSubTypes.Type(value = ChildOneConfiguration.class, name = "CHILD_ONE"),
  @JsonSubTypes.Type(value = ChildTwoConfiguration.class, name = "CHILD_TWO"),
})

public class BaseConfiguration {
  public static final String JSON_PROPERTY_ID = "id";
  @javax.annotation.Nullable
  private Long id;

  public static final String JSON_PROPERTY_TYPE = "type";
  @javax.annotation.Nonnull
  private ConfigurationType type;

  public BaseConfiguration() { 
  }

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

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.

…12777

# Conflicts:
#	modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/AbstractJavaCodegenTest.java
@dnowo dnowo changed the title fix: conditionally add jackson JsonIgnoreProperties for base class polymorphism fixes #12777 #22527 [java][jackson] fix: conditionally add jackson JsonIgnoreProperties for base class polymorphism fixes #12777 #22527 Dec 10, 2025
@wing328
Copy link
Member

wing328 commented Jan 19, 2026

CI issue not related to this change (samples already updated in latest master)

@wing328
Copy link
Member

wing328 commented Jan 19, 2026

thanks for the PR

let's give it a try

@wing328 wing328 merged commit 502565b into OpenAPITools:master Jan 19, 2026
13 of 14 checks passed
@dschodits-secunet
Copy link
Contributor

Thank you for doing all the work, I just have one suggestion/problem with this solution:
Due to the fact that the include parameter in the @JsonTypeInfo is still JsonTypeInfo.As.Property you run the risk of having the discriminator serialized twice. For example:
openapi.yaml:

    Pet:
      type: object
      discriminator:
        propertyName: petIntType
        mapping:
          0: '#/components/schemas/Dog'
          1: '#/components/schemas/Cat'
      properties:
        name:
          type: string
        petIntType:
          type: integer
      required:
        - name
    Cat: 
      description: A representation of a cat
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
          properties:
            huntingSkill:
              type: string
          required:
            - huntingSkill
    Dog: 
      description: A representation of a dog
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
          properties:
            packSize:
              type: integer
              format: int32
          required:
            - packSize

With this simple Javacode:

final var response = new Dog().petIntType(0).packSize(10).name("Dogo");
String ser = new ObjectMapper().writeValueAsString(response);
System.out.println("Seriliazied: " + ser)

Results in this:
Seriliazied: {"petIntType":"0","packSize":10,"name":"Dogo","petIntType":0}

My suggestion would be to use JsonTypeInfo.As.EXISTING_PROPERTY when disableDiscriminatorFieldIgnore is set to true. Something like this:

{{^disableDiscriminatorJsonIgnoreProperties}}
@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
)
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "{{{discriminator.propertyBaseName}}}", visible = true)
{{/disableDiscriminatorJsonIgnoreProperties}}

{{#disableDiscriminatorJsonIgnoreProperties}}
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "{{{discriminator.propertyBaseName}}}", visible = true)
{{/disableDiscriminatorJsonIgnoreProperties}}

This resolved the issue for me and I think it would not cause any problems, but I am happy to here any feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants