-
Notifications
You must be signed in to change notification settings - Fork 2.2k
feat: Infer discriminator mapping #4983
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
PatrickFeiring
wants to merge
1
commit into
swagger-api:master
Choose a base branch
from
PatrickFeiring:feat/infer-discriminator-mapping
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
39 changes: 39 additions & 0 deletions
39
...rc/test/java/io/swagger/v3/core/oas/models/composition/ModelWithDiscriminatorMapping.java
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
package io.swagger.v3.core.oas.models.composition; | ||
|
||
import com.fasterxml.jackson.annotation.JsonSubTypes; | ||
import com.fasterxml.jackson.annotation.JsonTypeInfo; | ||
import com.fasterxml.jackson.annotation.JsonTypeName; | ||
|
||
@JsonTypeInfo(use= JsonTypeInfo.Id.SIMPLE_NAME, include = JsonTypeInfo.As.PROPERTY, property="kind") | ||
@JsonSubTypes({ | ||
@JsonSubTypes.Type(value = ModelWithDiscriminatorMapping.First.class), | ||
@JsonSubTypes.Type(value = ModelWithDiscriminatorMapping.Second.class, name = "SecondType"), | ||
@JsonSubTypes.Type(value = ModelWithDiscriminatorMapping.Third.class) | ||
}) | ||
public class ModelWithDiscriminatorMapping { | ||
|
||
public static class First extends ModelWithDiscriminatorMapping { | ||
private String name; | ||
|
||
public String getName() { return name; } | ||
|
||
public void setName(String name) { this.name = name; } | ||
} | ||
|
||
public static class Second extends ModelWithDiscriminatorMapping { | ||
private String value; | ||
|
||
public String getValue() { return value; } | ||
|
||
public void setValue(String value) { this.value = value; } | ||
} | ||
|
||
@JsonTypeName("ThirdType") | ||
public static class Third extends ModelWithDiscriminatorMapping { | ||
private String value; | ||
|
||
public String getValue() { return value; } | ||
|
||
public void setValue(String value) { this.value = value; } | ||
} | ||
} |
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
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
60 changes: 60 additions & 0 deletions
60
modules/swagger-core/src/test/resources/ModelWithDiscriminatorMapping.json
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
{ | ||
"First" : { | ||
"type" : "object", | ||
"allOf" : [ { | ||
"$ref" : "#/components/schemas/ModelWithDiscriminatorMapping" | ||
}, { | ||
"type" : "object", | ||
"properties" : { | ||
"name" : { | ||
"type" : "string" | ||
} | ||
} | ||
} ] | ||
}, | ||
"ModelWithDiscriminatorMapping" : { | ||
"required" : [ "kind" ], | ||
"type" : "object", | ||
"properties" : { | ||
"kind" : { | ||
"type" : "string" | ||
} | ||
}, | ||
"discriminator" : { | ||
"propertyName" : "kind", | ||
"mapping" : { | ||
"SecondType" : "#/components/schemas/Second", | ||
"ThirdType" : "#/components/schemas/Third" | ||
} | ||
} | ||
}, | ||
"Second" : { | ||
"type": "object", | ||
"allOf": [ | ||
{ | ||
"$ref": "#/components/schemas/ModelWithDiscriminatorMapping" | ||
}, | ||
{ | ||
"type": "object", | ||
"properties": { | ||
"value": { | ||
"type": "string" | ||
} | ||
} | ||
} | ||
] | ||
}, | ||
"Third" : { | ||
"type" : "object", | ||
"allOf" : [ { | ||
"$ref" : "#/components/schemas/ModelWithDiscriminatorMapping" | ||
}, { | ||
"type" : "object", | ||
"properties" : { | ||
"value" : { | ||
"type" : "string" | ||
} | ||
} | ||
} ] | ||
} | ||
} |
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As outlined in the issue comment, there are likely ways to find subtypes in a more exhaustive manner, but using the introspector seemed a good conservative starting point that covers the most common use-cases, as I don't know Jackson internals all that well
#3411 (comment)