Skip to content

Commit 17e5a5e

Browse files
Mattias-SehlstedtMattias-Sehlstedt
committed
Add introspection support for discovering an enum discriminator in a oneOf allOf polymorphic structure
1 parent d6095a0 commit 17e5a5e

5 files changed

Lines changed: 187 additions & 25 deletions

File tree

‎modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@
9393

9494
import static org.openapitools.codegen.CodegenConstants.*;
9595
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
96+
import static org.openapitools.codegen.utils.DiscriminatorUtils.*;
9697
import static org.openapitools.codegen.utils.OnceLogger.once;
9798
import static org.openapitools.codegen.utils.StringUtils.*;
9899

@@ -3453,7 +3454,7 @@ private CodegenProperty discriminatorFound(String composedSchemaName, Schema sc,
34533454
* @param sc The Schema that may contain the discriminator
34543455
* @param visitedSchemas An array list of visited schemas
34553456
*/
3456-
private Discriminator recursiveGetDiscriminator(Schema sc, ArrayList<Schema> visitedSchemas) {
3457+
private DiscriminatorData recursiveGetDiscriminator(Schema sc, ArrayList<Schema> visitedSchemas) {
34573458
return DiscriminatorUtils.recursiveGetDiscriminator(openAPI, this.getLegacyDiscriminatorBehavior(), sc, visitedSchemas);
34583459
}
34593460

@@ -3590,7 +3591,7 @@ protected List<MappedModel> getAllOfDescendants(String thisSchemaName) {
35903591
}
35913592

35923593
protected CodegenDiscriminator createDiscriminator(String schemaName, Schema schema) {
3593-
Discriminator sourceDiscriminator = recursiveGetDiscriminator(schema, new ArrayList<Schema>());
3594+
DiscriminatorData sourceDiscriminator = recursiveGetDiscriminator(schema, new ArrayList<Schema>());
35943595
if (sourceDiscriminator == null) {
35953596
return null;
35963597
}
@@ -3607,7 +3608,13 @@ protected CodegenDiscriminator createDiscriminator(String schemaName, Schema sch
36073608
// FIXME: there are other ways to define the type of the discriminator property (inline
36083609
// for example). Handling those scenarios is too complicated for me, I'm leaving it for
36093610
// the future..
3610-
discriminator.setPropertyType(getDiscriminatorPropertyType(schema, discriminatorPropertyName));
3611+
String discriminatorType;
3612+
if (sourceDiscriminator.getPropertyType() != null) {
3613+
discriminatorType = toModelName(sourceDiscriminator.getPropertyType());
3614+
} else {
3615+
discriminatorType = getDiscriminatorPropertyType(schema, discriminatorPropertyName);
3616+
}
3617+
discriminator.setPropertyType(discriminatorType);
36113618

36123619
// check to see if the discriminator property is an enum string
36133620
boolean isEnum = Optional

‎modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/DiscriminatorUtils.java‎

Lines changed: 55 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import io.swagger.v3.oas.models.OpenAPI;
44
import io.swagger.v3.oas.models.media.Discriminator;
55
import io.swagger.v3.oas.models.media.Schema;
6+
import org.checkerframework.checker.nullness.qual.Nullable;
67
import org.slf4j.Logger;
78
import org.slf4j.LoggerFactory;
89

@@ -16,6 +17,8 @@ public class DiscriminatorUtils {
1617

1718
private static final String CONFLICTING_DISCRIMINATOR_NAMES =
1819
"The alternative schemas have conflicting discriminator property names. The schemas must have the same property name, but found {}";
20+
private static final String CONFLICTING_DISCRIMINATOR_TYPES =
21+
"The alternative schemas have conflicting discriminator property types ({})";
1922

2023
/**
2124
* Gets the simple ref name of the discriminator property type from the schema.
@@ -57,15 +60,20 @@ public static Schema getDiscriminatorSchema(Schema schema, String discriminatorN
5760
* @param sc The Schema that may contain the discriminator
5861
* @param visitedSchemas an array list of visited schemas
5962
*/
60-
public static Discriminator recursiveGetDiscriminator(
63+
public static DiscriminatorData recursiveGetDiscriminator(
6164
OpenAPI openAPI,
6265
boolean legacyDiscriminatorBehavior,
6366
Schema sc,
6467
ArrayList<Schema> visitedSchemas) {
6568
Schema refSchema = ModelUtils.getReferencedSchema(openAPI, sc);
66-
Discriminator foundDisc = refSchema.getDiscriminator();
67-
if (foundDisc != null) {
68-
return foundDisc;
69+
DiscriminatorData foundDisc = new DiscriminatorData(refSchema.getDiscriminator(), null);
70+
if (foundDisc.getDiscriminator() != null) {
71+
String discriminatorPropertyName = foundDisc.getDiscriminator().getPropertyName();
72+
return new DiscriminatorData(
73+
foundDisc.getDiscriminator(),
74+
DiscriminatorUtils.getDiscriminatorPropertyType(refSchema, discriminatorPropertyName)
75+
.orElse(null)
76+
);
6977
}
7078

7179
if (legacyDiscriminatorBehavior) {
@@ -89,7 +97,7 @@ public static Discriminator recursiveGetDiscriminator(
8997
if (foundDisc != null) {
9098
disc.setPropertyName(foundDisc.getPropertyName());
9199
disc.setMapping(foundDisc.getMapping());
92-
return disc;
100+
return new DiscriminatorData(disc, foundDisc.getPropertyType());
93101
}
94102
}
95103
}
@@ -115,16 +123,17 @@ public static Discriminator recursiveGetDiscriminator(
115123
* @param visitedSchemas an array list of visited schemas
116124
* @return the discriminator if the alternatives correctly shares one, otherwise null
117125
*/
118-
private static Discriminator getDiscriminatorFromAlternatives(
126+
private static DiscriminatorData getDiscriminatorFromAlternatives(
119127
OpenAPI openAPI,
120128
boolean legacyDiscriminatorBehavior,
121129
List<Schema> alternativeSchemas,
122130
ArrayList<Schema> visitedSchemas) {
123131
Discriminator discriminator = new Discriminator();
124-
Discriminator foundDisc = null;
132+
DiscriminatorData foundDisc = null;
125133
Integer hasDiscriminatorCnt = 0;
126134
Integer hasNullTypeCnt = 0;
127135
Set<String> discriminatorsPropNames = new HashSet<>();
136+
Set<String> discriminatorTypes = new HashSet<>();
128137
for (Object alternative : alternativeSchemas) {
129138
if (ModelUtils.isNullType((Schema) alternative)) {
130139
// The null type does not have a discriminator. Skip.
@@ -135,20 +144,58 @@ private static Discriminator getDiscriminatorFromAlternatives(
135144
if (foundDisc != null) {
136145
discriminatorsPropNames.add(foundDisc.getPropertyName());
137146
hasDiscriminatorCnt++;
147+
if (foundDisc.getPropertyType() != null) {
148+
discriminatorTypes.add(foundDisc.getPropertyType());
149+
}
138150
}
139151
}
140152
if (discriminatorsPropNames.size() > 1) {
141153
once(LOGGER).warn(CONFLICTING_DISCRIMINATOR_NAMES, String.join(", ", discriminatorsPropNames));
142154
}
155+
if (discriminatorTypes.size() > 1) {
156+
once(LOGGER).warn(CONFLICTING_DISCRIMINATOR_TYPES, String.join(", ", discriminatorTypes));
157+
}
143158
boolean allAlternativesHaveADiscriminator = hasDiscriminatorCnt + hasNullTypeCnt == alternativeSchemas.size();
144159
if (foundDisc != null && allAlternativesHaveADiscriminator && discriminatorsPropNames.size() == 1) {
145160
discriminator.setPropertyName(foundDisc.getPropertyName());
146161
discriminator.setMapping(foundDisc.getMapping());
147-
return discriminator;
162+
return new DiscriminatorData(discriminator, discriminatorTypes.size() == 1 ? foundDisc.getPropertyType() : null);
148163
}
149164
// If the scenario when composite schema has two children and one of them is the 'null' type,
150165
// there is no need for a discriminator.
151166
return null;
152167
}
153168

169+
public static class DiscriminatorData {
170+
private final Discriminator discriminator;
171+
172+
@Nullable
173+
private final String propertyType;
174+
175+
public DiscriminatorData(Discriminator discriminator, @Nullable String propertyType) {
176+
this.discriminator = discriminator;
177+
this.propertyType = propertyType;
178+
}
179+
180+
public Discriminator getDiscriminator() {
181+
return discriminator;
182+
}
183+
184+
public @Nullable String getPropertyType() {
185+
return propertyType;
186+
}
187+
188+
public String getPropertyName() {
189+
return discriminator.getPropertyName();
190+
}
191+
192+
public Map<String, String> getMapping() {
193+
return discriminator.getMapping();
194+
}
195+
196+
public Map<String, Object> getExtensions() {
197+
return discriminator.getExtensions();
198+
}
199+
}
200+
154201
}

‎modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/OneOfImplementorAdditionalData.java‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@
1515
* This class holds data to add to `oneOf` members. Let's consider this example:
1616
* <p>
1717
* Foo:
18-
* properties:
19-
* x:
20-
* oneOf:
21-
* - $ref: "#/components/schemas/One
22-
* - $ref: "#/components/schemas/Two
23-
* y:
24-
* type: string
18+
* properties:
19+
* x:
20+
* oneOf:
21+
* - $ref: "#/components/schemas/One"
22+
* - $ref: "#/components/schemas/Two"
23+
* y:
24+
* type: string
2525
* One:
26-
* properties:
27-
* z:
28-
* type: string
26+
* properties:
27+
* z:
28+
* type: string
2929
* Two:
30-
* properties:
31-
* a:
32-
* type: string
30+
* properties:
31+
* a:
32+
* type: string
3333
* <p>
3434
* In codegens that use this mechanism, `Foo` will become an interface and `One` will
3535
* become its implementing class. This class carries all data necessary to properly modify
@@ -99,7 +99,7 @@ public void addFromInterfaceModel(CodegenModel cm, List<Map<String, String>> mod
9999
* @param cc CodegenConfig running this operation
100100
* @param implcm the implementing model
101101
* @param implImports imports of the implementing model
102-
* @param addInterfaceImports whether or not to add the interface model as import (will vary by language)
102+
* @param addInterfaceImports whether to add the interface model as import (will vary by language)
103103
*/
104104
@SuppressWarnings("unchecked")
105105
public void addToImplementor(CodegenConfig cc, CodegenModel implcm, List<Map<String, String>> implImports, boolean addInterfaceImports) {

‎modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,6 +1210,35 @@ public void testEnumDiscriminatorWithDescriptionOverridden3_1() {
12101210
assertTrue(fruitModel.getVars().get(0).isEnumRef);
12111211
}
12121212

1213+
@Test
1214+
public void tesOneOfAllOfEnumDiscriminatorInheritance() {
1215+
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_1/polymorphism-oneof-allof-and-enum-discriminator.yaml");
1216+
new OpenAPINormalizer(openAPI, Map.of()).normalize();
1217+
DefaultCodegen codegen = new DefaultCodegen();
1218+
codegen.setUseOneOfInterfaces(true);
1219+
codegen.setLegacyDiscriminatorBehavior(false);
1220+
1221+
Schema inner = openAPI.getComponents().getSchemas().get("getAllPets_200_response_inner");
1222+
codegen.setOpenAPI(openAPI);
1223+
CodegenModel innerModel = codegen.fromModel("getAllPets_200_response_inner", inner);
1224+
assertTrue(innerModel.getHasDiscriminatorWithNonEmptyMapping());
1225+
assertTrue(innerModel.discriminator.getIsEnum());
1226+
assertEquals("PetType", innerModel.discriminator.getPropertyType());
1227+
assertTrue(innerModel.getVars().get(0).isEnumRef);
1228+
1229+
Schema cat = openAPI.getComponents().getSchemas().get("Cat");
1230+
CodegenModel catModel = codegen.fromModel("Cat", cat);
1231+
assertTrue(catModel.discriminator.getIsEnum());
1232+
assertEquals("PetType", catModel.discriminator.getPropertyType());
1233+
assertTrue(catModel.getVars().get(0).isEnumRef);
1234+
1235+
Schema dog = openAPI.getComponents().getSchemas().get("Dog");
1236+
CodegenModel dogModel = codegen.fromModel("Dog", dog);
1237+
assertTrue(dogModel.discriminator.getIsEnum());
1238+
assertEquals("PetType", dogModel.discriminator.getPropertyType());
1239+
assertTrue(dogModel.getVars().get(0).isEnumRef);
1240+
}
1241+
12131242
@Test
12141243
public void testParentName() {
12151244
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/allOf.yaml");

‎modules/openapi-generator/src/test/resources/3_1/polymorphism-oneof-allof-and-enum-discriminator.yaml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Polymorphism example with oneOf, allOf and enum-discriminator
4+
version: "1.0"
5+
paths:
6+
/pets:
7+
get:
8+
operationId: getAllPets
9+
responses:
10+
"200":
11+
content:
12+
application/json:
13+
schema:
14+
type: array
15+
items:
16+
oneOf:
17+
- $ref: "#/components/schemas/Cat"
18+
- $ref: "#/components/schemas/Dog"
19+
description: Success
20+
/children:
21+
get:
22+
operationId: getAllChildren
23+
responses:
24+
"200":
25+
content:
26+
application/json:
27+
schema:
28+
type: array
29+
items:
30+
oneOf:
31+
- $ref: "#/components/schemas/Child1"
32+
- $ref: "#/components/schemas/Child2"
33+
description: Success
34+
components:
35+
schemas:
36+
PetType:
37+
type: string
38+
enum:
39+
- Cat
40+
- Dog
41+
Pet:
42+
type: object
43+
discriminator:
44+
propertyName: petType
45+
properties:
46+
petType:
47+
$ref: '#/components/schemas/PetType'
48+
required:
49+
- petType
50+
Cat:
51+
description: A representation of a cat
52+
allOf:
53+
- $ref: '#/components/schemas/Pet'
54+
- type: object
55+
properties:
56+
huntingSkill:
57+
type: string
58+
description: The measured skill for hunting
59+
enum:
60+
- clueless
61+
- lazy
62+
- adventurous
63+
- aggressive
64+
required:
65+
- huntingSkill
66+
Dog:
67+
description: A representation of a dog
68+
allOf:
69+
- $ref: '#/components/schemas/Pet'
70+
- type: object
71+
properties:
72+
packSize:
73+
type: integer
74+
format: int32
75+
description: the size of the pack the dog is from
76+
default: 0
77+
minimum: 0
78+
required:
79+
- packSize

0 commit comments

Comments
 (0)