Use anyOf in schema if ref is nullable

millicentachieng · millicentachieng · commit c8d4e3afac55 · 2022-07-07T19:01:30.000+03:00
diff --git a/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiEdmTypeSchemaGenerator.cs b/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiEdmTypeSchemaGenerator.cs
@@ -422,7 +422,7 @@ private static OpenApiSchema CreateEnumTypeSchema(this ODataContext context, IEd
             OpenApiSchema schema = new OpenApiSchema();
             schema.Reference = null;
 
-            if (context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)
+            if (typeReference.IsNullable && context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)
             {
                 schema.AnyOf = new List<OpenApiSchema>
                 {
@@ -434,17 +434,13 @@ private static OpenApiSchema CreateEnumTypeSchema(this ODataContext context, IEd
                             Type = ReferenceType.Schema,
                             Id = typeReference.Definition.FullTypeName()
                         }
-                    }
-                };
-
-                if (typeReference.IsNullable)
-                {
-                    schema.AnyOf.Add(new OpenApiSchema
+                    },
+                    new OpenApiSchema
                     {
                         Type = "object",
                         Nullable = true
-                    });
-                }
+                    }
+                };
             }
             else
             {
@@ -518,7 +514,7 @@ private static OpenApiSchema CreateTypeDefinitionSchema(this ODataContext contex
             OpenApiSchema schema = new OpenApiSchema();
             schema.Reference = null;
 
-            if (context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)
+            if (reference.IsNullable && context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)
             {
                 schema.AnyOf = new List<OpenApiSchema>
                 {
@@ -530,17 +526,13 @@ private static OpenApiSchema CreateTypeDefinitionSchema(this ODataContext contex
                             Type = ReferenceType.Schema,
                             Id = reference.Definition.FullTypeName()
                         }
-                    }
-                };
-
-                if (reference.IsNullable)
-                {
-                    schema.AnyOf.Add(new OpenApiSchema
+                    },
+                    new OpenApiSchema
                     {
                         Type = "object",
                         Nullable = true
-                    });
-                }
+                    }
+                };
             }
             else
             {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiEdmTypeSchemaGeneratorTest.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiEdmTypeSchemaGeneratorTest.cs
@@ -199,11 +199,12 @@ public void CreateEdmTypeSchemaReturnSchemaForEnumType(bool isNullable, OpenApiS
             }
             else
             {
-                Assert.Null(schema.Reference);
-                Assert.NotNull(schema.AnyOf);
-                Assert.NotEmpty(schema.AnyOf);
+                
                 if (isNullable)
                 {
+                    Assert.NotNull(schema.AnyOf);
+                    Assert.NotEmpty(schema.AnyOf);
+                    Assert.Null(schema.Reference);
                     Assert.Equal(2, schema.AnyOf.Count);
                     var anyOfRef = schema.AnyOf.FirstOrDefault();
                     Assert.NotNull(anyOfRef.Reference);
@@ -216,11 +217,10 @@ public void CreateEdmTypeSchemaReturnSchemaForEnumType(bool isNullable, OpenApiS
                 }
                 else
                 {
-                    Assert.Equal(1, schema.AnyOf.Count);
-                    var anyOf = Assert.Single(schema.AnyOf);
-                    Assert.NotNull(anyOf.Reference);
-                    Assert.Equal(ReferenceType.Schema, anyOf.Reference.Type);
-                    Assert.Equal(enumType.FullTypeName(), anyOf.Reference.Id);
+                    Assert.Null(schema.AnyOf);
+                    Assert.NotNull(schema.Reference);
+                    Assert.Equal(ReferenceType.Schema, schema.Reference.Type);
+                    Assert.Equal(enumType.FullTypeName(), schema.Reference.Id);
                 }             
             }
         }
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs
@@ -672,7 +672,7 @@ public void CreatePropertySchemaForNonNullableEnumPropertyReturnSchema(OpenApiSp
 
             IEdmEnumType enumType = model.SchemaElements.OfType<IEdmEnumType>().First(e => e.Name == "Color");
             EdmEntityType entitType = new EdmEntityType("NS", "Entity");
-            IEdmProperty property = new EdmStructuralProperty(entitType, "ColorEnumValue", new EdmEnumTypeReference(enumType, false), "yellow");
+            IEdmProperty property = new EdmStructuralProperty(entitType, "ColorEnumValue", new EdmEnumTypeReference(enumType, false));
 
             // Act
             var schema = context.CreatePropertySchema(property);
@@ -690,12 +690,7 @@ public void CreatePropertySchemaForNonNullableEnumPropertyReturnSchema(OpenApiSp
             else
             {
                 Assert.Equal(@"{
-  ""anyOf"": [
-    {
-      ""$ref"": ""#/components/schemas/DefaultNs.Color""
-    }
-  ],
-  ""default"": ""yellow""
+  ""$ref"": ""#/components/schemas/DefaultNs.Color""
 }".ChangeLineBreaks(), json);
             }
         }
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json
@@ -29242,11 +29242,7 @@
             "nullable": true
           },
           "Gender": {
-            "anyOf": [
-              {
-                "$ref": "#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender"
-              }
-            ]
+            "$ref": "#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender"
           },
           "Age": {
             "anyOf": [
@@ -29293,20 +29289,12 @@
             ]
           },
           "FavoriteFeature": {
-            "anyOf": [
-              {
-                "$ref": "#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature"
-              }
-            ]
+            "$ref": "#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature"
           },
           "Features": {
             "type": "array",
             "items": {
-              "anyOf": [
-                {
-                  "$ref": "#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature"
-                }
-              ]
+              "$ref": "#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature"
             }
           },
           "Friends": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml
@@ -20433,8 +20433,7 @@ components:
           type: string
           nullable: true
         Gender:
-          anyOf:
-            - $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender'
+          $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender'
         Age:
           anyOf:
             - type: integer
@@ -20459,13 +20458,11 @@ components:
             - type: object
               nullable: true
         FavoriteFeature:
-          anyOf:
-            - $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature'
+          $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature'
         Features:
           type: array
           items:
-            anyOf:
-              - $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature'
+            $ref: '#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature'
         Friends:
           type: array
           items:

Original file line number	Diff line number	Diff line change
`@@ -422,7 +422,7 @@ private static OpenApiSchema CreateEnumTypeSchema(this ODataContext context, IEd`
`422`	`422`	`OpenApiSchema schema = new OpenApiSchema();`
`423`	`423`	`schema.Reference = null;`
`424`	`424`
`425`		`- if (context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)`
	`425`	`+ if (typeReference.IsNullable && context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)`
`426`	`426`	`{`
`427`	`427`	`schema.AnyOf = new List<OpenApiSchema>`
`428`	`428`	`{`
`@@ -434,17 +434,13 @@ private static OpenApiSchema CreateEnumTypeSchema(this ODataContext context, IEd`
`434`	`434`	`Type = ReferenceType.Schema,`
`435`	`435`	`Id = typeReference.Definition.FullTypeName()`
`436`	`436`	`}`
`437`		`- }`
`438`		`- };`
`439`		`-`
`440`		`- if (typeReference.IsNullable)`
`441`		`- {`
`442`		`- schema.AnyOf.Add(new OpenApiSchema`
	`437`	`+ },`
	`438`	`+ new OpenApiSchema`
`443`	`439`	`{`
`444`	`440`	`Type = "object",`
`445`	`441`	`Nullable = true`
`446`		`- });`
`447`		`- }`
	`442`	`+ }`
	`443`	`+ };`
`448`	`444`	`}`
`449`	`445`	`else`
`450`	`446`	`{`
`@@ -518,7 +514,7 @@ private static OpenApiSchema CreateTypeDefinitionSchema(this ODataContext contex`
`518`	`514`	`OpenApiSchema schema = new OpenApiSchema();`
`519`	`515`	`schema.Reference = null;`
`520`	`516`
`521`		`- if (context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)`
	`517`	`+ if (reference.IsNullable && context.Settings.OpenApiSpecVersion >= OpenApiSpecVersion.OpenApi3_0)`
`522`	`518`	`{`
`523`	`519`	`schema.AnyOf = new List<OpenApiSchema>`
`524`	`520`	`{`
`@@ -530,17 +526,13 @@ private static OpenApiSchema CreateTypeDefinitionSchema(this ODataContext contex`
`530`	`526`	`Type = ReferenceType.Schema,`
`531`	`527`	`Id = reference.Definition.FullTypeName()`
`532`	`528`	`}`
`533`		`- }`
`534`		`- };`
`535`		`-`
`536`		`- if (reference.IsNullable)`
`537`		`- {`
`538`		`- schema.AnyOf.Add(new OpenApiSchema`
	`529`	`+ },`
	`530`	`+ new OpenApiSchema`
`539`	`531`	`{`
`540`	`532`	`Type = "object",`
`541`	`533`	`Nullable = true`
`542`		`- });`
`543`		`- }`
	`534`	`+ }`
	`535`	`+ };`
`544`	`536`	`}`
`545`	`537`	`else`
`546`	`538`	`{`
Original file line number	Diff line number	Diff line change
`@@ -199,11 +199,12 @@ public void CreateEdmTypeSchemaReturnSchemaForEnumType(bool isNullable, OpenApiS`
`199`	`199`	`}`
`200`	`200`	`else`
`201`	`201`	`{`
`202`		`- Assert.Null(schema.Reference);`
`203`		`- Assert.NotNull(schema.AnyOf);`
`204`		`- Assert.NotEmpty(schema.AnyOf);`
	`202`	`+`
`205`	`203`	`if (isNullable)`
`206`	`204`	`{`
	`205`	`+ Assert.NotNull(schema.AnyOf);`
	`206`	`+ Assert.NotEmpty(schema.AnyOf);`
	`207`	`+ Assert.Null(schema.Reference);`
`207`	`208`	`Assert.Equal(2, schema.AnyOf.Count);`
`208`	`209`	`var anyOfRef = schema.AnyOf.FirstOrDefault();`
`209`	`210`	`Assert.NotNull(anyOfRef.Reference);`
`@@ -216,11 +217,10 @@ public void CreateEdmTypeSchemaReturnSchemaForEnumType(bool isNullable, OpenApiS`
`216`	`217`	`}`
`217`	`218`	`else`
`218`	`219`	`{`
`219`		`- Assert.Equal(1, schema.AnyOf.Count);`
`220`		`- var anyOf = Assert.Single(schema.AnyOf);`
`221`		`- Assert.NotNull(anyOf.Reference);`
`222`		`- Assert.Equal(ReferenceType.Schema, anyOf.Reference.Type);`
`223`		`- Assert.Equal(enumType.FullTypeName(), anyOf.Reference.Id);`
	`220`	`+ Assert.Null(schema.AnyOf);`
	`221`	`+ Assert.NotNull(schema.Reference);`
	`222`	`+ Assert.Equal(ReferenceType.Schema, schema.Reference.Type);`
	`223`	`+ Assert.Equal(enumType.FullTypeName(), schema.Reference.Id);`
`224`	`224`	`}`
`225`	`225`	`}`
`226`	`226`	`}`