Merge pull request #2478 from microsoft/fix/empty-array-to-support-v1

fix/empty array to support v1

Author: baywet

src/Microsoft.OpenApi/Models/OpenApiExample.cs

@@ -138,7 +138,10 @@ public void Serialize(IOpenApiWriter writer, OpenApiSpecVersion version)
             writer.WriteProperty(OpenApiConstants.Description, Description);
 
             // value
-            writer.WriteOptionalObject(OpenApiConstants.Value, Value, (w, v) => w.WriteAny(v));
+            if (Value is not null)
+            {
+                writer.WriteRequiredObject(OpenApiConstants.Value, Value, (w, v) => w.WriteAny(v));    
+            }
 
             // externalValue
             writer.WriteProperty(OpenApiConstants.ExternalValue, ExternalValue);

src/Microsoft.OpenApi/Models/OpenApiMediaType.cs

@@ -79,7 +79,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
             // examples
             if (Examples != null && Examples.Any())
             {
-                SerializeExamples(writer, Examples);
+                writer.WriteOptionalMap(OpenApiConstants.Examples, Examples, (w, e) => e.SerializeAsV3(w));
             }
 
             // encoding
@@ -98,33 +98,5 @@ public void SerializeAsV2(IOpenApiWriter writer)
         {
             // Media type does not exist in V2.
         }
-
-        private static void SerializeExamples(IOpenApiWriter writer, IDictionary<string, OpenApiExample> examples)
-        {
-            /* Special case for writing out empty arrays as valid response examples
-            * Check if there is any example with an empty array as its value and set the flag `hasEmptyArray` to true
-            * */
-            var hasEmptyArray = examples.Values.Any( static example =>
-                example.Value is OpenApiArray arr && arr.Count == 0
-            );
-
-            if (hasEmptyArray)
-            {
-                writer.WritePropertyName(OpenApiConstants.Examples);
-                writer.WriteStartObject();
-                foreach (var kvp in examples.Where(static kvp => kvp.Value.Value is OpenApiArray arr && arr.Count == 0))
-                {
-                    writer.WritePropertyName(kvp.Key);
-                    writer.WriteStartObject();
-                    writer.WriteRequiredObject(OpenApiConstants.Value, kvp.Value.Value, (w, v) => w.WriteAny(v));
-                    writer.WriteEndObject();
-                }
-                writer.WriteEndObject();
-            }
-            else
-            {
-                writer.WriteOptionalMap(OpenApiConstants.Examples, examples, (w, e) => e.SerializeAsV3(w));
-            }
-        }
     }
 }

test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiMediaTypeTests.cs

@@ -98,7 +98,16 @@ public void ParseMediaTypeWithEmptyArrayInExamplesWorks()
   },
   ""examples"": {
     ""Success response - no results"": {
+      ""summary"": ""empty array summary"",
+      ""description"": ""empty array description"",
       ""value"": [ ]
+    },
+    ""Success response - with results"": {
+      ""summary"": ""array summary"",
+      ""description"": ""array description"",
+      ""value"": [ 
+        ""1""
+      ]
     }
   }
 }

test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiMediaType/examplesWithEmptyArray.json

@@ -12,7 +12,14 @@
   },
   "examples": {
     "Success response - no results": {
+      "summary": "empty array summary",
+      "description": "empty array description",
       "value": []
+    },
+    "Success response - with results": {
+      "summary": "array summary",
+      "description": "array description",
+      "value": [ 1 ]
     }
   }
 }