fix: shallow copy for parameter link path item and request body

baywet · baywet · commit 9af6f30719c7 · 2025-01-30T09:27:41.000-05:00
Signed-off-by: Vincent Biret &lt;vibiret@microsoft.com&gt;
diff --git a/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiLink.cs b/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiLink.cs
@@ -7,7 +7,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;
 /// Defines the base properties for the link object.
 /// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
 /// </summary>
-public interface IOpenApiLink : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
+public interface IOpenApiLink : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiLink>
 {
     /// <summary>
     /// A relative or absolute reference to an OAS operation.
diff --git a/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiParameter.cs b/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiParameter.cs
@@ -8,7 +8,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;
 /// Defines the base properties for the parameter object.
 /// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
 /// </summary>
-public interface IOpenApiParameter : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
+public interface IOpenApiParameter : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiParameter>
 {
     /// <summary>
     /// REQUIRED. The name of the parameter. Parameter names are case sensitive.
diff --git a/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiPathItem.cs b/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiPathItem.cs
@@ -8,7 +8,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 IOpenApiPathItem : IOpenApiDescribedElement, IOpenApiSummarizedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
+public interface IOpenApiPathItem : IOpenApiDescribedElement, IOpenApiSummarizedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiPathItem>
 {
     /// <summary>
     /// Gets the definition of operations on this path.
diff --git a/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiRequestBody.cs b/src/Microsoft.OpenApi/Models/Interfaces/IOpenApiRequestBody.cs
@@ -8,7 +8,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;
 /// Defines the base properties for the request body object.
 /// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
 /// </summary>
-public interface IOpenApiRequestBody : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
+public interface IOpenApiRequestBody : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiRequestBody>
 {
     /// <summary>
     /// Determines if the request body is required in the request. Defaults to false.
diff --git a/src/Microsoft.OpenApi/Models/OpenApiLink.cs b/src/Microsoft.OpenApi/Models/OpenApiLink.cs
@@ -43,7 +43,7 @@ public OpenApiLink() { }
         /// <summary>
         /// Initializes a copy of an <see cref="OpenApiLink"/> object
         /// </summary>
-        public OpenApiLink(IOpenApiLink link)
+        internal OpenApiLink(IOpenApiLink link)
         {
             Utils.CheckArgumentNull(link);
             OperationRef = link.OperationRef ?? OperationRef;
@@ -102,5 +102,11 @@ public void SerializeAsV2(IOpenApiWriter writer)
         {
             // Link object does not exist in V2.
         }
+
+        /// <inheritdoc/>
+        public IOpenApiLink CreateShallowCopy()
+        {
+            return new OpenApiLink(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/OpenApiOperation.cs b/src/Microsoft.OpenApi/Models/OpenApiOperation.cs
@@ -120,22 +120,23 @@ public OpenApiOperation() { }
         /// <summary>
         /// Initializes a copy of an <see cref="OpenApiOperation"/> object
         /// </summary>
-        public OpenApiOperation(OpenApiOperation? operation)
+        public OpenApiOperation(OpenApiOperation operation)
         {
-            Tags = operation?.Tags != null ? new List<OpenApiTagReference>(operation.Tags) : null;
-            Summary = operation?.Summary ?? Summary;
-            Description = operation?.Description ?? Description;
-            ExternalDocs = operation?.ExternalDocs != null ? new(operation?.ExternalDocs) : null;
-            OperationId = operation?.OperationId ?? OperationId;
-            Parameters = operation?.Parameters != null ? new List<IOpenApiParameter>(operation.Parameters) : null;
-            RequestBody = operation?.RequestBody != null ? new OpenApiRequestBody(operation?.RequestBody) : null;
-            Responses = operation?.Responses != null ? new(operation?.Responses) : null;
-            Callbacks = operation?.Callbacks != null ? new Dictionary<string, IOpenApiCallback>(operation.Callbacks) : null;
-            Deprecated = operation?.Deprecated ?? Deprecated;
-            Security = operation?.Security != null ? new List<OpenApiSecurityRequirement>(operation.Security) : null;
-            Servers = operation?.Servers != null ? new List<OpenApiServer>(operation.Servers) : null;
-            Extensions = operation?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(operation.Extensions) : null;
-            Annotations = operation?.Annotations != null ? new Dictionary<string, object>(operation.Annotations) : null;
+            Utils.CheckArgumentNull(operation);
+            Tags = operation.Tags != null ? new List<OpenApiTagReference>(operation.Tags) : null;
+            Summary = operation.Summary ?? Summary;
+            Description = operation.Description ?? Description;
+            ExternalDocs = operation.ExternalDocs != null ? new(operation.ExternalDocs) : null;
+            OperationId = operation.OperationId ?? OperationId;
+            Parameters = operation.Parameters != null ? new List<IOpenApiParameter>(operation.Parameters) : null;
+            RequestBody = operation.RequestBody?.CreateShallowCopy();
+            Responses = operation.Responses != null ? new(operation.Responses) : null;
+            Callbacks = operation.Callbacks != null ? new Dictionary<string, IOpenApiCallback>(operation.Callbacks) : null;
+            Deprecated = operation.Deprecated;
+            Security = operation.Security != null ? new List<OpenApiSecurityRequirement>(operation.Security) : null;
+            Servers = operation.Servers != null ? new List<OpenApiServer>(operation.Servers) : null;
+            Extensions = operation.Extensions != null ? new Dictionary<string, IOpenApiExtension>(operation.Extensions) : null;
+            Annotations = operation.Annotations != null ? new Dictionary<string, object>(operation.Annotations) : null;
         }
 
         /// <summary>
diff --git a/src/Microsoft.OpenApi/Models/OpenApiParameter.cs b/src/Microsoft.OpenApi/Models/OpenApiParameter.cs
@@ -80,7 +80,7 @@ public OpenApiParameter() { }
         /// <summary>
         /// Initializes a clone instance of <see cref="OpenApiParameter"/> object
         /// </summary>
-        public OpenApiParameter(IOpenApiParameter parameter)
+        internal OpenApiParameter(IOpenApiParameter parameter)
         {
             Utils.CheckArgumentNull(parameter);
             Name = parameter.Name ?? Name;
@@ -302,6 +302,12 @@ public void SerializeAsV2(IOpenApiWriter writer)
                 _ => (ParameterStyle?)ParameterStyle.Simple,
             };
         }
+
+        /// <inheritdoc/>
+        public IOpenApiParameter CreateShallowCopy()
+        {
+            return new OpenApiParameter(this);
+        }
     }
 
     /// <summary>
diff --git a/src/Microsoft.OpenApi/Models/OpenApiPathItem.cs b/src/Microsoft.OpenApi/Models/OpenApiPathItem.cs
@@ -52,7 +52,7 @@ public OpenApiPathItem() { }
         /// <summary>
         /// Initializes a clone of an <see cref="OpenApiPathItem"/> object
         /// </summary>
-        public OpenApiPathItem(IOpenApiPathItem pathItem)
+        internal OpenApiPathItem(IOpenApiPathItem pathItem)
         {
             Utils.CheckArgumentNull(pathItem);
             Summary = pathItem?.Summary ?? Summary;
@@ -151,5 +151,11 @@ internal virtual void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersio
 
             writer.WriteEndObject();
         }
+
+        /// <inheritdoc/>
+        public IOpenApiPathItem CreateShallowCopy()
+        {
+            return new OpenApiPathItem(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/OpenApiRequestBody.cs b/src/Microsoft.OpenApi/Models/OpenApiRequestBody.cs
@@ -38,7 +38,7 @@ public OpenApiRequestBody() { }
         /// <summary>
         /// Initializes a copy instance of an <see cref="IOpenApiRequestBody"/> object
         /// </summary>
-        public OpenApiRequestBody(IOpenApiRequestBody requestBody)
+        internal OpenApiRequestBody(IOpenApiRequestBody requestBody)
         {
             Utils.CheckArgumentNull(requestBody);
             Description = requestBody?.Description ?? Description;
@@ -150,5 +150,11 @@ public IEnumerable<IOpenApiParameter> ConvertToFormDataParameters(IOpenApiWriter
                 };
             }
         }
+
+        /// <inheritdoc/>
+        public IOpenApiRequestBody CreateShallowCopy()
+        {
+            return new OpenApiRequestBody(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiLinkReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiLinkReference.cs
@@ -80,5 +80,11 @@ public override IOpenApiLink CopyReferenceAsTargetElementWithOverrides(IOpenApiL
         {
             return source is OpenApiLink ? new OpenApiLink(this) : source;
         }
+
+        /// <inheritdoc/>
+        public IOpenApiLink CreateShallowCopy()
+        {
+            return new OpenApiLinkReference(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiParameterReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiParameterReference.cs
@@ -96,5 +96,11 @@ public override IOpenApiParameter CopyReferenceAsTargetElementWithOverrides(IOpe
         {
             return source is OpenApiParameter ? new OpenApiParameter(this) : source;
         }
+
+        /// <inheritdoc/>
+        public IOpenApiParameter CreateShallowCopy()
+        {
+            return new OpenApiParameterReference(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiPathItemReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiPathItemReference.cs
@@ -28,6 +28,15 @@ public OpenApiPathItemReference(string referenceId, OpenApiDocument hostDocument
         {
         }
 
+        /// <summary>
+        /// Copy constructor
+        /// </summary>
+        /// <param name="pathItem">The reference to copy</param>
+        private OpenApiPathItemReference(OpenApiPathItemReference pathItem):base(pathItem)
+        {
+            
+        }
+
         internal OpenApiPathItemReference(OpenApiPathItem target, string referenceId):base(target, referenceId, ReferenceType.PathItem)
         {
         }
@@ -76,6 +85,12 @@ public override IOpenApiPathItem CopyReferenceAsTargetElementWithOverrides(IOpen
             return source is OpenApiPathItem ? new OpenApiPathItem(this) : source;
         }
 
+        /// <inheritdoc/>
+        public IOpenApiPathItem CreateShallowCopy()
+        {
+            return new OpenApiPathItemReference(this);
+        }
+
         /// <inheritdoc/>
         public override void SerializeAsV2(IOpenApiWriter writer)
         {
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiRequestBodyReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiRequestBodyReference.cs
@@ -27,6 +27,14 @@ public class OpenApiRequestBodyReference : BaseOpenApiReferenceHolder<OpenApiReq
         /// </param>
         public OpenApiRequestBodyReference(string referenceId, OpenApiDocument hostDocument, string externalResource = null):base(referenceId, hostDocument, ReferenceType.RequestBody, externalResource)
         {
+        }
+        /// <summary>
+        /// Copy constructor
+        /// </summary>
+        /// <param name="openApiRequestBodyReference">The reference to copy</param>
+        private OpenApiRequestBodyReference(OpenApiRequestBodyReference openApiRequestBodyReference):base(openApiRequestBodyReference)
+        {
+            
         }
         internal OpenApiRequestBodyReference(OpenApiRequestBody target, string referenceId):base(target, referenceId, ReferenceType.RequestBody)
         {
@@ -89,5 +97,11 @@ public IEnumerable<IOpenApiParameter> ConvertToFormDataParameters(IOpenApiWriter
 
             return Content.First().Value.Schema.Properties.Select(x => new OpenApiParameterReference(x.Key, Reference.HostDocument));
         }
+
+        /// <inheritdoc/>
+        public IOpenApiRequestBody CreateShallowCopy()
+        {
+            return new OpenApiRequestBodyReference(this);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Utils.cs b/src/Microsoft.OpenApi/Utils.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 
 namespace Microsoft.OpenApi
@@ -19,7 +20,11 @@ internal static class Utils
         /// <param name="parameterName">The input parameter name.</param>
         /// <returns>The input value.</returns>
         internal static T CheckArgumentNull<T>(
+#if NET5_0_OR_GREATER
+            [NotNull] T value,
+#else
             T value,
+#endif
             [CallerArgumentExpression(nameof(value))] string parameterName = "")
         {
             return value ?? throw new ArgumentNullException(parameterName, $"Value cannot be null: {parameterName}");
@@ -32,7 +37,11 @@ internal static T CheckArgumentNull<T>(
         /// <param name="parameterName">The input parameter name.</param>
         /// <returns>The input value.</returns>
         internal static string CheckArgumentNullOrEmpty(
+#if NET5_0_OR_GREATER
+            [NotNull] string value,
+#else
             string value,
+#endif
             [CallerArgumentExpression(nameof(value))] string parameterName = "")
         {
             return string.IsNullOrWhiteSpace(value) ? throw new ArgumentNullException(parameterName, $"Value cannot be null or empty: {parameterName}") : value;
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 link 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 IOpenApiLink : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible`
	`10`	`+public interface IOpenApiLink : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiLink>`
`11`	`11`	`{`
`12`	`12`	`/// <summary>`
`13`	`13`	`/// A relative or absolute reference to an OAS operation.`
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 parameter 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 IOpenApiParameter : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible`
	`11`	`+public interface IOpenApiParameter : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible, IShallowCopyable<IOpenApiParameter>`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`	`14`	`/// REQUIRED. The name of the parameter. Parameter names are case sensitive.`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public OpenApiLink() { }`
`43`	`43`	`/// <summary>`
`44`	`44`	`/// Initializes a copy of an <see cref="OpenApiLink"/> object`
`45`	`45`	`/// </summary>`
`46`		`- public OpenApiLink(IOpenApiLink link)`
	`46`	`+ internal OpenApiLink(IOpenApiLink link)`
`47`	`47`	`{`
`48`	`48`	`Utils.CheckArgumentNull(link);`
`49`	`49`	`OperationRef = link.OperationRef ?? OperationRef;`
`@@ -102,5 +102,11 @@ public void SerializeAsV2(IOpenApiWriter writer)`
`102`	`102`	`{`
`103`	`103`	`// Link object does not exist in V2.`
`104`	`104`	`}`
	`105`	`+`
	`106`	`+ /// <inheritdoc/>`
	`107`	`+ public IOpenApiLink CreateShallowCopy()`
	`108`	`+ {`
	`109`	`+ return new OpenApiLink(this);`
	`110`	`+ }`
`105`	`111`	`}`
`106`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public OpenApiPathItem() { }`
`52`	`52`	`/// <summary>`
`53`	`53`	`/// Initializes a clone of an <see cref="OpenApiPathItem"/> object`
`54`	`54`	`/// </summary>`
`55`		`- public OpenApiPathItem(IOpenApiPathItem pathItem)`
	`55`	`+ internal OpenApiPathItem(IOpenApiPathItem pathItem)`
`56`	`56`	`{`
`57`	`57`	`Utils.CheckArgumentNull(pathItem);`
`58`	`58`	`Summary = pathItem?.Summary ?? Summary;`
`@@ -151,5 +151,11 @@ internal virtual void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersio`
`151`	`151`
`152`	`152`	`writer.WriteEndObject();`
`153`	`153`	`}`
	`154`	`+`
	`155`	`+ /// <inheritdoc/>`
	`156`	`+ public IOpenApiPathItem CreateShallowCopy()`
	`157`	`+ {`
	`158`	`+ return new OpenApiPathItem(this);`
	`159`	`+ }`
`154`	`160`	`}`
`155`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public OpenApiRequestBody() { }`
`38`	`38`	`/// <summary>`
`39`	`39`	`/// Initializes a copy instance of an <see cref="IOpenApiRequestBody"/> object`
`40`	`40`	`/// </summary>`
`41`		`- public OpenApiRequestBody(IOpenApiRequestBody requestBody)`
	`41`	`+ internal OpenApiRequestBody(IOpenApiRequestBody requestBody)`
`42`	`42`	`{`
`43`	`43`	`Utils.CheckArgumentNull(requestBody);`
`44`	`44`	`Description = requestBody?.Description ?? Description;`
`@@ -150,5 +150,11 @@ public IEnumerable<IOpenApiParameter> ConvertToFormDataParameters(IOpenApiWriter`
`150`	`150`	`};`
`151`	`151`	`}`
`152`	`152`	`}`
	`153`	`+`
	`154`	`+ /// <inheritdoc/>`
	`155`	`+ public IOpenApiRequestBody CreateShallowCopy()`
	`156`	`+ {`
	`157`	`+ return new OpenApiRequestBody(this);`
	`158`	`+ }`
`153`	`159`	`}`
`154`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,5 +80,11 @@ public override IOpenApiLink CopyReferenceAsTargetElementWithOverrides(IOpenApiL`
`80`	`80`	`{`
`81`	`81`	`return source is OpenApiLink ? new OpenApiLink(this) : source;`
`82`	`82`	`}`
	`83`	`+`
	`84`	`+ /// <inheritdoc/>`
	`85`	`+ public IOpenApiLink CreateShallowCopy()`
	`86`	`+ {`
	`87`	`+ return new OpenApiLinkReference(this);`
	`88`	`+ }`
`83`	`89`	`}`
`84`	`90`	`}`