[Java] ensure JsonTypeName not generated for class implementing oneOf with discriminator#24024
Open
jpfinne wants to merge 13 commits into
Open
[Java] ensure JsonTypeName not generated for class implementing oneOf with discriminator#24024jpfinne wants to merge 13 commits into
jpfinne wants to merge 13 commits into
Conversation
merge master
…erface has a discriminator mapping
Contributor
There was a problem hiding this comment.
2 issues found across 3 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
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
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.
Fixes #23997
For a child that's part of a non-empty discriminator mapping, the parent interface already declares the type id via @JsonSubTypes.Type(name = ...), so emitting @JsonTypeName on the child is redundant (and was the source of the original mismatch). Marking the mapped child models with hasDiscriminatorWithNonEmptyMapping so the existing {{^hasDiscriminatorWithNonEmptyMapping}} guard suppresses @JsonTypeName
The fix applies for all generators using Jackson and CodegenModel.hasDiscriminatorWithNonEmptyMapping
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.
Java | @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)
Java Spring | @cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)
Summary by cubic
Stop generating @JsonTypeName for child models when a parent oneOf interface uses a discriminator with a non-empty mapping. This removes redundant annotations and avoids type id mismatches with the parent’s @JsonSubTypes and @JsonTypeInfo.
issue24003Spring test andissue_24003.yamlto assert the parent interface has @JsonTypeInfo (including visible = true) and @JsonSubTypes, and child classes do not contain @JsonTypeName.Written for commit dc0d05b. Summary will update on new commits.