Merged master

darrelmiller · darrelmiller · commit 35a9fc5787aa · 2020-11-22T17:38:02.000-05:00
diff --git a/build.cmd b/build.cmd
@@ -2,16 +2,16 @@
 Echo Building Microsoft.OpenApi 
 
 SET PROJ=%~dp0src\Microsoft.OpenApi\Microsoft.OpenApi.csproj 
-dotnet build %PROJ% /t:restore /p:Configuration=Release
-dotnet build %PROJ% /t:build /p:Configuration=Release
-dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
+dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
+dotnet msbuild %PROJ% /t:build /p:Configuration=Release
+dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
 Echo Building Microsoft.OpenApi.Readers
 
 SET PROJ=%~dp0src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj 
-dotnet build %PROJ% /t:restore /p:Configuration=Release
-dotnet build %PROJ% /t:build /p:Configuration=Release
-dotnet build %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
+dotnet msbuild %PROJ% /t:restore /p:Configuration=Release
+dotnet msbuild %PROJ% /t:build /p:Configuration=Release
+dotnet msbuild %PROJ% /t:pack /p:Configuration=Release;PackageOutputPath=%~dp0artifacts
 
 goto :end
 :error
diff --git a/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.2.0-preview.3</Version>
+        <Version>1.2.3</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
diff --git a/src/Microsoft.OpenApi.Readers/OpenApiTextReaderReader.cs b/src/Microsoft.OpenApi.Readers/OpenApiTextReaderReader.cs
@@ -37,15 +37,15 @@ public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)
         {
             YamlDocument yamlDocument;
 
-            // Parse the YAML/JSON
+            // Parse the YAML/JSON text in the TextReader into the YamlDocument
             try
             {
                 yamlDocument = LoadYamlDocument(input);
             }
             catch (YamlException ex)
             {
                 diagnostic = new OpenApiDiagnostic();
-                diagnostic.Errors.Add(new OpenApiError($"#char={ex.Start.Line}", ex.Message));
+                diagnostic.Errors.Add(new OpenApiError($"#line={ex.Start.Line}", ex.Message));
                 return new OpenApiDocument();
             }
 
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiOperationDeserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiOperationDeserializer.cs
@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using System.Linq;
+using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
@@ -164,6 +165,7 @@ private static OpenApiRequestBody CreateFormBody(ParsingContext context, List<Op
                         {
                             var schema = v.Schema;
                             schema.Description = v.Description;
+                            schema.Extensions = v.Extensions;
                             return schema;
                         }),
                     Required = new HashSet<string>(formParameters.Where(p => p.Required).Select(p => p.Name))
@@ -201,9 +203,11 @@ internal static OpenApiRequestBody CreateRequestBody(
                     v => new OpenApiMediaType
                     {
                         Schema = bodyParameter.Schema
-                    })
+                    }),
+                Extensions = bodyParameter.Extensions
             };
 
+            requestBody.Extensions[OpenApiConstants.BodyName] = new OpenApiString(bodyParameter.Name);
             return requestBody;
         }
 
diff --git a/src/Microsoft.OpenApi/Any/OpenApiString.cs b/src/Microsoft.OpenApi/Any/OpenApiString.cs
@@ -10,12 +10,21 @@ public class OpenApiString : OpenApiPrimitive<string>
     {
         private bool isExplicit;
 
+        /// <summary>
+        /// Initializes the <see cref="OpenApiString"/> class.
+        /// </summary>
+        /// <param name="value"></param>
+        public OpenApiString(string value)
+            : this(value, false)
+        {
+        }
+        
         /// <summary>
         /// Initializes the <see cref="OpenApiString"/> class.
         /// </summary>
         /// <param name="value"></param>
         /// <param name="isExplicit">Used to indicate if a string is quoted.</param>
-        public OpenApiString(string value, bool isExplicit = false)
+        public OpenApiString(string value, bool isExplicit)
             : base(value)
         {
             this.isExplicit = isExplicit;
diff --git a/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs b/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs
@@ -41,6 +41,26 @@ public static void SerializeAsYaml<T>(this T element, Stream stream, OpenApiSpec
             element.Serialize(stream, specVersion, OpenApiFormat.Yaml);
         }
 
+        /// <summary>
+        /// Serializes the <see cref="IOpenApiSerializable"/> to the Open API document using
+        /// the given stream, specification version and the format.
+        /// </summary>
+        /// <typeparam name="T">the <see cref="IOpenApiSerializable"/></typeparam>
+        /// <param name="element">The Open API element.</param>
+        /// <param name="stream">The given stream.</param>
+        /// <param name="specVersion">The Open API specification version.</param>
+        /// <param name="format">The output format (JSON or YAML).</param>
+        /// <param name="settings">Provide configuration settings for controlling writing output</param>
+        public static void Serialize<T>(
+            this T element,
+            Stream stream,
+            OpenApiSpecVersion specVersion,
+            OpenApiFormat format)
+            where T : IOpenApiSerializable
+        {
+            element.Serialize(stream, specVersion, format, null);
+        }
+
         /// <summary>
         /// Serializes the <see cref="IOpenApiSerializable"/> to the Open API document using
         /// the given stream, specification version and the format.
@@ -56,7 +76,7 @@ public static void Serialize<T>(
             Stream stream,
             OpenApiSpecVersion specVersion,
             OpenApiFormat format, 
-            OpenApiWriterSettings settings = null)
+            OpenApiWriterSettings settings)
             where T : IOpenApiSerializable
         {
             if (stream == null)
diff --git a/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj b/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj
@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.2.0-preview.3</Version>
+        <Version>1.2.3</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>
diff --git a/src/Microsoft.OpenApi/Models/OpenApiConstants.cs b/src/Microsoft.OpenApi/Models/OpenApiConstants.cs
@@ -560,6 +560,11 @@ public static class OpenApiConstants
         /// </summary>
         public const string DefaultDescription = "Default Description";
 
+        /// <summary>
+        /// Field: BodyName extensions
+        /// </summary>
+        public const string BodyName = "x-bodyName";
+
         /// <summary>
         /// Field: version3_0_0
         /// </summary>
diff --git a/src/Microsoft.OpenApi/Models/OpenApiOperation.cs b/src/Microsoft.OpenApi/Models/OpenApiOperation.cs
@@ -228,29 +228,44 @@ public void SerializeAsV2(IOpenApiWriter writer)
                 {
                     foreach (var property in RequestBody.Content.First().Value.Schema.Properties)
                     {
+                        var paramName = property.Key;
+                        var paramSchema = property.Value;
+                        if (paramSchema.Type == "string" && paramSchema.Format == "binary") {
+                            paramSchema.Type = "file";
+                            paramSchema.Format = null;
+                        }
                         parameters.Add(
                             new OpenApiFormDataParameter
                             {
                                 Description = property.Value.Description,
                                 Name = property.Key,
                                 Schema = property.Value,
                                 Required = RequestBody.Content.First().Value.Schema.Required.Contains(property.Key)
+
                             });
                     }
                 }
                 else
                 {
                     var content = RequestBody.Content.Values.FirstOrDefault();
+
                     var bodyParameter = new OpenApiBodyParameter
                     {
                         Description = RequestBody.Description,
                         // V2 spec actually allows the body to have custom name.
-                        // Our library does not support this at the moment.
+                        // To allow round-tripping we use an extension to hold the name
                         Name = "body",
                         Schema = content?.Schema ?? new OpenApiSchema(),
-                        Required = RequestBody.Required
+                        Required = RequestBody.Required,
+                        Extensions = RequestBody.Extensions.ToDictionary(k => k.Key, v => v.Value)  // Clone extensions so we can remove the x-bodyName extensions from the output V2 model.
                     };
 
+                    if (bodyParameter.Extensions.ContainsKey(OpenApiConstants.BodyName))
+                    {
+                        bodyParameter.Name = (RequestBody.Extensions[OpenApiConstants.BodyName] as OpenApiString)?.Value ?? "body";
+                        bodyParameter.Extensions.Remove(OpenApiConstants.BodyName);
+                    }
+                    
                     parameters.Add(bodyParameter);
                 }
             }
diff --git a/src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.cs b/src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.cs
@@ -52,6 +52,7 @@ public override void Visit(OpenApiComponents components)
             ResolveMap(components.Examples);
             ResolveMap(components.Schemas);
             ResolveMap(components.SecuritySchemes);
+            ResolveMap(components.Headers);
         }
 
         public override void Visit(IDictionary<string, OpenApiCallback> callbacks)
@@ -99,6 +100,15 @@ public override void Visit(OpenApiResponses responses)
             ResolveMap(responses);
         }
 
+        /// <summary>
+        /// Resolve all references to headers
+        /// </summary>
+        /// <param name="headers"></param>
+        public override void Visit(IDictionary<string, OpenApiHeader> headers)
+        {
+            ResolveMap(headers);
+        }
+
         /// <summary>
         /// Resolve all references to SecuritySchemes
         /// </summary>
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs b/src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs
@@ -10,12 +10,20 @@ namespace Microsoft.OpenApi.Writers
     /// </summary>
     public class OpenApiJsonWriter : OpenApiWriterBase
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OpenApiJsonWriter"/> class.
+        /// </summary>
+        /// <param name="textWriter">The text writer.</param>
+        public OpenApiJsonWriter(TextWriter textWriter) : base(textWriter, null)
+        {
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="OpenApiJsonWriter"/> class.
         /// </summary>
         /// <param name="textWriter">The text writer.</param>
         /// <param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
-        public OpenApiJsonWriter(TextWriter textWriter, OpenApiWriterSettings settings = null) : base(textWriter, settings)
+        public OpenApiJsonWriter(TextWriter textWriter, OpenApiWriterSettings settings) : base(textWriter, settings)
         {
         }
 
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs b/src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs
@@ -40,21 +40,21 @@ public abstract class OpenApiWriterBase : IOpenApiWriter
         /// Initializes a new instance of the <see cref="OpenApiWriterBase"/> class.
         /// </summary>
         /// <param name="textWriter">The text writer.</param>
-        public OpenApiWriterBase(TextWriter textWriter)
+        public OpenApiWriterBase(TextWriter textWriter) : this(textWriter, null)
         {
-            Writer = textWriter;
-            Writer.NewLine = "\n";
-
-            Scopes = new Stack<Scope>();
         }
 
         /// <summary>
-        /// 
+        /// Initializes a new instance of the <see cref="OpenApiWriterBase"/> class.
         /// </summary>
         /// <param name="textWriter"></param>
         /// <param name="settings"></param>
-        public OpenApiWriterBase(TextWriter textWriter, OpenApiWriterSettings settings = null) : this(textWriter)
+        public OpenApiWriterBase(TextWriter textWriter, OpenApiWriterSettings settings) 
         {
+            Writer = textWriter;
+            Writer.NewLine = "\n";
+
+            Scopes = new Stack<Scope>();
             if (settings == null)
             {
                 settings = new OpenApiWriterSettings();
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiYamlWriter.cs b/src/Microsoft.OpenApi/Writers/OpenApiYamlWriter.cs
@@ -10,12 +10,20 @@ namespace Microsoft.OpenApi.Writers
     /// </summary>
     public class OpenApiYamlWriter : OpenApiWriterBase
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OpenApiYamlWriter"/> class.
+        /// </summary>
+        /// <param name="textWriter">The text writer.</param>
+        public OpenApiYamlWriter(TextWriter textWriter) : this(textWriter, null)
+        {
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="OpenApiYamlWriter"/> class.
         /// </summary>
         /// <param name="textWriter">The text writer.</param>
         /// <param name="settings"></param>
-        public OpenApiYamlWriter(TextWriter textWriter, OpenApiWriterSettings settings = null) : base(textWriter, settings)
+        public OpenApiYamlWriter(TextWriter textWriter, OpenApiWriterSettings settings) : base(textWriter, settings)
         {
            
         }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
@@ -150,6 +150,7 @@
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>
       <EmbeddedResource Include="V3Tests\Samples\OpenApiExample\explicitString.yaml" />
+      <EmbeddedResource Include="V3Tests\Samples\OpenApiResponse\responseWithHeaderReference.yaml" />
       <EmbeddedResource Include="V3Tests\Samples\OpenApiInfo\basicInfo.yaml">
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiOperationTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiOperationTests.cs
@@ -7,6 +7,7 @@
 using FluentAssertions;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Extensions;
+using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
 using Microsoft.OpenApi.Readers.V2;
@@ -180,6 +181,9 @@ public class OpenApiOperationTests
                             Type = "object"
                         }
                     }
+                },
+                Extensions = { 
+                    [OpenApiConstants.BodyName] = new OpenApiString("petObject") 
                 }
             },
             Responses = new OpenApiResponses
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiResponseTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiResponseTests.cs
@@ -0,0 +1,33 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System.IO;
+using System.Linq;
+using FluentAssertions;
+using Microsoft.OpenApi.Any;
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Readers.V3;
+using Xunit;
+
+namespace Microsoft.OpenApi.Readers.Tests.V3Tests
+{
+    [Collection("DefaultSettings")]
+    public class OpenApiResponseTests
+    {
+        private const string SampleFolderPath = "V3Tests/Samples/OpenApiResponse/";
+
+        [Fact]
+        public void ResponseWithReferencedHeaderShouldReferenceComponent()
+        {
+            using (var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "responseWithHeaderReference.yaml")))
+            {
+                var openApiDoc = new OpenApiStreamReader().Read(stream, out var diagnostic);
+
+                var response = openApiDoc.Components.Responses["Test"];
+
+                Assert.Same(response.Headers.First().Value, openApiDoc.Components.Headers.First().Value);
+            }
+        }
+    }
+}
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiResponse/responseWithHeaderReference.yaml b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiResponse/responseWithHeaderReference.yaml
@@ -0,0 +1,16 @@
+﻿openapi: 3.0.0
+info:
+  title: Example of response referencing a header
+  version: 1.0.0
+components:
+  headers:
+    X-Test:
+      description: Test
+      schema:
+        type: string
+  responses:
+    Test:
+      description: Test Repsonse
+      headers:
+        X-Test:
+          $ref: '#/components/headers/X-Test'
diff --git a/test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj b/test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj
@@ -10,7 +10,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
-    <PackageReference Include="Newtonsoft.Json" Version="10.0.3" />
+    <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1">
       <PrivateAssets>all</PrivateAssets>

Original file line number	Diff line number	Diff line change
`@@ -37,15 +37,15 @@ public OpenApiDocument Read(TextReader input, out OpenApiDiagnostic diagnostic)`
`37`	`37`	`{`
`38`	`38`	`YamlDocument yamlDocument;`
`39`	`39`
`40`		`- // Parse the YAML/JSON`
	`40`	`+ // Parse the YAML/JSON text in the TextReader into the YamlDocument`
`41`	`41`	`try`
`42`	`42`	`{`
`43`	`43`	`yamlDocument = LoadYamlDocument(input);`
`44`	`44`	`}`
`45`	`45`	`catch (YamlException ex)`
`46`	`46`	`{`
`47`	`47`	`diagnostic = new OpenApiDiagnostic();`
`48`		`- diagnostic.Errors.Add(new OpenApiError($"#char={ex.Start.Line}", ex.Message));`
	`48`	`+ diagnostic.Errors.Add(new OpenApiError($"#line={ex.Start.Line}", ex.Message));`
`49`	`49`	`return new OpenApiDocument();`
`50`	`50`	`}`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -228,29 +228,44 @@ public void SerializeAsV2(IOpenApiWriter writer)`
`228`	`228`	`{`
`229`	`229`	`foreach (var property in RequestBody.Content.First().Value.Schema.Properties)`
`230`	`230`	`{`
	`231`	`+ var paramName = property.Key;`
	`232`	`+ var paramSchema = property.Value;`
	`233`	`+ if (paramSchema.Type == "string" && paramSchema.Format == "binary") {`
	`234`	`+ paramSchema.Type = "file";`
	`235`	`+ paramSchema.Format = null;`
	`236`	`+ }`
`231`	`237`	`parameters.Add(`
`232`	`238`	`new OpenApiFormDataParameter`
`233`	`239`	`{`
`234`	`240`	`Description = property.Value.Description,`
`235`	`241`	`Name = property.Key,`
`236`	`242`	`Schema = property.Value,`
`237`	`243`	`Required = RequestBody.Content.First().Value.Schema.Required.Contains(property.Key)`
	`244`	`+`
`238`	`245`	`});`
`239`	`246`	`}`
`240`	`247`	`}`
`241`	`248`	`else`
`242`	`249`	`{`
`243`	`250`	`var content = RequestBody.Content.Values.FirstOrDefault();`
	`251`	`+`
`244`	`252`	`var bodyParameter = new OpenApiBodyParameter`
`245`	`253`	`{`
`246`	`254`	`Description = RequestBody.Description,`
`247`	`255`	`// V2 spec actually allows the body to have custom name.`
`248`		`- // Our library does not support this at the moment.`
	`256`	`+ // To allow round-tripping we use an extension to hold the name`
`249`	`257`	`Name = "body",`
`250`	`258`	`Schema = content?.Schema ?? new OpenApiSchema(),`
`251`		`- Required = RequestBody.Required`
	`259`	`+ Required = RequestBody.Required,`
	`260`	`+ Extensions = RequestBody.Extensions.ToDictionary(k => k.Key, v => v.Value) // Clone extensions so we can remove the x-bodyName extensions from the output V2 model.`
`252`	`261`	`};`
`253`	`262`
	`263`	`+ if (bodyParameter.Extensions.ContainsKey(OpenApiConstants.BodyName))`
	`264`	`+ {`
	`265`	`+ bodyParameter.Name = (RequestBody.Extensions[OpenApiConstants.BodyName] as OpenApiString)?.Value ?? "body";`
	`266`	`+ bodyParameter.Extensions.Remove(OpenApiConstants.BodyName);`
	`267`	`+ }`
	`268`	`+`
`254`	`269`	`parameters.Add(bodyParameter);`
`255`	`270`	`}`
`256`	`271`	`}`