Merge pull request #1752 from dldl-cmd/1506_securityRequirement_securityScheme_serialization

Fix securityScheme/securityRequirement serialization

Author: MaggieKimani1

src/Microsoft.OpenApi/Models/OpenApiReference.cs

@@ -148,13 +148,6 @@ public void SerializeAsV3(IOpenApiWriter writer)
                 return;
             }
 
-            if (Type == ReferenceType.SecurityScheme)
-            {
-                // Write the string as property name
-                writer.WritePropertyName(ReferenceV3);
-                return;
-            }
-
             writer.WriteStartObject();
 
             // $ref

src/Microsoft.OpenApi/Models/OpenApiSecurityRequirement.cs

@@ -50,7 +50,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
                     continue;
                 }
 
-                securityScheme.SerializeAsV3(writer);
+                writer.WritePropertyName(securityScheme.Reference.ReferenceV3);
 
                 writer.WriteStartArray();
 

test/Microsoft.OpenApi.Tests/Models/OpenApiSecurityRequirementTests.SerializeSecurityRequirementAsV3JsonWorksAsync_produceTerseOutput=False.verified.txt

@@ -0,0 +1,12 @@
+{
+  "scheme1": [
+    "scope1",
+    "scope2",
+    "scope3"
+  ],
+  "scheme2": [
+    "scope4",
+    "scope5"
+  ],
+  "scheme3": [ ]
+}

test/Microsoft.OpenApi.Tests/Models/OpenApiSecurityRequirementTests.SerializeSecurityRequirementAsV3JsonWorksAsync_produceTerseOutput=True.verified.txt

@@ -0,0 +1 @@
+{"scheme1":["scope1","scope2","scope3"],"scheme2":["scope4","scope5"],"scheme3":[ ]}

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

@@ -3,9 +3,14 @@
 
 using System;
 using System.Collections.Generic;
+using System.Globalization;
+using System.IO;
+using System.Threading.Tasks;
 using FluentAssertions;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Writers;
+using VerifyXunit;
 using Xunit;
 
 namespace Microsoft.OpenApi.Tests.Models
@@ -95,6 +100,23 @@ public void SerializeBasicSecurityRequirementAsV3JsonWorks()
             actual.Should().Be(expected);
         }
 
+        [Theory]
+        [InlineData(true)]
+        [InlineData(false)]
+        public async Task SerializeSecurityRequirementAsV3JsonWorksAsync(bool produceTerseOutput)
+        {
+            // Arrange
+            var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
+            var writer = new OpenApiJsonWriter(outputStringWriter, new() { Terse = produceTerseOutput });
+
+            // Act
+            SecurityRequirementWithReferencedSecurityScheme.SerializeAsV3(writer);
+            writer.Flush();
+
+            // Assert
+            await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
+        }
+
         [Fact]
         public void SerializeSecurityRequirementWithReferencedSecuritySchemeAsV3JsonWorks()
         {

test/Microsoft.OpenApi.Tests/Models/OpenApiSecuritySchemeTests.SerializeReferencedSecuritySchemeAsV3JsonWorksAsync_produceTerseOutput=False.verified.txt

@@ -1,3 +1,3 @@
 {
-  "sampleSecurityScheme": null
+  "$ref": "sampleSecurityScheme"
 }

test/Microsoft.OpenApi.Tests/Models/OpenApiSecuritySchemeTests.SerializeReferencedSecuritySchemeAsV3JsonWorksAsync_produceTerseOutput=True.verified.txt

@@ -1 +1 @@
-{"sampleSecurityScheme":null}
+{"$ref":"sampleSecurityScheme"}

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

@@ -314,12 +314,7 @@ public async Task SerializeReferencedSecuritySchemeAsV3JsonWorksAsync(bool produ
             var writer = new OpenApiJsonWriter(outputStringWriter, new() { Terse = produceTerseOutput });
 
             // Act
-            // Add dummy start object, value, and end object to allow SerializeAsV3 to output security scheme
-            // as property name.
-            writer.WriteStartObject();
             ReferencedSecurityScheme.SerializeAsV3(writer);
-            writer.WriteNull();
-            writer.WriteEndObject();
             writer.Flush();
 
             // Assert