docs: adds considerations for why the target is readonly

baywet · baywet · commit 92877e08d568 · 2025-02-04T12:36:42.000-05:00
Signed-off-by: Vincent Biret &lt;vibiret@microsoft.com&gt;
diff --git a/src/Microsoft.OpenApi/Models/References/BaseOpenApiReferenceHolder.cs b/src/Microsoft.OpenApi/Models/References/BaseOpenApiReferenceHolder.cs
@@ -11,7 +11,7 @@ namespace Microsoft.OpenApi.Models.References;
 public abstract class BaseOpenApiReferenceHolder<T, V> : IOpenApiReferenceHolder<T, V> where T : class, IOpenApiReferenceable, V where V : IOpenApiSerializable
 {
     /// <summary>
-    /// The resolved target object.
+    /// The resolved target object. This should remain readonly, otherwise mutating the reference will have side effects.
     /// </summary>
     protected readonly T _target;
     /// <inheritdoc/>

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ namespace Microsoft.OpenApi.Models.References;`
`11`	`11`	`public abstract class BaseOpenApiReferenceHolder<T, V> : IOpenApiReferenceHolder<T, V> where T : class, IOpenApiReferenceable, V where V : IOpenApiSerializable`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`		`- /// The resolved target object.`
	`14`	`+ /// The resolved target object. This should remain readonly, otherwise mutating the reference will have side effects.`
`15`	`15`	`/// </summary>`
`16`	`16`	`protected readonly T _target;`
`17`	`17`	`/// <inheritdoc/>`