Add obsoletion attributes and fix CloneFromCopyConstructor

Author: captainsafia

src/Microsoft.OpenApi/Any/OpenApiAnyCloneHelper.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System;
 using System.Diagnostics.CodeAnalysis;
 
 namespace Microsoft.OpenApi.Any
@@ -15,6 +16,7 @@ public class OpenApiAnyCloneHelper
         /// </summary>
         /// <param name="obj">The object instance.</param>
         /// <returns>A clone copy or the object itself.</returns>
+        [Obsolete("Use native AoT-friendly generic overload of CloneFromCopyConstructor instead.")]
         public static IOpenApiAny CloneFromCopyConstructor(IOpenApiAny obj)
         {
             if (obj != null)

src/Microsoft.OpenApi/Extensions/EnumExtensions.cs

@@ -38,6 +38,7 @@ public static T GetAttributeOfType<T>(this Enum enumValue) where T : Attribute
         /// Use <see cref="DisplayAttribute"/> if exists.
         /// Otherwise, use the standard string representation.
         /// </returns>
+        [Obsolete("Use native AoT-friendly type-specific overloads GetDisplayName methods instead.")]
         public static string GetDisplayName(this Enum enumValue)
         {
             var attribute = enumValue.GetAttributeOfType<DisplayAttribute>();
@@ -58,21 +59,21 @@ public static string GetDisplayName(this Enum enumValue)
                 ParameterStyle.SpaceDelimited => "spaceDelimited",
                 ParameterStyle.PipeDelimited => "pipeDelimited",
                 ParameterStyle.DeepObject => "deepObject",
-                _ => parameterStyle.ToString()
+                _ => throw new InvalidOperationException($"Unknown parameter style: {parameterStyle}")
             };
 
         /// <summary>
         /// Gets the enum display for name <see cref="ParameterLocation" /> without the use of reflection. 
         /// </summary>
         /// <param name="parameterLocation">The enum value.</param>
         /// <returns>The display string to use.</returns>
-        internal static string GetDisplayName(this ParameterLocation parameterLocation) => parameterLocation switch
+        public static string GetDisplayName(this ParameterLocation parameterLocation) => parameterLocation switch
             {
                 ParameterLocation.Query => "query",
                 ParameterLocation.Header => "header",
                 ParameterLocation.Path => "path",
                 ParameterLocation.Cookie => "cookie",
-                _ => parameterLocation.ToString()
+                _ => throw new InvalidOperationException($"Unknown parameter location: {parameterLocation}")
             };
 
         /// <summary>
@@ -92,7 +93,7 @@ public static string GetDisplayName(this Enum enumValue)
                 ReferenceType.Link => "links",
                 ReferenceType.Callback => "callbacks",
                 ReferenceType.Tag => "tags",
-                _ => referenceType.ToString()
+                _ => throw new InvalidOperationException($"Unknown reference type: {referenceType}")
             };
 
         /// <summary>
@@ -110,7 +111,7 @@ public static string GetDisplayName(this Enum enumValue)
                 OperationType.Head => "head",
                 OperationType.Patch => "patch",
                 OperationType.Trace => "trace",
-                _ => operationType.ToString()
+                _ => throw new InvalidOperationException($"Unknown operation type: {operationType}")
             };
 
         /// <summary>
@@ -124,7 +125,7 @@ public static string GetDisplayName(this Enum enumValue)
                 SecuritySchemeType.Http => "http",
                 SecuritySchemeType.OAuth2 => "oauth2",
                 SecuritySchemeType.OpenIdConnect => "openIdConnect",
-                _ => securitySchemeType.ToString()
+                _ => throw new InvalidOperationException($"Unknown security scheme type: {securitySchemeType}")
             };
     }
 }

src/Microsoft.OpenApi/Models/OpenApiExample.cs

@@ -66,7 +66,7 @@ public OpenApiExample(OpenApiExample example)
         {
             Summary = example?.Summary ?? Summary;
             Description = example?.Description ?? Description;
-            Value = OpenApiAnyCloneHelper.CloneFromCopyConstructor(example?.Value);
+            Value = OpenApiAnyCloneHelper.CloneFromCopyConstructor<IOpenApiAny>(example?.Value);
             ExternalValue = example?.ExternalValue ?? ExternalValue;
             Extensions = example?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(example.Extensions) : null;
             Reference = example?.Reference != null ? new(example?.Reference) : null;

src/Microsoft.OpenApi/Models/OpenApiHeader.cs

@@ -106,7 +106,7 @@ public OpenApiHeader(OpenApiHeader header)
             Explode = header?.Explode ?? Explode;
             AllowReserved = header?.AllowReserved ?? AllowReserved;
             Schema = header?.Schema != null ? new(header?.Schema) : null;
-            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor(header?.Example);
+            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor<IOpenApiAny>(header?.Example);
             Examples = header?.Examples != null ? new Dictionary<string, OpenApiExample>(header.Examples) : null;
             Content = header?.Content != null ? new Dictionary<string, OpenApiMediaType>(header.Content) : null;
             Extensions = header?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(header.Extensions) : null;

src/Microsoft.OpenApi/Models/OpenApiMediaType.cs

@@ -54,7 +54,7 @@ public OpenApiMediaType() {}
         public OpenApiMediaType(OpenApiMediaType mediaType)
         {
             Schema = mediaType?.Schema != null ? new(mediaType?.Schema) : null;
-            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor(mediaType?.Example);
+            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor<IOpenApiAny>(mediaType?.Example);
             Examples = mediaType?.Examples != null ? new Dictionary<string, OpenApiExample>(mediaType.Examples) : null;
             Encoding = mediaType?.Encoding != null ? new Dictionary<string, OpenApiEncoding>(mediaType.Encoding) : null;
             Extensions = mediaType?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(mediaType.Extensions) : null;

src/Microsoft.OpenApi/Models/OpenApiParameter.cs

@@ -166,7 +166,7 @@ public OpenApiParameter(OpenApiParameter parameter)
             AllowReserved = parameter?.AllowReserved ?? AllowReserved;
             Schema = parameter?.Schema != null ? new(parameter?.Schema) : null;
             Examples = parameter?.Examples != null ? new Dictionary<string, OpenApiExample>(parameter.Examples) : null;
-            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor(parameter?.Example);
+            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor<IOpenApiAny>(parameter?.Example);
             Content = parameter?.Content != null ? new Dictionary<string, OpenApiMediaType>(parameter.Content) : null;
             Extensions = parameter?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(parameter.Extensions) : null;
             AllowEmptyValue = parameter?.AllowEmptyValue ?? AllowEmptyValue;

src/Microsoft.OpenApi/Models/OpenApiSchema.cs

@@ -263,7 +263,7 @@ public OpenApiSchema(OpenApiSchema schema)
             MinLength = schema?.MinLength ?? MinLength;
             Pattern = schema?.Pattern ?? Pattern;
             MultipleOf = schema?.MultipleOf ?? MultipleOf;
-            Default = OpenApiAnyCloneHelper.CloneFromCopyConstructor(schema?.Default);
+            Default = OpenApiAnyCloneHelper.CloneFromCopyConstructor<IOpenApiAny>(schema?.Default);
             ReadOnly = schema?.ReadOnly ?? ReadOnly;
             WriteOnly = schema?.WriteOnly ?? WriteOnly;
             AllOf = schema?.AllOf != null ? new List<OpenApiSchema>(schema.AllOf) : null;
@@ -281,7 +281,7 @@ public OpenApiSchema(OpenApiSchema schema)
             AdditionalPropertiesAllowed = schema?.AdditionalPropertiesAllowed ?? AdditionalPropertiesAllowed;
             AdditionalProperties = schema?.AdditionalProperties != null ? new(schema?.AdditionalProperties) : null;
             Discriminator = schema?.Discriminator != null ? new(schema?.Discriminator) : null;
-            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor(schema?.Example);
+            Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor<IOpenApiAny>(schema?.Example);
             Enum = schema?.Enum != null ? new List<IOpenApiAny>(schema.Enum) : null;
             Nullable = schema?.Nullable ?? Nullable;
             ExternalDocs = schema?.ExternalDocs != null ? new(schema?.ExternalDocs) : null;

src/Microsoft.OpenApi/Models/RuntimeExpressionAnyWrapper.cs

@@ -26,7 +26,7 @@ public RuntimeExpressionAnyWrapper() {}
         /// </summary>
         public RuntimeExpressionAnyWrapper(RuntimeExpressionAnyWrapper runtimeExpressionAnyWrapper)
         {
-            Any = OpenApiAnyCloneHelper.CloneFromCopyConstructor(runtimeExpressionAnyWrapper?.Any);
+            Any = OpenApiAnyCloneHelper.CloneFromCopyConstructor<IOpenApiAny>(runtimeExpressionAnyWrapper?.Any);
             Expression = runtimeExpressionAnyWrapper?.Expression;
         }
 

test/Microsoft.OpenApi.Tests/Attributes/DisplayAttributeTests.cs

@@ -22,7 +22,9 @@ public class DisplayAttributeTests
         [InlineData(ApiLevel.Corporate, "corporate")]
         public void GetDisplayNameExtensionShouldUseDisplayAttribute(ApiLevel apiLevel, string expected)
         {
-            Assert.Equal(expected, apiLevel.GetDisplayName());          
+#pragma warning disable CS0618 // Type or member is obsolete, testing obsolete behavior
+            Assert.Equal(expected, apiLevel.GetDisplayName());
+#pragma warning restore CS0618 // Type or member is obsolete, testing obsolete behavior
         }
     }
 }

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

@@ -22,6 +22,7 @@ namespace Microsoft.OpenApi.Any
     public class OpenApiAnyCloneHelper
     {
         public OpenApiAnyCloneHelper() { }
+        [System.Obsolete("Use native AoT-friendly generic overload of CloneFromCopyConstructor instead.")]
         public static Microsoft.OpenApi.Any.IOpenApiAny CloneFromCopyConstructor(Microsoft.OpenApi.Any.IOpenApiAny obj) { }
         public static Microsoft.OpenApi.Any.IOpenApiAny CloneFromCopyConstructor<T>(T obj)
             where T : Microsoft.OpenApi.Any.IOpenApiAny { }
@@ -250,6 +251,8 @@ namespace Microsoft.OpenApi.Extensions
     {
         public static T GetAttributeOfType<T>(this System.Enum enumValue)
             where T : System.Attribute { }
+        public static string GetDisplayName(this Microsoft.OpenApi.Models.ParameterLocation parameterLocation) { }
+        [System.Obsolete("Use native AoT-friendly type-specific overloads GetDisplayName methods instead.")]
         public static string GetDisplayName(this System.Enum enumValue) { }
     }
     public static class OpenApiElementExtensions