chore: rename setting; make extension class/methods internal

Author: MaggieKimani1

src/Microsoft.OpenApi/Extensions/CollectionExtensions.cs

@@ -7,12 +7,12 @@ namespace Microsoft.OpenApi
     /// <summary>
     /// Dictionary extension methods
     /// </summary>
-    public static class CollectionExtensions
+    internal static class CollectionExtensions
     {
         /// <summary>
         /// Returns a new dictionary with entries sorted by key using a custom comparer.
         /// </summary>
-        public static IDictionary<TKey, TValue> Sort<TKey, TValue>(
+        internal static IDictionary<TKey, TValue> Sort<TKey, TValue>(
             this IDictionary<TKey, TValue> source,
             IComparer<TKey> comparer)
             where TKey : notnull
@@ -33,7 +33,7 @@ public static IDictionary<TKey, TValue> Sort<TKey, TValue>(
         /// <summary>
         /// Sorts any IEnumerable<T> using the specified comparer and returns a List</T>.
         /// </summary>
-        public static List<T> Sort<T>(this IEnumerable<T> source, IComparer<T> comparer)
+        internal static List<T> Sort<T>(this IEnumerable<T> source, IComparer<T> comparer)
         {
 #if NET7_0_OR_GREATER
         ArgumentNullException.ThrowIfNull(source);

src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs

@@ -421,7 +421,7 @@ private static void WriteCollectionInternal<T>(
             {
                 var settings = writer.GetSettings();
 
-                if (settings?.Comparer is IComparer<T> typedComparer)
+                if (settings?.KeyComparer is IComparer<T> typedComparer)
                 {
                     elements = elements.Sort(typedComparer);
                 }
@@ -465,9 +465,9 @@ private static void WriteMapInternal<T>(
             if (elements != null)
             {
                 var settings = writer.GetSettings();
-                if (settings?.Comparer != null)
+                if (settings?.KeyComparer != null)
                 {
-                    elements = elements.Sort(settings.Comparer); // sort using custom comparer
+                    elements = elements.Sort(settings.KeyComparer); // sort using custom comparer
                 }
 
                 foreach (var item in elements)

src/Microsoft.OpenApi/Writers/OpenApiWriterSettings.cs

@@ -25,8 +25,8 @@ internal bool ShouldInlineReference(OpenApiReference reference)
         }
 
         /// <summary>  
-        /// Custom comparer for sorting collections.  
+        /// Specifies a comparer used to sort string-based collection keys, such as components or tags.
         /// </summary>  
-        public IComparer<string>? Comparer { get; set; }
+        public IComparer<string>? KeyComparer { get; set; }
     }
 }

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

@@ -140,7 +140,7 @@ public async Task SortOpenApiDocumentUsingCustomComparerSucceeds(OpenApiSpecVers
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
             var settings = new OpenApiWriterSettings
             {
-                Comparer = StringComparer.OrdinalIgnoreCase
+                KeyComparer = StringComparer.OrdinalIgnoreCase
             };
             var writer = new OpenApiYamlWriter(outputStringWriter, settings);
 
@@ -168,7 +168,7 @@ public async Task SortHashSetsWorks()
             var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
             var settings = new OpenApiWriterSettings
             {
-                Comparer = StringComparer.OrdinalIgnoreCase
+                KeyComparer = StringComparer.OrdinalIgnoreCase
             };
             var writer = new OpenApiYamlWriter(outputStringWriter, settings);
 

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

@@ -29,12 +29,6 @@ namespace Microsoft.OpenApi
         public override string Expression { get; }
         public string? Fragment { get; }
     }
-    public static class CollectionExtensions
-    {
-        public static System.Collections.Generic.List<T> Sort<T>(this System.Collections.Generic.IEnumerable<T> source, System.Collections.Generic.IComparer<T> comparer) { }
-        public static System.Collections.Generic.IDictionary<TKey, TValue> Sort<TKey, TValue>(this System.Collections.Generic.IDictionary<TKey, TValue> source, System.Collections.Generic.IComparer<TKey> comparer)
-            where TKey :  notnull { }
-    }
     public class CompositeExpression : Microsoft.OpenApi.RuntimeExpression
     {
         public System.Collections.Generic.List<Microsoft.OpenApi.RuntimeExpression> ContainedExpressions;
@@ -1598,9 +1592,9 @@ namespace Microsoft.OpenApi
     public class OpenApiWriterSettings
     {
         public OpenApiWriterSettings() { }
-        public System.Collections.Generic.IComparer<string>? Comparer { get; set; }
         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
     {