fix: tag, response, and security scheme shallow copy

baywet · baywet · commit 7ac149c70d69 · 2025-01-30T09:39:30.000-05:00
Signed-off-by: Vincent Biret &lt;vibiret@microsoft.com&gt;
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);
+        }
     }
 }
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;`
`7`	`7`	`/// Defines the base properties for the response object.`
`8`	`8`	`/// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.`
`9`	`9`	`/// </summary>`
`10`		`-public interface IOpenApiResponse : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible`
	`10`	`+public interface IOpenApiResponse : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiResponse>`
`11`	`11`	`{`
`12`	`12`	`/// <summary>`
`13`	`13`	`/// Maps a header name to its definition.`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;`
`8`	`8`	`/// Defines the base properties for the security scheme object.`
`9`	`9`	`/// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.`
`10`	`10`	`/// </summary>`
`11`		`-public interface IOpenApiSecurityScheme : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible`
	`11`	`+public interface IOpenApiSecurityScheme : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiSecurityScheme>`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`	`14`	`/// REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;`
`6`	`6`	`/// Defines the base properties for the path item object.`
`7`	`7`	`/// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.`
`8`	`8`	`/// </summary>`
`9`		`-public interface IOpenApiTag : IOpenApiSerializable, IOpenApiReadOnlyExtensible, IOpenApiReadOnlyDescribedElement`
	`9`	`+public interface IOpenApiTag : IOpenApiSerializable, IOpenApiReadOnlyExtensible, IOpenApiReadOnlyDescribedElement, IShallowCopyable<IOpenApiTag>`
`10`	`10`	`{`
`11`	`11`	`/// <summary>`
`12`	`12`	`/// The name of the tag.`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public OpenApiSecurityScheme() { }`
`50`	`50`	`/// <summary>`
`51`	`51`	`/// Initializes a copy of <see cref="IOpenApiSecurityScheme"/> object`
`52`	`52`	`/// </summary>`
`53`		`- public OpenApiSecurityScheme(IOpenApiSecurityScheme securityScheme)`
	`53`	`+ internal OpenApiSecurityScheme(IOpenApiSecurityScheme securityScheme)`
`54`	`54`	`{`
`55`	`55`	`Utils.CheckArgumentNull(securityScheme);`
`56`	`56`	`Type = securityScheme?.Type;`
`@@ -229,5 +229,11 @@ private static void WriteOAuthFlowForV2(IOpenApiWriter writer, string flowValue,`
`229`	`229`	`// scopes`
`230`	`230`	`writer.WriteOptionalMap(OpenApiConstants.Scopes, flow.Scopes, (w, s) => w.WriteValue(s));`
`231`	`231`	`}`
	`232`	`+`
	`233`	`+ /// <inheritdoc/>`
	`234`	`+ public IOpenApiSecurityScheme CreateShallowCopy()`
	`235`	`+ {`
	`236`	`+ return new OpenApiSecurityScheme(this);`
	`237`	`+ }`
`232`	`238`	`}`
`233`	`239`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,12 +34,13 @@ public OpenApiTag() { }`
`34`	`34`	`/// <summary>`
`35`	`35`	`/// Initializes a copy of an <see cref="IOpenApiTag"/> object`
`36`	`36`	`/// </summary>`
`37`		`- public OpenApiTag(IOpenApiTag tag)`
	`37`	`+ internal OpenApiTag(IOpenApiTag tag)`
`38`	`38`	`{`
`39`		`- Name = tag?.Name ?? Name;`
`40`		`- Description = tag?.Description ?? Description;`
`41`		`- ExternalDocs = tag?.ExternalDocs != null ? new(tag.ExternalDocs) : null;`
`42`		`- Extensions = tag?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(tag.Extensions) : null;`
	`39`	`+ Utils.CheckArgumentNull(tag);`
	`40`	`+ Name = tag.Name ?? Name;`
	`41`	`+ Description = tag.Description ?? Description;`
	`42`	`+ ExternalDocs = tag.ExternalDocs != null ? new(tag.ExternalDocs) : null;`
	`43`	`+ Extensions = tag.Extensions != null ? new Dictionary<string, IOpenApiExtension>(tag.Extensions) : null;`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`/// <summary>`
`@@ -101,5 +102,11 @@ public void SerializeAsV2(IOpenApiWriter writer)`
`101`	`102`
`102`	`103`	`writer.WriteEndObject();`
`103`	`104`	`}`
	`105`	`+`
	`106`	`+ /// <inheritdoc/>`
	`107`	`+ public IOpenApiTag CreateShallowCopy()`
	`108`	`+ {`
	`109`	`+ return new OpenApiTag(this);`
	`110`	`+ }`
`104`	`111`	`}`
`105`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,14 @@ public class OpenApiResponseReference : BaseOpenApiReferenceHolder<OpenApiRespon`
`25`	`25`	`/// </param>`
`26`	`26`	`public OpenApiResponseReference(string referenceId, OpenApiDocument hostDocument, string externalResource = null):base(referenceId, hostDocument, ReferenceType.Response, externalResource)`
`27`	`27`	`{`
	`28`	`+ }`
	`29`	`+ /// <summary>`
	`30`	`+ /// Copy constructor`
	`31`	`+ /// </summary>`
	`32`	`+ /// <param name="openApiResponseReference">The reference to copy</param>`
	`33`	`+ private OpenApiResponseReference(OpenApiResponseReference openApiResponseReference):base(openApiResponseReference)`
	`34`	`+ {`
	`35`	`+`
`28`	`36`	`}`
`29`	`37`
`30`	`38`	`internal OpenApiResponseReference(OpenApiResponse target, string referenceId):base(target, referenceId, ReferenceType.Response)`
`@@ -61,5 +69,11 @@ public override IOpenApiResponse CopyReferenceAsTargetElementWithOverrides(IOpen`
`61`	`69`	`{`
`62`	`70`	`return source is OpenApiResponse ? new OpenApiResponse(this) : source;`
`63`	`71`	`}`
	`72`	`+`
	`73`	`+ /// <inheritdoc/>`
	`74`	`+ public IOpenApiResponse CreateShallowCopy()`
	`75`	`+ {`
	`76`	`+ return new OpenApiResponseReference(this);`
	`77`	`+ }`
`64`	`78`	`}`
`65`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,14 @@ public class OpenApiSecuritySchemeReference : BaseOpenApiReferenceHolder<OpenApi`
`21`	`21`	`/// <param name="externalResource">The externally referenced file.</param>`
`22`	`22`	`public OpenApiSecuritySchemeReference(string referenceId, OpenApiDocument hostDocument, string externalResource = null):base(referenceId, hostDocument, ReferenceType.SecurityScheme, externalResource)`
`23`	`23`	`{`
	`24`	`+ }`
	`25`	`+ /// <summary>`
	`26`	`+ /// Copy constructor`
	`27`	`+ /// </summary>`
	`28`	`+ /// <param name="openApiSecuritySchemeReference">The reference to copy</param>`
	`29`	`+ private OpenApiSecuritySchemeReference(OpenApiSecuritySchemeReference openApiSecuritySchemeReference):base(openApiSecuritySchemeReference)`
	`30`	`+ {`
	`31`	`+`
`24`	`32`	`}`
`25`	`33`	`internal OpenApiSecuritySchemeReference(OpenApiSecurityScheme target, string referenceId):base(target, referenceId, ReferenceType.SecurityScheme)`
`26`	`34`	`{`
`@@ -68,5 +76,11 @@ public override IOpenApiSecurityScheme CopyReferenceAsTargetElementWithOverrides`
`68`	`76`	`{`
`69`	`77`	`return source is OpenApiSecurityScheme ? new OpenApiSecurityScheme(this) : source;`
`70`	`78`	`}`
	`79`	`+`
	`80`	`+ /// <inheritdoc/>`
	`81`	`+ public IOpenApiSecurityScheme CreateShallowCopy()`
	`82`	`+ {`
	`83`	`+ return new OpenApiSecuritySchemeReference(this);`
	`84`	`+ }`
`71`	`85`	`}`
`72`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,14 @@ public override OpenApiTag Target`
`33`	`33`	`/// <param name="hostDocument">The host OpenAPI document.</param>`
`34`	`34`	`public OpenApiTagReference(string referenceId, OpenApiDocument hostDocument):base(referenceId, hostDocument, ReferenceType.Tag)`
`35`	`35`	`{`
	`36`	`+ }`
	`37`	`+ /// <summary>`
	`38`	`+ /// Copy constructor`
	`39`	`+ /// </summary>`
	`40`	`+ /// <param name="openApiTagReference">The reference to copy</param>`
	`41`	`+ private OpenApiTagReference(OpenApiTagReference openApiTagReference):base(openApiTagReference)`
	`42`	`+ {`
	`43`	`+`
`36`	`44`	`}`
`37`	`45`
`38`	`46`	`internal OpenApiTagReference(OpenApiTag target, string referenceId):base(target, referenceId, ReferenceType.Tag)`
`@@ -58,5 +66,11 @@ public override IOpenApiTag CopyReferenceAsTargetElementWithOverrides(IOpenApiTa`
`58`	`66`	`{`
`59`	`67`	`return source is OpenApiTag ? new OpenApiTag(this) : source;`
`60`	`68`	`}`
	`69`	`+`
	`70`	`+ /// <inheritdoc/>`
	`71`	`+ public IOpenApiTag CreateShallowCopy()`
	`72`	`+ {`
	`73`	`+ return new OpenApiTagReference(this);`
	`74`	`+ }`
`61`	`75`	`}`
`62`	`76`	`}`