code refactor

Author: MaggieKimani1

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

@@ -14,10 +14,22 @@ namespace Microsoft.OpenApi.Services
     /// </summary>
     public class OpenApiWorkspace
     {
+        private Dictionary<Uri, OpenApiDocument> _documents = new();
         private readonly Dictionary<string, Uri> _documentsIdRegistry = new();
         private readonly Dictionary<Uri, Stream> _artifactsRegistry = new();        
         private readonly Dictionary<Uri, IOpenApiReferenceable> _IOpenApiReferenceableRegistry = new();
 
+        /// <summary>
+        /// A list of OpenApiDocuments contained in the workspace
+        /// </summary>
+        public IEnumerable<OpenApiDocument> Documents
+        {
+            get
+            {
+                return _documents.Values;
+            }
+        }
+
         /// <summary>
         /// The base location from where all relative references are resolved
         /// </summary>
@@ -96,6 +108,17 @@ public void AddDocumentId(string key, Uri value)
             }
         }
 
+        /// <summary>
+        /// Add an OpenApiDocument to the workspace.
+        /// </summary>
+        /// <param name="location"></param>
+        /// <param name="document"></param>
+        public void AddDocument(string location, OpenApiDocument document)
+        {
+            document.Workspace = this;
+            _documents.Add(ToLocationUrl(location), document);
+        }
+
         /// <summary>
         /// Retrieves the document id given a key.
         /// </summary>

test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiDocumentTests.cs

@@ -500,7 +500,7 @@ public async Task ExternalDocumentDereferenceToOpenApiDocumentUsingJsonPointerWo
             };
 
             // Act
-            var result = await OpenApiDocument.LoadAsync(Path.Combine(SampleFolderPath, "docWithExternalRef.yaml"), settings);
+            var result = await OpenApiDocument.LoadAsync(Path.Combine(SampleFolderPath, "externalRefByJsonPointer.yaml"), settings);
             var responseSchema = result.OpenApiDocument.Paths["/resource"].Operations[OperationType.Get].Responses["200"].Content["application/json"].Schema;
 
             // Assert
@@ -521,10 +521,11 @@ public async Task ParseExternalDocumentDereferenceToOpenApiDocumentByIdWorks()
             };
 
             // Act
-            var result = await OpenApiDocument.LoadAsync(Path.Combine(SampleFolderPath, "docWithExternalRef.yaml"), settings);
-            var externalDoc = await OpenApiDocument.LoadAsync(Path.Combine(SampleFolderPath, "externalResource.yaml"), settings);
+            var result = await OpenApiDocument.LoadAsync(Path.Combine(SampleFolderPath, "externalRefById.yaml"), settings);
+            var doc2 = OpenApiDocument.Load(Path.Combine(SampleFolderPath, "externalResource.yaml")).OpenApiDocument;
 
             var requestBodySchema = result.OpenApiDocument.Paths["/resource"].Operations[OperationType.Get].Parameters.First().Schema;
+            result.OpenApiDocument.Workspace.RegisterComponents(doc2);
 
             // Assert
             requestBodySchema.Properties.Count.Should().Be(2); // reference has been resolved

test/Microsoft.OpenApi.Readers.Tests/V31Tests/Samples/OpenApiDocument/externalRefById.yaml

@@ -0,0 +1,14 @@
+openapi: 3.1.0
+info:
+  title: ReferenceById
+  version: 1.0.0
+paths:
+  /resource:
+    get:
+      parameters:
+        - name: id
+          in: query
+          required: true
+          schema:
+            $ref: 'https://example.com/schemas/user.json'
+components: {}

test/Microsoft.OpenApi.Readers.Tests/V31Tests/Samples/OpenApiDocument/docWithExternalRef.yaml renamed to test/Microsoft.OpenApi.Readers.Tests/V31Tests/Samples/OpenApiDocument/externalRefByJsonPointer.yaml

@@ -5,12 +5,6 @@ info:
 paths:
   /resource:
     get:
-      parameters:
-        - name: id
-          in: query
-          required: true
-          schema:
-            $ref: 'https://example.com/schemas/user.json'
       responses:
         '200':
           description: OK

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

@@ -1507,6 +1507,8 @@ namespace Microsoft.OpenApi.Services
         public OpenApiWorkspace(Microsoft.OpenApi.Services.OpenApiWorkspace workspace) { }
         public OpenApiWorkspace(System.Uri baseUrl) { }
         public System.Uri BaseUrl { get; }
+        public System.Collections.Generic.IEnumerable<Microsoft.OpenApi.Models.OpenApiDocument> Documents { get; }
+        public void AddDocument(string location, Microsoft.OpenApi.Models.OpenApiDocument document) { }
         public void AddDocumentId(string key, System.Uri value) { }
         public int ComponentsCount() { }
         public bool Contains(string location) { }