Fixes v2 examples serialization in a response object

src/Microsoft.OpenApi.Readers/V2/OpenApiResponseDeserializer.cs

@@ -1,6 +1,7 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System;
 using System.Collections.Generic;
 using Json.Schema;
 using Microsoft.OpenApi.Extensions;
@@ -29,6 +30,10 @@ internal static partial class OpenApiV2Deserializer
                 "examples",
                 LoadExamples
             },
+            {
+                "x-examples",
+                LoadExamplesExtension
+            },
             {
                 "schema",
                 (o, n) => n.Context.SetTempStorage(TempStorageKeys.ResponseSchema, LoadSchema(n), o)
@@ -38,7 +43,7 @@ internal static partial class OpenApiV2Deserializer
         private static readonly PatternFieldMap<OpenApiResponse> _responsePatternFields =
             new()
             {
-                {s => s.StartsWith("x-"), (o, p, n) => o.AddExtension(p, LoadExtension(p, n))}
+                {s => s.StartsWith("x-") && !s.Equals(OpenApiConstants.ExamplesExtension), (o, p, n) => o.AddExtension(p, LoadExtension(p, n))}
             };
 
         private static readonly AnyFieldMap<OpenApiMediaType> _mediaTypeAnyFields =
@@ -70,6 +75,8 @@ private static void ProcessProduces(MapNode mapNode, OpenApiResponse response, P
                 ?? context.DefaultContentType ?? new List<string> { "application/octet-stream" };
 
             var schema = context.GetFromTempStorage<JsonSchema>(TempStorageKeys.ResponseSchema, response);
+            var examples = context.GetFromTempStorage<Dictionary<string, OpenApiExample>>(TempStorageKeys.Examples, response)
+                ?? new Dictionary<string, OpenApiExample>();
 
             foreach (var produce in produces)
             {
@@ -85,20 +92,58 @@ private static void ProcessProduces(MapNode mapNode, OpenApiResponse response, P
                 {
                     var mediaType = new OpenApiMediaType
                     {
-                        Schema = schema
+                        Schema = schema,
+                        Examples = examples
                     };
 
                     response.Content.Add(produce, mediaType);
                 }
             }
 
             context.SetTempStorage(TempStorageKeys.ResponseSchema, null, response);
+            context.SetTempStorage(TempStorageKeys.Examples, null, response);
             context.SetTempStorage(TempStorageKeys.ResponseProducesSet, true, response);
         }
 
+        private static void LoadExamplesExtension(OpenApiResponse response, ParseNode node)
+        {
+            var mapNode = node.CheckMapNode(OpenApiConstants.ExamplesExtension);
+            var examples = new Dictionary<string, OpenApiExample>();
+
+            foreach (var examplesNode in mapNode)
+            {
+                // Load the media type node as an OpenApiExample object
+                var example = new OpenApiExample();
+                var exampleNode = examplesNode.Value.CheckMapNode(examplesNode.Name);
+                foreach (var valueNode in exampleNode)
+                {
+                    switch (valueNode.Name.ToLowerInvariant())
+                    {
+                        case "summary":
+                            example.Summary = valueNode.Value.GetScalarValue();
+                            break;
+                        case "description":
+                            example.Description = valueNode.Value.GetScalarValue();
+                            break;
+                        case "value":
+                            example.Value = valueNode.Value.CreateAny();
+                            break;
+                        case "externalValue":
+                            example.ExternalValue = valueNode.Value.GetScalarValue();
+                            break;
+                    }
+                }                
+
+                examples.Add(examplesNode.Name, example);
+            }
+
+            node.Context.SetTempStorage(TempStorageKeys.Examples, examples, response);
+        }
+
         private static void LoadExamples(OpenApiResponse response, ParseNode node)
         {
             var mapNode = node.CheckMapNode("examples");
+
             foreach (var mediaTypeNode in mapNode)
             {
                 LoadExample(response, mediaTypeNode.Name, mediaTypeNode.Value);
@@ -109,10 +154,7 @@ private static void LoadExample(OpenApiResponse response, string mediaType, Pars
         {
             var exampleNode = node.CreateAny();
 
-            if (response.Content == null)
-            {
-                response.Content = new Dictionary<string, OpenApiMediaType>();
-            }
+            response.Content ??= new Dictionary<string, OpenApiMediaType>();
 
             OpenApiMediaType mediaTypeObject;
             if (response.Content.TryGetValue(mediaType, out var value))
@@ -142,6 +184,7 @@ public static OpenApiResponse LoadResponse(ParseNode node)
             }
 
             var response = new OpenApiResponse();
+
             foreach (var property in mapNode)
             {
                 property.ParseField(response, _responseFixedFields, _responsePatternFields);

src/Microsoft.OpenApi.Readers/V2/TempStorageKeys.cs

@@ -17,5 +17,6 @@ internal static class TempStorageKeys
         public const string GlobalConsumes = "globalConsumes";
         public const string GlobalProduces = "globalProduces";
         public const string ParameterIsBodyOrFormData = "parameterIsBodyOrFormData";
+        public const string Examples = "examples";
     }
 }

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

@@ -585,6 +585,11 @@ public static class OpenApiConstants
         /// </summary>
         public const string BodyName = "x-bodyName";
 
+        /// <summary>
+        /// Field: Examples Extension
+        /// </summary>
+        public const string ExamplesExtension = "x-examples";
+
         /// <summary>
         /// Field: version3_0_0
         /// </summary>

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -613,7 +613,13 @@ internal IOpenApiReferenceable ResolveReference(OpenApiReference reference, bool
             }
         }
 
-        ///
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="pointer"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
+        /// <exception cref="NotImplementedException"></exception>
         public JsonSchema FindSubschema(Json.Pointer.JsonPointer pointer, EvaluationOptions options)
         {
             throw new NotImplementedException();

src/Microsoft.OpenApi/Models/OpenApiParameter.cs

@@ -3,7 +3,7 @@
 
 using System;
 using System.Collections.Generic;
-using System.Text.Json;
+using System.Linq;
 using Json.Schema;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Extensions;
@@ -224,14 +224,7 @@ private void SerializeInternal(IOpenApiWriter writer, Action<IOpenApiWriter, IOp
         /// <returns>OpenApiParameter</returns>
         public OpenApiParameter GetEffective(OpenApiDocument doc)
         {
-            if (Reference != null)
-            {
-                return doc.ResolveReferenceTo<OpenApiParameter>(Reference);
-            }
-            else
-            {
-                return this;
-            }
+            return Reference != null ? doc.ResolveReferenceTo<OpenApiParameter>(Reference) : this;
         }
 
         /// <summary>
@@ -433,6 +426,20 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
                 }
             }
 
+            //examples
+            if (Examples != null && Examples.Any())
+            {
+                writer.WritePropertyName(OpenApiConstants.ExamplesExtension);
+                writer.WriteStartObject();
+
+                foreach (var example in Examples)
+                {
+                    writer.WritePropertyName(example.Key);
+                    writer.WriteV2Examples(writer, example.Value, OpenApiSpecVersion.OpenApi2_0);
+                }
+                writer.WriteEndObject();
+            }
+
             // extensions
             writer.WriteExtensions(extensionsClone, OpenApiSpecVersion.OpenApi2_0);
 

src/Microsoft.OpenApi/Models/OpenApiRequestBody.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
 using System;
@@ -113,14 +113,7 @@ private void SerializeInternal(IOpenApiWriter writer, Action<IOpenApiWriter, IOp
         /// <returns>OpenApiRequestBody</returns>
         public OpenApiRequestBody GetEffective(OpenApiDocument doc)
         {
-            if (Reference != null)
-            {
-                return doc.ResolveReferenceTo<OpenApiRequestBody>(Reference);
-            }
-            else
-            {
-                return this;
-            }
+            return Reference != null ? doc.ResolveReferenceTo<OpenApiRequestBody>(Reference) : this;
         }
 
         /// <summary>
@@ -186,12 +179,13 @@ internal OpenApiBodyParameter ConvertToBodyParameter()
                 // To allow round-tripping we use an extension to hold the name
                 Name = "body",
                 Schema = Content.Values.FirstOrDefault()?.Schema ?? new JsonSchemaBuilder().Build(),
+                Examples = Content.Values.FirstOrDefault()?.Examples,
                 Required = Required,
                 Extensions = Extensions.ToDictionary(static k => k.Key, static v => v.Value)  // Clone extensions so we can remove the x-bodyName extensions from the output V2 model.
             };
-            if (bodyParameter.Extensions.ContainsKey(OpenApiConstants.BodyName))
+            if (bodyParameter.Extensions.TryGetValue(OpenApiConstants.BodyName, out var bodyParameterName))
             {
-                var bodyName = bodyParameter.Extensions[OpenApiConstants.BodyName] as OpenApiAny;
+                var bodyName = bodyParameterName as OpenApiAny;
                 bodyParameter.Name = string.IsNullOrEmpty(bodyName?.Node.ToString()) ? "body" : bodyName?.Node.ToString();
                 bodyParameter.Extensions.Remove(OpenApiConstants.BodyName);
             }
@@ -205,20 +199,12 @@ internal IEnumerable<OpenApiFormDataParameter> ConvertToFormDataParameters()
 
             foreach (var property in Content.First().Value.Schema.GetProperties())
             {
-                var paramSchema = property.Value;
-                if (paramSchema.GetType().Equals(SchemaValueType.String)
-                    && ("binary".Equals(paramSchema.GetFormat().Key, StringComparison.OrdinalIgnoreCase)
-                    || "base64".Equals(paramSchema.GetFormat().Key, StringComparison.OrdinalIgnoreCase)))
-                {
-                    // JsonSchema is immutable so these can't be set
-                    //paramSchema.Type("file");
-                    //paramSchema.Format(null);
-                }
                 yield return new()
                 {
                     Description = property.Value.GetDescription(),
                     Name = property.Key,
                     Schema = property.Value,
+                    Examples = Content.Values.FirstOrDefault()?.Examples,
                     Required = Content.First().Value.Schema.GetRequired()?.Contains(property.Key) ?? false
                 };
             }

src/Microsoft.OpenApi/Models/OpenApiResponse.cs

@@ -118,14 +118,7 @@ private void SerializeInternal(IOpenApiWriter writer, Action<IOpenApiWriter, IOp
         /// <returns>OpenApiResponse</returns>
         public OpenApiResponse GetEffective(OpenApiDocument doc)
         {
-            if (Reference != null)
-            {
-                return doc.ResolveReferenceTo<OpenApiResponse>(Reference);
-            }
-            else
-            {
-                return this;
-            }
+            return Reference != null ? doc.ResolveReferenceTo<OpenApiResponse>(Reference) : this;
         }
 
         /// <summary>
@@ -140,7 +133,7 @@ public virtual void SerializeAsV31WithoutReference(IOpenApiWriter writer)
         /// <summary>
         /// Serialize to OpenAPI V3 document without using reference.
         /// </summary>
-        public virtual void SerializeAsV3WithoutReference(IOpenApiWriter writer) 
+        public virtual void SerializeAsV3WithoutReference(IOpenApiWriter writer)
         {
             SerializeInternalWithoutReference(writer, OpenApiSpecVersion.OpenApi3_0,
                 (writer, element) => element.SerializeAsV3(writer));
@@ -231,6 +224,22 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
                         writer.WriteEndObject();
                     }
 
+                    if (Content.Values.Any(m => m.Examples != null && m.Examples.Any()))
+                    {
+                        writer.WritePropertyName(OpenApiConstants.ExamplesExtension);
+                        writer.WriteStartObject();
+
+                        foreach (var example in Content
+                            .Where(mediaTypePair => mediaTypePair.Value.Examples != null && mediaTypePair.Value.Examples.Any())
+                            .SelectMany(mediaTypePair => mediaTypePair.Value.Examples))
+                        {
+                            writer.WritePropertyName(example.Key);
+                            writer.WriteV2Examples(writer, example.Value, OpenApiSpecVersion.OpenApi2_0);
+                        }
+
+                        writer.WriteEndObject();
+                    }
+
                     writer.WriteExtensions(mediatype.Value.Extensions, OpenApiSpecVersion.OpenApi2_0);
 
                     foreach (var key in mediatype.Value.Extensions.Keys)

src/Microsoft.OpenApi/Writers/IOpenApiWriter.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using Json.Schema;
+using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Writers
 {
@@ -99,5 +100,13 @@ public interface IOpenApiWriter
         /// <param name="reference"></param>
         /// <param name="version"></param>
         void WriteJsonSchemaReference(IOpenApiWriter writer, Uri reference, OpenApiSpecVersion version);
+
+        /// <summary>
+        /// Writes out existing examples in a mediatype object
+        /// </summary>
+        /// <param name="writer"></param>
+        /// <param name="example"></param>
+        /// <param name="version"></param>
+        void WriteV2Examples(IOpenApiWriter writer, OpenApiExample example, OpenApiSpecVersion version);
     }
 }

src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs

@@ -602,6 +602,29 @@ public void WriteJsonSchemaReference(IOpenApiWriter writer, Uri reference, OpenA
             this.WriteProperty(OpenApiConstants.DollarRef, referenceItem);
             WriteEndObject();
         }
+
+        /// <inheritdoc/>
+        public void WriteV2Examples(IOpenApiWriter writer, OpenApiExample example, OpenApiSpecVersion version)
+        {
+            writer.WriteStartObject();
+
+            // summary
+            writer.WriteProperty(OpenApiConstants.Summary, example.Summary);
+
+            // description
+            writer.WriteProperty(OpenApiConstants.Description, example.Description);
+
+            // value
+            writer.WriteOptionalObject(OpenApiConstants.Value, example.Value, (w, v) => w.WriteAny(v));
+
+            // externalValue
+            writer.WriteProperty(OpenApiConstants.ExternalValue, example.ExternalValue);
+
+            // extensions
+            writer.WriteExtensions(example.Extensions, version);
+
+            writer.WriteEndObject();
+        }
     }
 
     internal class FindJsonSchemaRefs : OpenApiVisitorBase

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

@@ -30,6 +30,7 @@
     <ItemGroup>
         <ProjectReference Include="..\..\src\Microsoft.OpenApi\Microsoft.OpenApi.csproj" />
         <ProjectReference Include="..\..\src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj" />
+        <ProjectReference Include="..\Microsoft.OpenApi.Tests\Microsoft.OpenApi.Tests.csproj" />
     </ItemGroup>
 
 </Project>