fix: tag, response, and security scheme shallow copy

Signed-off-by: Vincent Biret <[email protected]>
microsoft · Jan 30, 2025 · 7ac149c · 7ac149c
1 parent 9af6f30
commit 7ac149c
Show file tree

Hide file tree

Showing 10 changed files with 91 additions and 27 deletions.
diff --git a/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiResponse.cs b/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiResponse.cs
@@ -7,7 +7,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;
 /// Defines the base properties for the response object.
 /// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
 /// </summary>
-public interface IOpenApiResponse : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
+public interface IOpenApiResponse : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiResponse>
 {
     /// <summary>
     /// Maps a header name to its definition.

diff --git a/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiSecurityScheme.cs b/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiSecurityScheme.cs
@@ -8,7 +8,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;
 /// Defines the base properties for the security scheme object.
 /// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
 /// </summary>
-public interface IOpenApiSecurityScheme : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
+public interface IOpenApiSecurityScheme : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiSecurityScheme>
 {
     /// <summary>
     /// REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".

diff --git a/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiTag.cs b/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiTag.cs
@@ -6,7 +6,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;
 /// Defines the base properties for the path item object.
 /// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
 /// </summary>
-public interface IOpenApiTag : IOpenApiSerializable, IOpenApiReadOnlyExtensible, IOpenApiReadOnlyDescribedElement
+public interface IOpenApiTag : IOpenApiSerializable, IOpenApiReadOnlyExtensible, IOpenApiReadOnlyDescribedElement, IShallowCopyable<IOpenApiTag>
 {
     /// <summary>
     /// The name of the tag.

diff --git a/src/Microsoft.OpenApi/Models/OpenApiResponse.cs b/src/Microsoft.OpenApi/Models/OpenApiResponse.cs
@@ -38,14 +38,14 @@ public OpenApiResponse() { }
         /// <summary>
         /// Initializes a copy of <see cref="IOpenApiResponse"/> object
         /// </summary>
-        public OpenApiResponse(IOpenApiResponse response)
+        internal OpenApiResponse(IOpenApiResponse response)
         {
             Utils.CheckArgumentNull(response);
-            Description = response?.Description ?? Description;
-            Headers = response?.Headers != null ? new Dictionary<string, IOpenApiHeader>(response.Headers) : null;
-            Content = response?.Content != null ? new Dictionary<string, OpenApiMediaType>(response.Content) : null;
-            Links = response?.Links != null ? new Dictionary<string, IOpenApiLink>(response.Links) : null;
-            Extensions = response?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(response.Extensions) : null;
+            Description = response.Description ?? Description;
+            Headers = response.Headers != null ? new Dictionary<string, IOpenApiHeader>(response.Headers) : null;
+            Content = response.Content != null ? new Dictionary<string, OpenApiMediaType>(response.Content) : null;
+            Links = response.Links != null ? new Dictionary<string, IOpenApiLink>(response.Links) : null;
+            Extensions = response.Extensions != null ? new Dictionary<string, IOpenApiExtension>(response.Extensions) : null;
         }
 
         /// <summary>
@@ -164,5 +164,11 @@ public void SerializeAsV2(IOpenApiWriter writer)
 
             writer.WriteEndObject();
         }
+
+        /// <inheritdoc/>
+        public IOpenApiResponse CreateShallowCopy()
+        {
+            return new OpenApiResponse(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/OpenApiSecurityScheme.cs b/src/Microsoft.OpenApi/Models/OpenApiSecurityScheme.cs
@@ -50,7 +50,7 @@ public OpenApiSecurityScheme() { }
         /// <summary>
         /// Initializes a copy of <see cref="IOpenApiSecurityScheme"/> object
         /// </summary>
-        public OpenApiSecurityScheme(IOpenApiSecurityScheme securityScheme)
+        internal OpenApiSecurityScheme(IOpenApiSecurityScheme securityScheme)
         {
             Utils.CheckArgumentNull(securityScheme);
             Type = securityScheme?.Type;
@@ -229,5 +229,11 @@ private static void WriteOAuthFlowForV2(IOpenApiWriter writer, string flowValue,
             // scopes
             writer.WriteOptionalMap(OpenApiConstants.Scopes, flow.Scopes, (w, s) => w.WriteValue(s));
         }
+
+        /// <inheritdoc/>
+        public IOpenApiSecurityScheme CreateShallowCopy()
+        {
+            return new OpenApiSecurityScheme(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/OpenApiTag.cs b/src/Microsoft.OpenApi/Models/OpenApiTag.cs
@@ -34,12 +34,13 @@ public OpenApiTag() { }
         /// <summary>
         /// Initializes a copy of an <see cref="IOpenApiTag"/> object
         /// </summary>
-        public OpenApiTag(IOpenApiTag tag)
+        internal OpenApiTag(IOpenApiTag tag)
         {
-            Name = tag?.Name ?? Name;
-            Description = tag?.Description ?? Description;
-            ExternalDocs = tag?.ExternalDocs != null ? new(tag.ExternalDocs) : null;
-            Extensions = tag?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(tag.Extensions) : null;
+            Utils.CheckArgumentNull(tag);
+            Name = tag.Name ?? Name;
+            Description = tag.Description ?? Description;
+            ExternalDocs = tag.ExternalDocs != null ? new(tag.ExternalDocs) : null;
+            Extensions = tag.Extensions != null ? new Dictionary<string, IOpenApiExtension>(tag.Extensions) : null;
         }
 
         /// <summary>
@@ -101,5 +102,11 @@ public void SerializeAsV2(IOpenApiWriter writer)
 
             writer.WriteEndObject();
         }
+
+        /// <inheritdoc/>
+        public IOpenApiTag CreateShallowCopy()
+        {
+            return new OpenApiTag(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiResponseReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiResponseReference.cs
@@ -25,6 +25,14 @@ public class OpenApiResponseReference : BaseOpenApiReferenceHolder<OpenApiRespon
         /// </param>
         public OpenApiResponseReference(string referenceId, OpenApiDocument hostDocument, string externalResource = null):base(referenceId, hostDocument, ReferenceType.Response, externalResource)
         {
+        }
+        /// <summary>
+        /// Copy constructor
+        /// </summary>
+        /// <param name="openApiResponseReference">The reference to copy</param>
+        private OpenApiResponseReference(OpenApiResponseReference openApiResponseReference):base(openApiResponseReference)
+        {
+
         }
 
         internal OpenApiResponseReference(OpenApiResponse target, string referenceId):base(target, referenceId, ReferenceType.Response)
@@ -61,5 +69,11 @@ public override IOpenApiResponse CopyReferenceAsTargetElementWithOverrides(IOpen
         {
             return source is OpenApiResponse ? new OpenApiResponse(this) : source;
         }
+
+        /// <inheritdoc/>
+        public IOpenApiResponse CreateShallowCopy()
+        {
+            return new OpenApiResponseReference(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiSecuritySchemeReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiSecuritySchemeReference.cs
@@ -21,6 +21,14 @@ public class OpenApiSecuritySchemeReference : BaseOpenApiReferenceHolder<OpenApi
         /// <param name="externalResource">The externally referenced file.</param>
         public OpenApiSecuritySchemeReference(string referenceId, OpenApiDocument hostDocument, string externalResource = null):base(referenceId, hostDocument, ReferenceType.SecurityScheme, externalResource)
         {
+        }
+        /// <summary>
+        /// Copy constructor
+        /// </summary>
+        /// <param name="openApiSecuritySchemeReference">The reference to copy</param>
+        private OpenApiSecuritySchemeReference(OpenApiSecuritySchemeReference openApiSecuritySchemeReference):base(openApiSecuritySchemeReference)
+        {
+
         }
         internal OpenApiSecuritySchemeReference(OpenApiSecurityScheme target, string referenceId):base(target, referenceId, ReferenceType.SecurityScheme)
         {
@@ -68,5 +76,11 @@ public override IOpenApiSecurityScheme CopyReferenceAsTargetElementWithOverrides
         {
             return source is OpenApiSecurityScheme ? new OpenApiSecurityScheme(this) : source;
         }
+
+        /// <inheritdoc/>
+        public IOpenApiSecurityScheme CreateShallowCopy()
+        {
+            return new OpenApiSecuritySchemeReference(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiTagReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiTagReference.cs
@@ -33,6 +33,14 @@ public override OpenApiTag Target
         /// <param name="hostDocument">The host OpenAPI document.</param>
         public OpenApiTagReference(string referenceId, OpenApiDocument hostDocument):base(referenceId, hostDocument, ReferenceType.Tag)
         {
+        }
+        /// <summary>
+        /// Copy constructor
+        /// </summary>
+        /// <param name="openApiTagReference">The reference to copy</param>
+        private OpenApiTagReference(OpenApiTagReference openApiTagReference):base(openApiTagReference)
+        {
+
         }
 
         internal OpenApiTagReference(OpenApiTag target, string referenceId):base(target, referenceId, ReferenceType.Tag)
@@ -58,5 +66,11 @@ public override IOpenApiTag CopyReferenceAsTargetElementWithOverrides(IOpenApiTa
         {
             return source is OpenApiTag ? new OpenApiTag(this) : source;
         }
+
+        /// <inheritdoc/>
+        public IOpenApiTag CreateShallowCopy()
+        {
+            return new OpenApiTagReference(this);
+        }
     }
 }