Add support for discriminator in OpenAPI v3#2151
Open
Conversation
80327bc to
f2e970a
Compare
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.
Describe the PR
Adds a new
@Discriminatorroute-handler annotation for OpenAPI v3. When a response (or request body) usesoneOfpolymorphism (multiple@Successannotations with the same status code), a discriminator object can now be declared to tell clients which concrete type to use at runtime.Relation issue
#2150 #829
Additional context
Builds on the existing
oneOfsupport introduced in #1870 and extended in #2059. The discriminator should only be applied to schemas that already contain aoneOfcomposition, as per the OpenAPI 3.0 spec.Implementation notes
@ProducediscriminatorInfo *parsedDiscriminatoris stored onOperationV3to bridge the two phases. Open to feedback on whether there's a better place for this — it felt slightly out of place on the struct but couldn't find a cleaner alternative given the parse ordering constraints.@Discriminatortwice on the same operation returns an error rather than silently overwriting.