Creates component registries in the OpenApiWorkspace for $ref resolution

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

@@ -618,13 +618,18 @@
         /// <summary>
         /// Field: V3 JsonSchema Reference Uri
         /// </summary>
         public const string V3ReferenceUri = "https://registry/components/schemas/";
 
         /// <summary>
         /// Field: V2 JsonSchema Reference Uri
         /// </summary>
         public const string V2ReferenceUri = "https://registry/definitions/";
 
+        /// <summary>
+        /// The default registry uri for OpenApi documents and workspaces
+        /// </summary>
+        public const string BaseRegistryUri = "https://openapi.net/";
+
         #region V2.0
 
         /// <summary>

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -10,7 +10,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Json.Schema;
-using Microsoft.OpenApi.Exceptions;
+using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Reader;
 using Microsoft.OpenApi.Services;
@@ -94,8 +94,12 @@
         /// <summary>
         /// Parameter-less constructor
         /// </summary>
-        public OpenApiDocument() { }
-
+        public OpenApiDocument() 
+        {
+            Workspace = new OpenApiWorkspace();
+            BaseUri = new(OpenApiConstants.BaseRegistryUri + Guid.NewGuid().ToString());            
+        }
+
         /// <summary>
         /// Initializes a copy of an an <see cref="OpenApiDocument"/> object
         /// </summary>
@@ -124,7 +128,7 @@
 
             writer.WriteStartObject();
 
             // openApi;
             writer.WriteProperty(OpenApiConstants.OpenApi, "3.1.0");
 
             // jsonSchemaDialect
@@ -447,12 +451,12 @@
         /// This method will be replaced by a LoadExternalReferences in the next major update to this library.
         /// Resolving references at load time is going to go away.
         /// </remarks>
-        public IEnumerable<OpenApiError> ResolveReferences()
+        public IEnumerable<OpenApiError> ResolveJsonSchemaReferences()
         {
-            var resolver = new OpenApiReferenceResolver(this, false);
-            var walker = new OpenApiWalker(resolver);
+            var jsonSchemaResolver = new JsonSchemaReferenceResolver(this);
+            var walker = new OpenApiWalker(jsonSchemaResolver);
             walker.Walk(this);
-            return resolver.Errors;
+            return jsonSchemaResolver.Errors;
         }
 
         /// <summary>
@@ -488,6 +492,32 @@
             return ResolveReference(reference, false);
         }
 
+        /// <summary>
+        /// Resolves JsonSchema refs
+        /// </summary>
+        /// <param name="referenceUri"></param>
+        /// <returns>A JsonSchema ref.</returns>
+        public JsonSchema ResolveJsonSchemaReference(Uri referenceUri)
+        {            
+            string uriLocation;
+            string id = referenceUri.OriginalString.Split('/')?.Last();
+            string relativePath = "/components/" + ReferenceType.Schema.GetDisplayName() + "/" + id;
+            if (referenceUri.OriginalString.StartsWith("#"))
+            {
+                // Local reference
+                uriLocation = BaseUri + relativePath;
+            }
+            else
+            {
+                // External reference
+                var externalUri = referenceUri.OriginalString.Split('#').First();
+                var externalDocId = Workspace.GetDocumentId(externalUri);
+                uriLocation = externalDocId + relativePath;
+            }
+
+            return (JsonSchema)Workspace.ResolveReference<IBaseDocument>(uriLocation);
+        }
+
         /// <summary>
         /// Takes in an OpenApi document instance and generates its hash value
         /// </summary>
@@ -532,16 +562,6 @@
                 return null;
             }
 
-            // Todo: Verify if we need to check to see if this external reference is actually targeted at this document.
-            if (useExternal)
-            {
-                if (this.Workspace == null)
-                {
-                    throw new ArgumentException(Properties.SRResource.WorkspaceRequredForExternalReferenceResolution);
-                }
-                return this.Workspace.ResolveReference(reference);
-            }
-
             if (!reference.Type.HasValue)
             {
                 throw new ArgumentException(Properties.SRResource.LocalReferenceRequiresType);
@@ -562,51 +582,16 @@
                 return null;
             }
 
-            if (this.Components == null)
-            {
-                throw new OpenApiException(string.Format(Properties.SRResource.InvalidReferenceId, reference.Id));
-            }
-
-            try
-            {
-                switch (reference.Type)
-                {
-                    case ReferenceType.PathItem:
-                        return Components.PathItems[reference.Id];
-                    case ReferenceType.Response:
-                        return Components.Responses[reference.Id];
-
-                    case ReferenceType.Parameter:
-                        return Components.Parameters[reference.Id];
-
-                    case ReferenceType.Example:
-                        return Components.Examples[reference.Id];
-
-                    case ReferenceType.RequestBody:
-                        return Components.RequestBodies[reference.Id];
-
-                    case ReferenceType.Header:
-                        return Components.Headers[reference.Id];
-
-                    case ReferenceType.SecurityScheme:
-                        return Components.SecuritySchemes[reference.Id];
+            string uriLocation;
+            string relativePath = "/components/" + reference.Type.GetDisplayName() + "/" + reference.Id;
 
-                    case ReferenceType.Link:
-                        return Components.Links[reference.Id];
+            uriLocation = useExternal
+                ? Workspace.GetDocumentId(reference.ExternalResource)?.OriginalString + relativePath
+                : BaseUri + relativePath;
 
-                    case ReferenceType.Callback:
-                        return Components.Callbacks[reference.Id];
-
-                    default:
-                        throw new OpenApiException(Properties.SRResource.InvalidReferenceType);
-                }
-            }
-            catch (KeyNotFoundException)
-            {
-                throw new OpenApiException(string.Format(Properties.SRResource.InvalidReferenceId, reference.Id));
-            }
+            return Workspace.ResolveReference<IOpenApiReferenceable>(uriLocation);
         }
-
+                
         /// <summary>
         /// Parses a local file path or Url into an Open API document.
         /// </summary>
@@ -707,12 +692,6 @@
         {
             throw new NotImplementedException();
         }
-
-        internal JsonSchema ResolveJsonSchemaReference(Uri reference)
-        {
-            var referencePath = string.Concat("https://registry", reference.OriginalString.Split('#').Last());
-            return (JsonSchema)SchemaRegistry.Global.Get(new Uri(referencePath));
-        }
     }
 
     internal class FindSchemaReferences : OpenApiVisitorBase

src/Microsoft.OpenApi/Models/OpenApiExample.cs

@@ -68,7 +68,7 @@
         {
             Summary = example?.Summary ?? Summary;
             Description = example?.Description ?? Description;
-            Value = JsonNodeCloneHelper.Clone(example?.Value);
+            Value = example?.Value ?? JsonNodeCloneHelper.Clone(example?.Value);
             ExternalValue = example?.ExternalValue ?? ExternalValue;
             Extensions = example?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(example.Extensions) : null;
             Reference = example?.Reference != null ? new(example?.Reference) : null;

src/Microsoft.OpenApi/Models/OpenApiHeader.cs

@@ -114,8 +114,8 @@
             Style = header?.Style ?? Style;
             Explode = header?.Explode ?? Explode;
             AllowReserved = header?.AllowReserved ?? AllowReserved;
-            _schema = JsonNodeCloneHelper.CloneJsonSchema(header?.Schema);
-            Example = JsonNodeCloneHelper.Clone(header?.Example);
+            Schema = header?.Schema != null ? JsonNodeCloneHelper.CloneJsonSchema(header?.Schema) : null;
+            Example = header?.Example != null ? JsonNodeCloneHelper.Clone(header?.Example) : null;
             Examples = header?.Examples != null ? new Dictionary<string, OpenApiExample>(header.Examples) : null;
             Content = header?.Content != null ? new Dictionary<string, OpenApiMediaType>(header.Content) : null;
             Extensions = header?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(header.Extensions) : null;

src/Microsoft.OpenApi/Models/OpenApiParameter.cs

@@ -167,9 +167,9 @@
             Style = parameter?.Style ?? Style;
             Explode = parameter?.Explode ?? Explode;
             AllowReserved = parameter?.AllowReserved ?? AllowReserved;
-            _schema = JsonNodeCloneHelper.CloneJsonSchema(parameter?.Schema);
+            Schema = parameter?.Schema != null ? JsonNodeCloneHelper.CloneJsonSchema(parameter?.Schema) : null;
             Examples = parameter?.Examples != null ? new Dictionary<string, OpenApiExample>(parameter.Examples) : null;
-            Example = JsonNodeCloneHelper.Clone(parameter?.Example);
+            Example = parameter?.Example != null ? JsonNodeCloneHelper.Clone(parameter?.Example) : null;
             Content = parameter?.Content != null ? new Dictionary<string, OpenApiMediaType>(parameter.Content) : null;
             Extensions = parameter?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(parameter.Extensions) : null;
             AllowEmptyValue = parameter?.AllowEmptyValue ?? AllowEmptyValue;

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

@@ -33,7 +33,7 @@ private OpenApiCallback Target
         /// <param name="hostDocument">The host OpenAPI document.</param>
         /// <param name="externalResource">Optional: External resource in the reference.
         /// It may be:
-        /// 1. a absolute/relative file path, for example:  ../commons/pet.json
+        /// 1. an absolute/relative file path, for example:  ../commons/pet.json
         /// 2. a Url, for example: http://localhost/pet.json
         /// </param>
         public OpenApiCallbackReference(string referenceId, OpenApiDocument hostDocument, string externalResource = null)

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

@@ -24,7 +24,10 @@ private OpenApiExample Target
             get
             {
                 _target ??= Reference.HostDocument.ResolveReferenceTo<OpenApiExample>(_reference);
-                return _target;
+                OpenApiExample resolved = new OpenApiExample(_target);                
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                if (!string.IsNullOrEmpty(_summary)) resolved.Summary = _summary;
+                return resolved;
             }
         }
 
@@ -71,12 +74,12 @@ internal OpenApiExampleReference(OpenApiExample target, string referenceId)
         public override string Description
         {
             get => string.IsNullOrEmpty(_description) ? Target.Description : _description;
-            set => _description = value; 
+            set => _description = value;
         }
 
         /// <inheritdoc/>
         public override string Summary
-        { 
+        {
             get => string.IsNullOrEmpty(_summary) ? Target.Summary : _summary;
             set => _summary = value;
         }

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

@@ -24,7 +24,9 @@ private OpenApiHeader Target
             get
             {
                 _target ??= Reference.HostDocument.ResolveReferenceTo<OpenApiHeader>(_reference);
-                return _target;
+                OpenApiHeader resolved = new OpenApiHeader(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                return resolved;
             }
         }
 
@@ -153,7 +155,7 @@ public override void SerializeAsV2(IOpenApiWriter writer)
         private void SerializeInternal(IOpenApiWriter writer,
             Action<IOpenApiWriter, IOpenApiReferenceable> action)
         {
-            Utils.CheckArgumentNull(writer);;
+            Utils.CheckArgumentNull(writer);
             action(writer, Target);
         }
     }

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

@@ -22,7 +22,9 @@ private OpenApiLink Target
             get
             {
                 _target ??= Reference.HostDocument.ResolveReferenceTo<OpenApiLink>(_reference);
-                return _target;
+                OpenApiLink resolved = new OpenApiLink(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                return resolved;
             }
         }
 

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

@@ -26,7 +26,9 @@ private OpenApiParameter Target
             get
             {
                 _target ??= Reference.HostDocument.ResolveReferenceTo<OpenApiParameter>(_reference);
-                return _target;
+                OpenApiParameter resolved = new OpenApiParameter(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                return resolved;
             }
         }
 

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

@@ -23,7 +23,10 @@ private OpenApiPathItem Target
             get
             {
                 _target ??= Reference.HostDocument.ResolveReferenceTo<OpenApiPathItem>(_reference);
-                return _target;
+                OpenApiPathItem resolved = new OpenApiPathItem(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                if (!string.IsNullOrEmpty(_summary)) resolved.Summary = _summary;
+                return resolved;
             }
         }
 

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

@@ -22,7 +22,9 @@ private OpenApiRequestBody Target
             get
             {
                 _target ??= Reference.HostDocument.ResolveReferenceTo<OpenApiRequestBody>(_reference);
-                return _target;
+                OpenApiRequestBody resolved = new OpenApiRequestBody(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                return resolved;
             }
         }
 

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

@@ -22,7 +22,9 @@ private OpenApiResponse Target
             get
             {
                 _target ??= Reference.HostDocument?.ResolveReferenceTo<OpenApiResponse>(_reference);
-                return _target;
+                OpenApiResponse resolved = new OpenApiResponse(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                return resolved;
             }
         }
 

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

@@ -22,7 +22,9 @@ private OpenApiSecurityScheme Target
             get
             {
                 _target ??= Reference.HostDocument.ResolveReferenceTo<OpenApiSecurityScheme>(_reference);
-                return _target;
+                OpenApiSecurityScheme resolved = new OpenApiSecurityScheme(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                return resolved;
             }
         }
 

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

@@ -22,7 +22,9 @@ private OpenApiTag Target
             {
                 _target ??= Reference.HostDocument?.ResolveReferenceTo<OpenApiTag>(_reference);
                 _target ??= new OpenApiTag() { Name = _reference.Id };
-                return _target;
+                OpenApiTag resolved = new OpenApiTag(_target);
+                if (!string.IsNullOrEmpty(_description)) resolved.Description = _description;
+                return resolved;
             }
         }
 

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs

@@ -14,6 +14,8 @@
 using Microsoft.OpenApi.Services;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Reader.Services;
+using System.Collections.Generic;
+using System;
 
 namespace Microsoft.OpenApi.Reader
 {
@@ -94,6 +96,7 @@ public async Task<ReadResult> ReadAsync(JsonNode jsonNode,
                 }
 
                 SetHostDocument(document);
+                ResolveReferences(diagnostic, document);
             }
             catch (OpenApiException ex)
             {
@@ -202,5 +205,16 @@ private void SetHostDocument(OpenApiDocument document)
         {
             document.SetHostDocument();
         }
+
+        private void ResolveReferences(OpenApiDiagnostic diagnostic, OpenApiDocument document)
+        {
+            List<OpenApiError> errors = new();
+            errors.AddRange(document.ResolveJsonSchemaReferences());
+
+            foreach (var item in errors)
+            {
+                diagnostic.Errors.Add(item);
+            }
+        }
     }
 }