Add introspection support for discovering an enum discriminator in a oneOf allOf polymorphic structure#24158
Draft
Mattias-Sehlstedt wants to merge 1 commit into
Conversation
17e5a5e to
ea7b62c
Compare
Contributor
There was a problem hiding this comment.
2 issues found and verified against the latest diff
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java">
<violation number="1" location="modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java:1214">
P3: Typo in test method name: 'tesOneOfAllOfEnumDiscriminatorInheritance' should be 'testOneOfAllOfEnumDiscriminatorInheritance' (missing 't')</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
ea7b62c to
43ee077
Compare
…oneOf allOf polymorphic structure
43ee077 to
1c1a852
Compare
This was referenced Jun 29, 2026
3 tasks
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.
This PR adds so that the
useOneOfInterfacessetting properly supports when the discriminator is an enum for the case where the discriminator is inherited in a oneOf -> allOf scenario.Summary
This PR introduces so that the discriminator discovering (done in method
recursiveGetDiscriminator) not only finds the property carrying the discriminator, but also the property's type. This gives the interface creator the opportunity to ensure that its discriminator type field aligns with that of the implementing children.Example scenario
For example given the specification:
where a oneOf containing both children exists. The children in turn references a parent (
Pet) that in turn defines the discriminator value as an enum (PetType).With the current generator, the property type of the parent is not considered, so the generated
interfacehas typeString, while the children have the enumPetType. This means that the code does not compile.This type of structure is what you natively get with swagger-core and springdoc when using
@JsonSubTypesfor polymorphism in an array-context. So out-of-the-box support would be very useful.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.
Summary by cubic
Adds introspection to discover enum discriminator types inherited through oneOf/allOf so generated models use the enum instead of string. Fixes compile errors with
useOneOfInterfaceswhen the discriminator is defined on a parent and referenced by children.recursiveGetDiscriminatornow returnsDiscriminatorData(discriminator + property type), andDefaultCodegenuses it to setCodegenDiscriminator.propertyType, preferring the discovered type.Written for commit 1c1a852. Summary will update on new commits.