Merge pull request #2977 from microsoft/feat/license-identifier-to-v2

feat: serialize license identifier as extension for earlier versions

Author: baywet

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

@@ -230,6 +230,11 @@ public static class OpenApiConstants
         /// </summary>
         public const string Identifier = "identifier";
 
+        /// <summary>
+        /// Field: x-oai-license-identifier
+        /// </summary>
+        public const string OaiLicenseIdentifier = "x-oai-license-identifier";
+
         /// <summary>
         /// Field: Namespace
         /// </summary>

src/Microsoft.OpenApi/Models/OpenApiLicense.cs

@@ -63,6 +63,7 @@ public virtual void SerializeAsV31(IOpenApiWriter writer)
         public virtual void SerializeAsV3(IOpenApiWriter writer)
         {
             WriteInternal(writer, OpenApiSpecVersion.OpenApi3_0);
+            writer.WriteProperty(OpenApiConstants.OaiLicenseIdentifier, Identifier);
             writer.WriteEndObject();
         }
 
@@ -72,6 +73,7 @@ public virtual void SerializeAsV3(IOpenApiWriter writer)
         public virtual void SerializeAsV2(IOpenApiWriter writer)
         {
             WriteInternal(writer, OpenApiSpecVersion.OpenApi2_0);
+            writer.WriteProperty(OpenApiConstants.OaiLicenseIdentifier, Identifier);
             writer.WriteEndObject();
         }
 

src/Microsoft.OpenApi/PublicAPI.Unshipped.txt

@@ -1 +1,2 @@
 #nullable enable
+const Microsoft.OpenApi.OpenApiConstants.OaiLicenseIdentifier = "x-oai-license-identifier" -> string!

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

@@ -148,6 +148,25 @@ public async Task SerializeLicenseWithIdentifierAsJsonWorks()
             Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
         }
 
+        [Theory]
+        [InlineData(OpenApiSpecVersion.OpenApi3_0)]
+        [InlineData(OpenApiSpecVersion.OpenApi2_0)]
+        public async Task SerializeLicenseWithIdentifierAsJsonWorksForV3AndV2(OpenApiSpecVersion version)
+        {
+            // Arrange
+            var expected =
+                @"{
+  ""name"": ""Apache 2.0"",
+  ""x-oai-license-identifier"": ""Apache-2.0""
+}";
+
+            // Act
+            var actual = await LicenseWithIdentifier.SerializeAsJsonAsync(version);
+
+            // Assert
+            Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
+        }
+
         [Fact]
         public async Task SerializeLicenseWithIdentifierAsYamlWorks()
         {
@@ -161,5 +180,21 @@ public async Task SerializeLicenseWithIdentifierAsYamlWorks()
             // Assert
             Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
         }
+
+        [Theory]
+        [InlineData(OpenApiSpecVersion.OpenApi3_0)]
+        [InlineData(OpenApiSpecVersion.OpenApi2_0)]
+        public async Task SerializeLicenseWithIdentifierAsYamlWorksForV3AndV2(OpenApiSpecVersion version)
+        {
+            // Arrange
+            var expected = @"name: Apache 2.0
+x-oai-license-identifier: Apache-2.0";
+
+            // Act
+            var actual = await LicenseWithIdentifier.SerializeAsYamlAsync(version);
+
+            // Assert
+            Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
+        }
     }
 }