chore: adds experimental attribute for new deep copy apis

Signed-off-by: Vincent Biret <vibiret@microsoft.com>

Author: baywet

src/Microsoft.OpenApi/Attributes/ExperimentalAttribute.cs

@@ -0,0 +1,46 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+#if !NET8_0_OR_GREATER
+namespace System.Diagnostics.CodeAnalysis
+{
+    /// <summary>
+    /// Indicates that an API is experimental and may change in the future.
+    /// </summary>
+    [AttributeUsage(
+        AttributeTargets.Assembly |
+        AttributeTargets.Module |
+        AttributeTargets.Class |
+        AttributeTargets.Struct |
+        AttributeTargets.Enum |
+        AttributeTargets.Constructor |
+        AttributeTargets.Method |
+        AttributeTargets.Property |
+        AttributeTargets.Field |
+        AttributeTargets.Event |
+        AttributeTargets.Interface |
+        AttributeTargets.Delegate,
+        Inherited = false)]
+    internal sealed class ExperimentalAttribute : Attribute
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ExperimentalAttribute"/> class.
+        /// </summary>
+        /// <param name="diagnosticId">The diagnostic ID reported when the API is used.</param>
+        public ExperimentalAttribute(string diagnosticId)
+        {
+            DiagnosticId = diagnosticId;
+        }
+
+        /// <summary>
+        /// Gets the diagnostic ID reported when the API is used.
+        /// </summary>
+        public string DiagnosticId { get; }
+
+        /// <summary>
+        /// Gets or sets the URL format used by the diagnostic.
+        /// </summary>
+        public string? UrlFormat { get; set; }
+    }
+}
+#endif

src/Microsoft.OpenApi/Interfaces/IDeepCopyable.cs

@@ -6,11 +6,12 @@ namespace Microsoft.OpenApi;
 /// Interface for deep copyable objects.
 /// </summary>
 /// <typeparam name="T">The type of the resulting object.</typeparam>
+[System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
 public interface IDeepCopyable<out T>
 {
     /// <summary>
     /// Create a deep copy of the current instance.
     /// </summary>
+    [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
     T CreateDeepCopy();
 }
-

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

@@ -9,7 +9,7 @@
         <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)','net8.0'))">true</IsAotCompatible>
         <!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->
         <EmbedUntrackedSources>true</EmbedUntrackedSources>
-        <NoWarn>NU5048</NoWarn>
+        <NoWarn>$(NoWarn);NU5048;OPENAPI001</NoWarn>
         <Nullable>enable</Nullable>
         <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>

src/Microsoft.OpenApi/Models/OpenApiCallback.cs

@@ -114,6 +114,7 @@ public IOpenApiCallback CreateShallowCopy()
             return new OpenApiCallback(this);
         }
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
         public IOpenApiCallback CreateDeepCopy()
         {
             return new OpenApiDeepCopyContext().Copy(this);

src/Microsoft.OpenApi/Models/OpenApiComponents.cs

@@ -97,6 +97,7 @@ public OpenApiComponents(OpenApiComponents? components)
         }
 
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
         public OpenApiComponents CreateDeepCopy()
         {
             return new OpenApiDeepCopyContext().Copy(this);

src/Microsoft.OpenApi/Models/OpenApiContact.cs

@@ -48,6 +48,7 @@ public OpenApiContact(OpenApiContact contact)
             Extensions = contact?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(contact.Extensions) : null;
         }
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
         public OpenApiContact CreateDeepCopy()
         {
             return new OpenApiDeepCopyContext().Copy(this);

src/Microsoft.OpenApi/Models/OpenApiDiscriminator.cs

@@ -47,6 +47,7 @@ public OpenApiDiscriminator(OpenApiDiscriminator discriminator)
         }
 
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
         public OpenApiDiscriminator CreateDeepCopy()
         {
             return new OpenApiDeepCopyContext().Copy(this);

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -155,6 +155,7 @@ public OpenApiDocument(OpenApiDocument? document)
         }
 
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
         public OpenApiDocument CreateDeepCopy()
         {
             return new OpenApiDeepCopyContext().Copy(this);

src/Microsoft.OpenApi/Models/OpenApiEncoding.cs

@@ -97,6 +97,7 @@ public OpenApiEncoding(OpenApiEncoding encoding)
         }
 
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
         public OpenApiEncoding CreateDeepCopy()
         {
             return new OpenApiDeepCopyContext().Copy(this);

src/Microsoft.OpenApi/Models/OpenApiExample.cs

@@ -136,6 +136,7 @@ public IOpenApiExample CreateShallowCopy()
             return new OpenApiExample(this);
         }
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.Experimental("OPENAPI001")]
         public IOpenApiExample CreateDeepCopy()
         {
             return new OpenApiDeepCopyContext().Copy(this);