Remove KeyComparer property and related functionality from OpenApiWriterSettings

Co-authored-by: baywet <[email protected]>

Author: Copilot

src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs

@@ -419,13 +419,6 @@ private static void WriteCollectionInternal<T>(
             writer.WriteStartArray();
             if (elements != null)
             {
-                var settings = writer.GetSettings();
-
-                if (settings?.KeyComparer is IComparer<T> typedComparer)
-                {
-                    elements = elements.Sort(typedComparer);
-                }
-
                 foreach (var item in elements)
                 {
                     if (item != null)
@@ -464,12 +457,6 @@ private static void WriteMapInternal<T>(
 
             if (elements != null)
             {
-                var settings = writer.GetSettings();
-                if (settings?.KeyComparer != null)
-                {
-                    elements = elements.Sort(settings.KeyComparer); // sort using custom comparer
-                }
-
                 foreach (var item in elements)
                 {
                     writer.WritePropertyName(item.Key);

src/Microsoft.OpenApi/Writers/OpenApiWriterSettings.cs

@@ -1,6 +1,4 @@
-using System.Collections.Generic;
-
-namespace Microsoft.OpenApi
+namespace Microsoft.OpenApi
 {
     /// <summary>
     /// Configuration settings to control how OpenAPI documents are written
@@ -23,10 +21,5 @@ internal bool ShouldInlineReference(OpenApiReference reference)
             return (reference.IsLocal && InlineLocalReferences)
                              || (reference.IsExternal && InlineExternalReferences);
         }
-
-        /// <summary>  
-        /// Specifies a comparer used to sort string-based collection keys, such as components or tags.
-        /// </summary>  
-        public IComparer<string>? KeyComparer { get; set; }
     }
 }

test/Microsoft.OpenApi.Tests/Extensions/CollectionExtensionsTests.cs

@@ -132,74 +132,6 @@ public class CollectionExtensionsTests
             }
         };
 
-        [Theory]
-        [MemberData(nameof(OpenApiSpecVersions))]
-        public async Task SortOpenApiDocumentUsingCustomComparerSucceeds(OpenApiSpecVersion version)
-        {
-            // Arrange
-            var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var settings = new OpenApiWriterSettings
-            {
-                KeyComparer = StringComparer.OrdinalIgnoreCase
-            };
-            var writer = new OpenApiYamlWriter(outputStringWriter, settings);
-
-            // Act
-            Document.SerializeAs(version, writer);
-            await writer.FlushAsync();
-
-            // Assert
-            await Verifier.Verify(outputStringWriter).UseParameters(version);
-        }
-
-        [Fact]
-        public async Task SortHashSetsWorks()
-        {
-            // Arrange
-            var expected = @"required:
-  - id
-  - name
-  - tag";
-            var schema = new OpenApiSchema
-            {
-                Required = new HashSet<string> { "tag", "id", "name" },
-            };
-
-            var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
-            var settings = new OpenApiWriterSettings
-            {
-                KeyComparer = StringComparer.OrdinalIgnoreCase
-            };
-            var writer = new OpenApiYamlWriter(outputStringWriter, settings);
-
-            // Act
-            schema.SerializeAsV3(writer);
-            await writer.FlushAsync();
-            var sortedString = outputStringWriter.ToString();
-
-            // Assert
-            Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), sortedString.MakeLineBreaksEnvironmentNeutral());
-        }
-
-        [Fact]
-        public void SortTagsByNameUsingComparerWorks()
-        {
-            // Arrange
-            var tags = new HashSet<OpenApiTag>
-            {
-                new() { Name = "three" },
-                new() { Name = "two" },
-                new() { Name = "one" }
-            };
-
-            // Act
-            var sortedTags = tags.Sort(new OpenApiTagNameComparer());
-
-            // Assert
-            Assert.Equal(3, sortedTags.Count);
-            Assert.True(sortedTags[0].Name == "one");
-        }
-
         public static TheoryData<OpenApiSpecVersion> OpenApiSpecVersions()
         {
             var values = new TheoryData<OpenApiSpecVersion>();
@@ -210,12 +142,4 @@ public static TheoryData<OpenApiSpecVersion> OpenApiSpecVersions()
             return values;
         }
     }
-
-    public class OpenApiTagNameComparer : IComparer<OpenApiTag>
-    {
-        public int Compare(OpenApiTag tag1, OpenApiTag tag2)
-        {
-            return string.Compare(tag1.Name, tag2.Name, StringComparison.OrdinalIgnoreCase);
-        }
-    }
 }

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

@@ -1594,7 +1594,6 @@ namespace Microsoft.OpenApi
         public OpenApiWriterSettings() { }
         public bool InlineExternalReferences { get; set; }
         public bool InlineLocalReferences { get; set; }
-        public System.Collections.Generic.IComparer<string>? KeyComparer { get; set; }
     }
     public class OpenApiXml : Microsoft.OpenApi.IOpenApiElement, Microsoft.OpenApi.IOpenApiExtensible, Microsoft.OpenApi.IOpenApiSerializable
     {