chore: cleans up temporary interface structure for references migration

Signed-off-by: Vincent Biret <[email protected]>

Author: baywet

src/Microsoft.OpenApi/Interfaces/IOpenApiReferenceHolder.cs

@@ -8,22 +8,14 @@ namespace Microsoft.OpenApi.Interfaces
     /// <summary>
     /// A generic interface for OpenApiReferenceable objects that have a target.
     /// </summary>
-    /// <typeparam name="T">Type of the target being referenced</typeparam>
-    public interface IOpenApiReferenceHolder<out T> : IOpenApiReferenceHolder where T : IOpenApiReferenceable
+    /// <typeparam name="T">The type of the target being referenced</typeparam>
+    /// <typeparam name="V">The type of the interface implemented by both the target and the reference type</typeparam>
+    public interface IOpenApiReferenceHolder<out T, V> : IOpenApiReferenceHolder where T : IOpenApiReferenceable, V
     {
         /// <summary>
         /// Gets the resolved target object.
         /// </summary>
         T Target { get; }
-    }
-    /// <summary>
-    /// A generic interface for OpenApiReferenceable objects that have a target.
-    /// </summary>
-    /// <typeparam name="T">The type of the target being referenced</typeparam>
-    /// <typeparam name="V">The type of the interface implemented by both the target and the reference type</typeparam>
-    public interface IOpenApiReferenceHolder<out T, V> : IOpenApiReferenceHolder<T> where T : IOpenApiReferenceable, V
-    {
-        //TODO merge this interface with the previous once all implementations are updated
         /// <summary>
         /// Copy the reference as a target element with overrides.
         /// </summary>
@@ -37,8 +29,7 @@ public interface IOpenApiReferenceHolder : IOpenApiSerializable
         /// <summary>
         /// Indicates if object is populated with data or is just a reference to the data
         /// </summary>
-        bool UnresolvedReference { get; set; }
-        //TODO the UnresolvedReference property setter should be removed and a default implementation that checks whether the target is null for the getter should be provided instead
+        bool UnresolvedReference { get; }
 
         /// <summary>
         /// Reference object.

src/Microsoft.OpenApi/Models/References/BaseOpenApiReferenceHolder.cs

@@ -31,7 +31,6 @@ protected BaseOpenApiReferenceHolder(BaseOpenApiReferenceHolder<T, V> source)
     {
         Utils.CheckArgumentNull(source);
         Reference = source.Reference != null ? new(source.Reference) : null;
-        UnresolvedReference = source.UnresolvedReference;
         //no need to copy summary and description as if they are not overridden, they will be fetched from the target
         //if they are, the reference copy will handle it
     }
@@ -69,7 +68,7 @@ protected BaseOpenApiReferenceHolder(string referenceId, OpenApiDocument hostDoc
         };
     }
     /// <inheritdoc/>
-    public bool UnresolvedReference { get; set; }
+    public bool UnresolvedReference { get => Reference is null || Target is null; }
     /// <inheritdoc/>
     public OpenApiReference Reference { get; set; }
     /// <inheritdoc/>

src/Microsoft.OpenApi/Reader/ParseNodes/MapNode.cs

@@ -124,7 +124,6 @@ public T GetReferencedObject<T>(ReferenceType referenceType, string referenceId,
         {
             return new()
             {
-                UnresolvedReference = true,
                 Reference = Context.VersionService.ConvertToOpenApiReference(referenceId, referenceType, summary, description)
             };
         }

test/Microsoft.OpenApi.Readers.Tests/OpenApiWorkspaceTests/OpenApiWorkspaceStreamTests.cs

@@ -30,7 +30,6 @@ public async Task LoadingDocumentWithResolveAllReferencesShouldLoadDocumentIntoW
                 BaseUrl = new("file://c:\\")
             };
 
-            // Todo: this should be ReadAsync
             var stream = new MemoryStream();
             var doc = """
                       openapi: 3.0.0

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

@@ -225,16 +225,12 @@ namespace Microsoft.OpenApi.Interfaces
     public interface IOpenApiReferenceHolder : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
     {
         Microsoft.OpenApi.Models.OpenApiReference Reference { get; set; }
-        bool UnresolvedReference { get; set; }
+        bool UnresolvedReference { get; }
     }
-    public interface IOpenApiReferenceHolder<out T> : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
-        where out T : Microsoft.OpenApi.Interfaces.IOpenApiReferenceable
-    {
-        T Target { get; }
-    }
-    public interface IOpenApiReferenceHolder<out T, V> : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder<T>, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
+    public interface IOpenApiReferenceHolder<out T, V> : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
         where out T : Microsoft.OpenApi.Interfaces.IOpenApiReferenceable, V
     {
+        T Target { get; }
         V CopyReferenceAsTargetElementWithOverrides(V source);
     }
     public interface IOpenApiReferenceable : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiSerializable { }
@@ -1238,7 +1234,7 @@ namespace Microsoft.OpenApi.Models
 }
 namespace Microsoft.OpenApi.Models.References
 {
-    public abstract class BaseOpenApiReferenceHolder<T, V> : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder<T>, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder<T, V>, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
+    public abstract class BaseOpenApiReferenceHolder<T, V> : Microsoft.OpenApi.Interfaces.IOpenApiElement, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder, Microsoft.OpenApi.Interfaces.IOpenApiReferenceHolder<T, V>, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
         where T :  class, Microsoft.OpenApi.Interfaces.IOpenApiReferenceable, V
         where V : Microsoft.OpenApi.Interfaces.IOpenApiSerializable
     {
@@ -1247,7 +1243,7 @@ namespace Microsoft.OpenApi.Models.References
         protected BaseOpenApiReferenceHolder(string referenceId, Microsoft.OpenApi.Models.OpenApiDocument hostDocument, Microsoft.OpenApi.Models.ReferenceType referenceType, string externalResource = null) { }
         public Microsoft.OpenApi.Models.OpenApiReference Reference { get; set; }
         public virtual T Target { get; }
-        public bool UnresolvedReference { get; set; }
+        public bool UnresolvedReference { get; }
         public abstract V CopyReferenceAsTargetElementWithOverrides(V source);
         public virtual void SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
         public virtual void SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }