Merge pull request #1774 from microsoft/mk/fix-examples-regression-bug

Fix examples serialization causing NullReferenceException

Author: MaggieKimani1

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

@@ -3,7 +3,7 @@
         <TargetFramework>netstandard2.0</TargetFramework>
         <LangVersion>latest</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <Version>1.6.17</Version>
+        <Version>1.6.18</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <SignAssembly>true</SignAssembly>
         <!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

@@ -3,7 +3,7 @@
         <TargetFramework>netstandard2.0</TargetFramework>
         <LangVersion>Latest</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <Version>1.6.17</Version>
+        <Version>1.6.18</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <SignAssembly>true</SignAssembly>
         <!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->

src/Microsoft.OpenApi/Models/OpenApiMediaType.cs

@@ -77,7 +77,10 @@ public void SerializeAsV3(IOpenApiWriter writer)
             writer.WriteOptionalObject(OpenApiConstants.Example, Example, (w, e) => w.WriteAny(e));
 
             // examples
-            SerializeExamples(writer, Examples);
+            if (Examples != null && Examples.Any())
+            {
+                SerializeExamples(writer, Examples);
+            }
 
             // encoding
             writer.WriteOptionalMap(OpenApiConstants.Encoding, Encoding, (w, e) => e.SerializeAsV3(w));

test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
@@ -1670,27 +1671,6 @@ private static OpenApiDocument ParseInputFile(string filePath)
             return openApiDoc;
         }
 
-        //[Fact]
-        //public void CopyConstructorForAdvancedDocumentWorks()
-        //{
-        //    // Arrange & Act
-        //    var doc = new OpenApiDocument(AdvancedDocument);
-
-        //    var docOpId = doc.Paths["/pets"].Operations[OperationType.Get].OperationId = "findAllMyPets";
-        //    var advancedDocOpId = AdvancedDocument.Paths["/pets"].Operations[OperationType.Get].OperationId;
-        //    var responseSchemaTypeCopy = doc.Paths["/pets"].Operations[OperationType.Get].Responses["200"].Content["application/json"].Schema.Type = "object";
-        //    var advancedDocResponseSchemaType = AdvancedDocument.Paths["/pets"].Operations[OperationType.Get].Responses["200"].Content["application/json"].Schema.Type;
-
-        //    // Assert
-        //    Assert.NotNull(doc.Info);
-        //    Assert.NotNull(doc.Servers);
-        //    Assert.NotNull(doc.Paths);
-        //    Assert.Equal(2, doc.Paths.Count);
-        //    Assert.NotNull(doc.Components);
-        //    Assert.NotEqual(docOpId, advancedDocOpId);
-        //    Assert.NotEqual(responseSchemaTypeCopy, advancedDocResponseSchemaType);
-        //}
-
         [Fact]
         public void SerializeV2DocumentWithNonArraySchemaTypeDoesNotWriteOutCollectionFormat()
         {
@@ -1858,5 +1838,38 @@ public void OpenApiDocumentCopyConstructorWithAnnotationsSucceeds()
 
             Assert.NotEqual(baseDocument.Annotations["key1"], actualDocument.Annotations["key1"]);
         }
-    }
+
+        [Fact]
+        public void SerializeExamplesDoesNotThrowNullReferenceException()
+        {
+            OpenApiDocument doc = new OpenApiDocument
+            {
+                Paths = new OpenApiPaths
+                {
+                    ["test"] = new OpenApiPathItem()
+                    {
+                        Operations = new Dictionary<OperationType, OpenApiOperation>()
+                        {
+                            [OperationType.Post] = new OpenApiOperation
+                            {
+                                RequestBody = new OpenApiRequestBody()
+                                {
+                                    Content =
+                                    {
+                                        ["application/json"] = new OpenApiMediaType()
+                                        {
+                                            Examples = null,
+                                        },
+                                    }
+                                }
+                            },
+                        }
+                    },
+                }
+            };
+
+            OpenApiJsonWriter apiWriter = new OpenApiJsonWriter(new StringWriter());
+            doc.Invoking(d => d.SerializeAsV3(apiWriter)).Should().NotThrow();
+        }
+    }    
 }