Refactor OpenApiDiagnostic out of ParsingContext

src/Microsoft.OpenApi.Readers/Interface/ILog.cs → src/Microsoft.OpenApi.Readers/Interface/IDiagnostic.cs

@@ -3,19 +3,12 @@
 //  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
 // ------------------------------------------------------------
 
-using System.Collections.Generic;
-
 namespace Microsoft.OpenApi.Readers.Interface
 {
     /// <summary>
-    /// Interface for the log
+    /// Interface for the entity containing diagnostic information from the reading process.
     /// </summary>
-    /// <typeparam name="TError">Type of recorded errors</typeparam>
-    public interface ILog<TError>
+    public interface IDiagnostic
     {
-        /// <summary>
-        /// List of recorded errors.
-        /// </summary>
-        IList<TError> Errors { get; set; }
     }
 }

src/Microsoft.OpenApi.Readers/Interface/IOpenApiReader.cs

@@ -3,24 +3,21 @@
 //  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
 // ------------------------------------------------------------
 
-using SharpYaml.Serialization.Logging;
-
 namespace Microsoft.OpenApi.Readers.Interface
 {
     /// <summary>
-    /// Interface for open API readers.
+    /// Interface for Open API readers.
     /// </summary>
     /// <typeparam name="TInput">The type of input to read from.</typeparam>
-    /// <typeparam name="TLog">The type of log for information from reading process.</typeparam>
-    /// <typeparam name="TError">The type of the recorded error from the reading process.</typeparam>
-    public interface IOpenApiReader<TInput, TLog, TError> where TLog : ILog<TError>
+    /// <typeparam name="TDiagnostic">The type of diagnostic for information from reading process.</typeparam>
+    public interface IOpenApiReader<TInput, TDiagnostic> where TDiagnostic : IDiagnostic
     {
         /// <summary>
         /// Reads the input and parses it into an Open API document.
         /// </summary>
         /// <param name="input">The input to read from.</param>
-        /// <param name="log">The log or context containing information from the reading process.</param>
+        /// <param name="diagnostic">The diagnostic entity containing information from the reading process.</param>
         /// <returns>The Open API document.</returns>
-        OpenApiDocument Read(TInput input, out TLog log);
+        OpenApiDocument Read(TInput input, out TDiagnostic diagnostic);
     }
 }

src/Microsoft.OpenApi.Readers/YamlReaders/OpenApiDiagnostic.cs

@@ -0,0 +1,15 @@
+// ------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation.  All rights reserved.
+//  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// ------------------------------------------------------------
+
+using System.Collections.Generic;
+using Microsoft.OpenApi.Readers.Interface;
+
+namespace Microsoft.OpenApi.Readers.YamlReaders
+{
+    public class OpenApiDiagnostic : IDiagnostic
+    {
+        public IList<OpenApiError> Errors { get; set; } = new List<OpenApiError>();
+    }
+}

src/Microsoft.OpenApi.Readers/YamlReaders/OpenApiError.cs

@@ -1,17 +1,21 @@
-using Microsoft.OpenApi.Readers.Interface;
+// ------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation.  All rights reserved.
+//  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// ------------------------------------------------------------
 
 namespace Microsoft.OpenApi.Readers.YamlReaders
 {
     public class OpenApiError
     {
-        string pointer;
-        string message;
+        private readonly string message;
+        private readonly string pointer;
 
-        public OpenApiError(OpenApiException ex)
+        public OpenApiError(OpenApiException exception)
         {
-            this.message = ex.Message;
-            this.pointer = ex.Pointer;
+            message = exception.Message;
+            pointer = exception.Pointer;
         }
+
         public OpenApiError(string pointer, string message)
         {
             this.pointer = pointer;
@@ -20,7 +24,7 @@ public OpenApiError(string pointer, string message)
 
         public override string ToString()
         {
-           return this.message + (!string.IsNullOrEmpty(this.pointer) ? " at " + this.pointer : "");
+            return message + (!string.IsNullOrEmpty(pointer) ? " at " + pointer : "");
         }
     }
-}
+}