Merge branch 'master' into MapCustomTypeToString

Author: darrelmiller

src/Microsoft.OpenApi.Readers/OpenApiDiagnostic.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. 
 
 using System.Collections.Generic;
+using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.Interface;
 
 namespace Microsoft.OpenApi.Readers

src/Microsoft.OpenApi.Readers/OpenApiReaderError.cs

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.OpenApi.Exceptions;
+using Microsoft.OpenApi.Models;
+using SharpYaml;
+
+namespace Microsoft.OpenApi.Readers
+{
+    /// <summary>
+    /// Error detected during the reading of some input and converting to an OpenApiDocument
+    /// </summary>
+    public class OpenApiReaderError : OpenApiError
+    {
+
+        /// <summary>
+        /// Creates error object from thrown exception
+        /// </summary>
+        /// <param name="exception"></param>
+        public OpenApiReaderError(OpenApiException exception) : base(exception)
+        {
+
+        }
+
+        /// <summary>
+        /// Create error object from YAML SyntaxErrorException
+        /// </summary>
+        /// <param name="exception"></param>
+        public OpenApiReaderError(SyntaxErrorException exception) : base(String.Empty, exception.Message)
+        {
+
+        }
+    }
+}

src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs

@@ -50,7 +50,7 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
             }
             catch (SyntaxErrorException ex)
             {
-                diagnostic.Errors.Add(new OpenApiError(string.Empty, ex.Message));
+                diagnostic.Errors.Add(new OpenApiReaderError(ex));
                 return new OpenApiDocument();
             }
 
@@ -83,7 +83,6 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
                     case ReferenceResolutionSetting.DoNotResolveReferences:
                         break;
                 }
-
             }
             catch (OpenApiException ex)
             {
@@ -94,7 +93,7 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
             var errors = document.Validate(_settings.RuleSet);
             foreach (var item in errors)
             {
-                diagnostic.Errors.Add(new OpenApiError(item.ErrorPath, item.ErrorMessage));
+                diagnostic.Errors.Add(item);
             } 
 
             return document;

src/Microsoft.OpenApi.Readers/ParseNodes/ParseNode.cs

@@ -24,8 +24,6 @@ protected ParseNode(ParsingContext parsingContext, OpenApiDiagnostic diagnostic)
 
         public OpenApiDiagnostic Diagnostic { get; }
 
-        public string DomainType { get; internal set; }
-
         public MapNode CheckMapNode(string nodeName)
         {
             var mapNode = this as MapNode;
@@ -37,17 +35,6 @@ public MapNode CheckMapNode(string nodeName)
             return mapNode;
         }
 
-        internal string CheckRegex(string value, Regex versionRegex, string defaultValue)
-        {
-            if (!versionRegex.IsMatch(value))
-            {
-                Diagnostic.Errors.Add(new OpenApiError("", "Value does not match regex: " + versionRegex));
-                return defaultValue;
-            }
-
-            return value;
-        }
-
         public static ParseNode Create(ParsingContext context, OpenApiDiagnostic diagnostic, YamlNode node)
         {
             var listNode = node as YamlSequenceNode;

src/Microsoft.OpenApi.Readers/ParseNodes/PropertyNode.cs

@@ -6,6 +6,7 @@
 using System.Linq;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Exceptions;
+using Microsoft.OpenApi.Models;
 using SharpYaml.Serialization;
 
 namespace Microsoft.OpenApi.Readers.ParseNodes
@@ -42,7 +43,7 @@ public void ParseField<T>(
                 catch (OpenApiException ex)
                 {
                     ex.Pointer = Context.GetLocation();
-                    Diagnostic.Errors.Add(new OpenApiError(ex));
+                    Diagnostic.Errors.Add(new OpenApiReaderError(ex));
                 }
                 finally
                 {
@@ -62,7 +63,7 @@ public void ParseField<T>(
                     catch (OpenApiException ex)
                     {
                         ex.Pointer = Context.GetLocation();
-                        Diagnostic.Errors.Add(new OpenApiError(ex));
+                        Diagnostic.Errors.Add(new OpenApiReaderError(ex));
                     }
                     finally
                     {

src/Microsoft.OpenApi/Extensions/OpenApiElementExtensions.cs

@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using Microsoft.OpenApi.Interfaces;
+using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Services;
 using Microsoft.OpenApi.Validations;
 
@@ -19,7 +20,8 @@ public static class OpenApiElementExtensions
         /// <param name="element">Element to validate</param>
         /// <param name="ruleSet">Optional set of rules to use for validation</param>
         /// <returns>An IEnumerable of errors.  This function will never return null.</returns>
-        public static IEnumerable<ValidationError> Validate(this IOpenApiElement element, ValidationRuleSet ruleSet = null)         {
+        public static IEnumerable<OpenApiError> Validate(this IOpenApiElement element, ValidationRuleSet ruleSet = null)
+        {
             var validator = new OpenApiValidator(ruleSet);
             var walker = new OpenApiWalker(validator);
             walker.Walk(element);

src/Microsoft.OpenApi.Readers/OpenApiError.cs renamed to src/Microsoft.OpenApi/Models/OpenApiError.cs

@@ -3,20 +3,18 @@
 
 using Microsoft.OpenApi.Exceptions;
 
-namespace Microsoft.OpenApi.Readers
+namespace Microsoft.OpenApi.Models
 {
     /// <summary>
-    /// Error related to reading Open API YAML/JSON.
+    /// Error related to the Open API Document.
     /// </summary>
     public class OpenApiError
     {
         /// <summary>
         /// Initializes the <see cref="OpenApiError"/> class using the message and pointer from the given exception.
         /// </summary>
-        public OpenApiError(OpenApiException exception)
+        public OpenApiError(OpenApiException exception) : this(exception.Pointer, exception.Message)
         {
-            Message = exception.Message;
-            Pointer = exception.Pointer;
         }
 
         /// <summary>

src/Microsoft.OpenApi/Validations/IValidationContext.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Services;
 using Microsoft.OpenApi.Validations.Rules;
 
@@ -18,7 +19,8 @@ public interface IValidationContext
         /// Register an error with the validation context.
         /// </summary>
         /// <param name="error">Error to register.</param>
-        void AddError(ValidationError error);
+        void AddError(OpenApiValidatorError error);
+
 
         /// <summary>
         /// Allow Rule to indicate validation error occured at a deeper context level.  

src/Microsoft.OpenApi/Validations/OpenApiValidator.cs

@@ -16,7 +16,7 @@ namespace Microsoft.OpenApi.Validations
     public class OpenApiValidator : OpenApiVisitorBase, IValidationContext 
     {
         private readonly ValidationRuleSet _ruleSet;
-        private readonly IList<ValidationError> _errors = new List<ValidationError>();
+        private readonly IList<OpenApiValidatorError> _errors = new List<OpenApiValidatorError>();
 
         /// <summary>
         /// Create a vistor that will validate an OpenAPIDocument
@@ -30,7 +30,7 @@ public OpenApiValidator(ValidationRuleSet ruleSet = null)
         /// <summary>
         /// Gets the validation errors.
         /// </summary>
-        public IEnumerable<ValidationError> Errors
+        public IEnumerable<OpenApiValidatorError> Errors
         {
             get
             {
@@ -42,7 +42,7 @@ public IEnumerable<ValidationError> Errors
         /// Register an error with the validation context.
         /// </summary>
         /// <param name="error">Error to register.</param>
-        public void AddError(ValidationError error)
+        public void AddError(OpenApiValidatorError error)
         {
             if (error == null)
             {

src/Microsoft.OpenApi/Validations/OpenApiValidatorError.cs

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.OpenApi.Models;
+
+namespace Microsoft.OpenApi.Validations
+{
+    /// <summary>
+    /// Errors detected when validating an OpenAPI Element
+    /// </summary>
+    public class OpenApiValidatorError : OpenApiError
+    {
+        /// <summary>
+        /// Initializes the <see cref="OpenApiError"/> class.
+        /// </summary>
+        public OpenApiValidatorError(string ruleName, string pointer, string message) : base(pointer, message)
+        {
+            RuleName = ruleName;
+        }
+
+        /// <summary>
+        /// Name of rule that detected the error.
+        /// </summary>
+        public string RuleName { get; set; }
+    }
+}