[jaxrs-spec] Add @JsonIgnoreProperties on the discriminator to avoid duplicated keys during serialisation #24132
Merged
wing328 merged 2 commits intoJun 26, 2026
Conversation
…icate key Models with a discriminator emitted @JsonTypeInfo(As.PROPERTY) but also declared the discriminator property as a regular @JsonProperty field, so Jackson serialized the discriminator twice, producing a duplicate key in the response body. Mirror the Spring generator by emitting @JsonIgnoreProperties(value = "<prop>", allowSetters = true) on the discriminator-carrying model. allowSetters = true preserves the field during deserialization. The JsonIgnoreProperties import was already added unconditionally by AbstractJavaCodegen, so no Java change is required. Regenerated the affected jaxrs-spec samples.
…h legacyDiscriminatorBehavior=false Add a dedicated fixture (discriminator-mapping-children.yaml) and test asserting that when legacyDiscriminatorBehavior=false the discriminator is propagated onto the allOf children reachable via the discriminator mapping, so @JsonIgnoreProperties is emitted on the parent and every child, ensuring the discriminator property is not serialized twice in either case.
Ignacio-Vidal
changed the title
Contributor
Author
|
@wing328 - could you review this small PR? |
Member
|
thanks for the pr cc @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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Models with a discriminator emitted
@JsonTypeInfo(As.PROPERTY)but also declared the discriminator property as a regular @JsonProperty field, so Jackson serialized the discriminator twice, producing a duplicate key in the response body.Mirror the Spring generator by emitting:
@JsonIgnoreProperties(value = "<prop>", allowSetters = true)on the discriminator-carrying modelallowSetters = truepreserves the field during deserialization.The JsonIgnoreProperties import was already added unconditionally by AbstractJavaCodegen, so no Java change is required.
PR checklist
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.