Converted OpenApiExceptions to OpenApiReaderExceptions

Author: darrelmiller

src/Microsoft.OpenApi.Readers/Exceptions/OpenApiReaderException.cs

@@ -51,5 +51,6 @@ public OpenApiReaderException(string message, YamlNode node) : base(message)
         /// <param name="message">Plain text error message for this exception.</param>
         /// <param name="innerException">Inner exception that caused this exception to be thrown.</param>
         public OpenApiReaderException(string message, Exception innerException) : base(message, innerException) { }
+
     }
 }

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

@@ -9,6 +9,7 @@
 using Microsoft.OpenApi.Exceptions;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers.Exceptions;
 using SharpYaml.Serialization;
 
 namespace Microsoft.OpenApi.Readers.ParseNodes
@@ -27,8 +28,8 @@ public override List<T> CreateList<T>(Func<MapNode, T> map)
         {
             if (_nodeList == null)
             {
-                throw new OpenApiException(
-                    $"Expected list at line {_nodeList.Start.Line} while parsing {typeof(T).Name}");
+                throw new OpenApiReaderException(
+                    $"Expected list at line {_nodeList.Start.Line} while parsing {typeof(T).Name}", _nodeList);
             }
 
             return _nodeList.Select(n => map(new MapNode(Context, n as YamlMappingNode)))
@@ -47,8 +48,8 @@ public override List<T> CreateSimpleList<T>(Func<ValueNode, T> map)
         {
             if (_nodeList == null)
             {
-                throw new OpenApiException(
-                    $"Expected list at line {_nodeList.Start.Line} while parsing {typeof(T).Name}");
+                throw new OpenApiReaderException(
+                    $"Expected list at line {_nodeList.Start.Line} while parsing {typeof(T).Name}", _nodeList);
             }
 
             return _nodeList.Select(n => map(new ValueNode(Context, n))).ToList();

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

@@ -63,7 +63,7 @@ public override Dictionary<string, T> CreateMap<T>(Func<MapNode, T> map)
             var yamlMap = _node;
             if (yamlMap == null)
             {
-                throw new OpenApiException($"Expected map at line {yamlMap.Start.Line} while parsing {typeof(T).Name}");
+                throw new OpenApiReaderException($"Expected map at line {yamlMap.Start.Line} while parsing {typeof(T).Name}", yamlMap);
             }
 
             var nodes = yamlMap.Select(
@@ -99,7 +99,7 @@ public override Dictionary<string, T> CreateMapWithReference<T>(
             var yamlMap = _node;
             if (yamlMap == null)
             {
-                throw new OpenApiException($"Expected map at line {yamlMap.Start.Line} while parsing {typeof(T).Name}");
+                throw new OpenApiReaderException($"Expected map at line {yamlMap.Start.Line} while parsing {typeof(T).Name}", yamlMap);
             }
 
             var nodes = yamlMap.Select(
@@ -134,7 +134,7 @@ public override Dictionary<string, T> CreateSimpleMap<T>(Func<ValueNode, T> map)
             var yamlMap = _node;
             if (yamlMap == null)
             {
-                throw new OpenApiException($"Expected map at line {yamlMap.Start.Line} while parsing {typeof(T).Name}");
+                throw new OpenApiReaderException($"Expected map at line {yamlMap.Start.Line} while parsing {typeof(T).Name}", yamlMap);
             }
 
             var nodes = yamlMap.Select(
@@ -189,7 +189,7 @@ public string GetScalarValue(ValueNode key)
             var scalarNode = _node.Children[new YamlScalarNode(key.GetScalarValue())] as YamlScalarNode;
             if (scalarNode == null)
             {
-                throw new OpenApiException($"Expected scalar at line {_node.Start.Line} for key {key.GetScalarValue()}");
+                throw new OpenApiReaderException($"Expected scalar at line {_node.Start.Line} for key {key.GetScalarValue()}", _node);
             }
 
             return scalarNode.Value;

src/Microsoft.OpenApi/Exceptions/OpenApiException.cs

@@ -39,8 +39,14 @@ public OpenApiException(string message, Exception innerException)
         }
 
         /// <summary>
-        /// The reference pointer.
+        /// The reference pointer.  This is a fragment identifier used to point to where the error occurred in the document.
+        /// If the document has been parsed as JSON/YAML then the identifier will be a 
+        /// JSON Pointer as per https://tools.ietf.org/html/rfc6901
+        /// If the document fails to parse as JSON/YAML then the fragment will be based on
+        /// a text/plain pointer as defined in https://tools.ietf.org/html/rfc5147 
+        /// Currently only line= is provided because using char= causes tests to break due to CR/LF & LF differences
         /// </summary>
         public string Pointer { get; set; }
+
     }
 }