Register and retrieve JsonSchema references with $id value pointers (#1633)

irvinesunday · web-flow · commit efa812a123d1 · 2024-04-26T16:08:36.000+03:00
* Register and retrieve JsonSchema $refs with $ids specified

* Update csproj property for CopyToOutputDirectory

* Use OpenApiSpecVersion when registering components

* Use ternary operator; move value to constant

* Fix build
diff --git a/src/Microsoft.OpenApi/Models/OpenApiConstants.cs b/src/Microsoft.OpenApi/Models/OpenApiConstants.cs
@@ -635,6 +635,11 @@ public static class OpenApiConstants
         /// </summary>
         public const string BaseRegistryUri = "https://openapi.net/";
 
+        /// <summary>
+        /// The components path segment in a $ref value.
+        /// </summary>
+        public const string ComponentsSegment = "/components/";
+
         #region V2.0
 
         /// <summary>
diff --git a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
@@ -483,22 +483,22 @@ public IOpenApiReferenceable ResolveReference(OpenApiReference reference)
         /// <param name="referenceUri"></param>
         /// <returns>A JsonSchema ref.</returns>
         public JsonSchema ResolveJsonSchemaReference(Uri referenceUri)
-        {            
+        {
+            const char pound = '#';
             string uriLocation;
-            string id = referenceUri.OriginalString.Split('/')?.Last();
-            string relativePath = "/components/" + ReferenceType.Schema.GetDisplayName() + "/" + id;
-            
-            if (referenceUri.OriginalString.StartsWith("#"))
+            int poundIndex = referenceUri.OriginalString.IndexOf(pound);
+
+            if (poundIndex > 0)
             {
-                // Local reference
-                uriLocation = BaseUri + relativePath;
+                // External reference, ex: ./TodoReference.yaml#/components/schemas/todo
+                string externalUri = referenceUri.OriginalString.Split(pound).First();
+                Uri externalDocId = Workspace.GetDocumentId(externalUri);
+                string relativePath = referenceUri.OriginalString.Split(pound).Last();
+                uriLocation = externalDocId + relativePath;                
             }
             else
             {
-                // External reference
-                var externalUri = referenceUri.OriginalString.Split('#').First();
-                var externalDocId = Workspace.GetDocumentId(externalUri);
-                uriLocation = externalDocId + relativePath;
+                uriLocation = BaseUri + referenceUri.ToString().TrimStart(pound);
             }
 
             return (JsonSchema)Workspace.ResolveReference<IBaseDocument>(uriLocation);
@@ -569,7 +569,7 @@ internal IOpenApiReferenceable ResolveReference(OpenApiReference reference, bool
             }
 
             string uriLocation;
-            string relativePath = "/components/" + reference.Type.GetDisplayName() + "/" + reference.Id;
+            string relativePath = OpenApiConstants.ComponentsSegment + reference.Type.GetDisplayName() + "/" + reference.Id;
 
             uriLocation = useExternal
                 ? Workspace.GetDocumentId(reference.ExternalResource)?.OriginalString + relativePath
diff --git a/src/Microsoft.OpenApi/Reader/Services/OpenApiWorkspaceLoader.cs b/src/Microsoft.OpenApi/Reader/Services/OpenApiWorkspaceLoader.cs
@@ -1,4 +1,4 @@
-using System;
+﻿using System;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Interfaces;
@@ -27,15 +27,16 @@ internal async Task<OpenApiDiagnostic> LoadAsync(OpenApiReference reference,
                                                          CancellationToken cancellationToken = default)
         {
             _workspace.AddDocumentId(reference.ExternalResource, document.BaseUri);
-            _workspace.RegisterComponents(document);
+            var version = diagnostic?.SpecificationVersion ?? OpenApiSpecVersion.OpenApi3_0;
+            _workspace.RegisterComponents(document, version);
             document.Workspace = _workspace;
 
             // Collect remote references by walking document
             var referenceCollector = new OpenApiRemoteReferenceCollector();
             var collectorWalker = new OpenApiWalker(referenceCollector);
             collectorWalker.Walk(document);
 
-            diagnostic ??= new();
+            diagnostic ??= new() { SpecificationVersion = version };
 
             // Walk references
             foreach (var item in referenceCollector.References)
diff --git a/src/Microsoft.OpenApi/Reader/V2/OpenApiDocumentDeserializer.cs b/src/Microsoft.OpenApi/Reader/V2/OpenApiDocumentDeserializer.cs
@@ -253,7 +253,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
             FixRequestBodyReferences(openApiDoc);
 
             // Register components
-            openApiDoc.Workspace.RegisterComponents(openApiDoc);
+            openApiDoc.Workspace.RegisterComponents(openApiDoc, OpenApiSpecVersion.OpenApi2_0);
 
             return openApiDoc;
         }
diff --git a/src/Microsoft.OpenApi/Reader/V3/OpenApiDocumentDeserializer.cs b/src/Microsoft.OpenApi/Reader/V3/OpenApiDocumentDeserializer.cs
@@ -54,7 +54,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
             ParseMap(openApiNode, openApiDoc, _openApiFixedFields, _openApiPatternFields);
 
             // Register components
-            openApiDoc.Workspace.RegisterComponents(openApiDoc);
+            openApiDoc.Workspace.RegisterComponents(openApiDoc, OpenApiSpecVersion.OpenApi3_0);
 
             return openApiDoc;
         }
diff --git a/src/Microsoft.OpenApi/Reader/V31/OpenApiDocumentDeserializer.cs b/src/Microsoft.OpenApi/Reader/V31/OpenApiDocumentDeserializer.cs
@@ -53,7 +53,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
             ParseMap(openApiNode, openApiDoc, _openApiFixedFields, _openApiPatternFields);
 
             // Register components
-            openApiDoc.Workspace.RegisterComponents(openApiDoc);
+            openApiDoc.Workspace.RegisterComponents(openApiDoc, OpenApiSpecVersion.OpenApi3_1);
 
             return openApiDoc;
         }
diff --git a/src/Microsoft.OpenApi/Services/OpenApiComponentsRegistryExtensions.cs b/src/Microsoft.OpenApi/Services/OpenApiComponentsRegistryExtensions.cs
@@ -1,86 +1,98 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using Json.Schema;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Services
 {
     internal static class OpenApiComponentsRegistryExtensions
     {
-        public static void RegisterComponents(this OpenApiWorkspace workspace, OpenApiDocument document)
+        public static void RegisterComponents(this OpenApiWorkspace workspace, OpenApiDocument document, OpenApiSpecVersion version = OpenApiSpecVersion.OpenApi3_0)
         {
             if (document?.Components == null) return;
 
-            var baseUri = document.BaseUri + "/components/";
+            string baseUri = document.BaseUri + OpenApiConstants.ComponentsSegment;
+            string location;
 
             // Register Schema
             foreach (var item in document.Components.Schemas)
             {
-                var location = baseUri + ReferenceType.Schema.GetDisplayName() + "/" + item.Key;
+                if (item.Value.GetId() != null)
+                {
+                    location = document.BaseUri + item.Value.GetId().ToString();
+                }
+                else
+                {
+                    location = version == OpenApiSpecVersion.OpenApi2_0
+                        ? document.BaseUri + "/" + OpenApiConstants.Definitions + "/" + item.Key
+                        : baseUri + ReferenceType.Schema.GetDisplayName() + "/" + item.Key;
+                }
+
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register Parameters
             foreach (var item in document.Components.Parameters)
             {
-                var location = baseUri + ReferenceType.Parameter.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.Parameter.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register Responses
             foreach (var item in document.Components.Responses)
             {
-                var location = baseUri + ReferenceType.Response.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.Response.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register RequestBodies
             foreach (var item in document.Components.RequestBodies)
             {
-                var location = baseUri + ReferenceType.RequestBody.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.RequestBody.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register Links
             foreach (var item in document.Components.Links)
             {
-                var location = baseUri + ReferenceType.Link.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.Link.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register Callbacks
             foreach (var item in document.Components.Callbacks)
             {
-                var location = baseUri + ReferenceType.Callback.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.Callback.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register PathItems
             foreach (var item in document.Components.PathItems)
             {
-                var location = baseUri + ReferenceType.PathItem.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.PathItem.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register Examples
             foreach (var item in document.Components.Examples)
             {
-                var location = baseUri + ReferenceType.Example.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.Example.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register Headers
             foreach (var item in document.Components.Headers)
             {
-                var location = baseUri + ReferenceType.Header.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.Header.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
 
             // Register SecuritySchemes
             foreach (var item in document.Components.SecuritySchemes)
             {
-                var location = baseUri + ReferenceType.SecurityScheme.GetDisplayName() + "/" + item.Key;
+                location = baseUri + ReferenceType.SecurityScheme.GetDisplayName() + "/" + item.Key;
                 workspace.RegisterComponent(location, item.Value);
             }
         }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
@@ -1,16 +1,16 @@
-<Project Sdk="Microsoft.NET.Sdk">
+﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
         <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
         <SignAssembly>true</SignAssembly>
         <AssemblyOriginatorKeyFile>..\..\src\Microsoft.OpenApi.snk</AssemblyOriginatorKeyFile>
     </PropertyGroup>
     <ItemGroup>
-      <EmbeddedResource Include="**\*.yaml">
-        <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+      <EmbeddedResource Include="**\*.yaml" Exclude="**\bin\**;**\obj\**">
+        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </EmbeddedResource>
-      <EmbeddedResource Include="**\*.json">
-        <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+      <EmbeddedResource Include="**\*.json" Exclude="**\bin\**;**\obj\**">
+        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </EmbeddedResource>
     </ItemGroup>
 
diff --git a/test/Microsoft.OpenApi.Tests/Models/References/OpenApiPathItemReferenceTests.cs b/test/Microsoft.OpenApi.Tests/Models/References/OpenApiPathItemReferenceTests.cs
@@ -83,8 +83,8 @@ public OpenApiPathItemReferenceTests()
             _openApiDoc = OpenApiDocument.Parse(OpenApi, OpenApiConstants.Yaml).OpenApiDocument;
             _openApiDoc_2 = OpenApiDocument.Parse(OpenApi_2, OpenApiConstants.Yaml).OpenApiDocument;
             _openApiDoc.Workspace.AddDocumentId("https://myserver.com/beta", _openApiDoc_2.BaseUri);
-            _openApiDoc.Workspace.RegisterComponents(_openApiDoc_2);
-            _openApiDoc_2.Workspace.RegisterComponents(_openApiDoc_2);
+            _openApiDoc.Workspace.RegisterComponents(_openApiDoc_2, OpenApiSpecVersion.OpenApi3_1);
+            _openApiDoc_2.Workspace.RegisterComponents(_openApiDoc_2, OpenApiSpecVersion.OpenApi3_1);
 
             _localPathItemReference = new OpenApiPathItemReference("userPathItem", _openApiDoc_2)
             {
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
@@ -459,6 +459,7 @@ namespace Microsoft.OpenApi.Models
         public const string Callbacks = "callbacks";
         public const string ClientCredentials = "clientCredentials";
         public const string Components = "components";
+        public const string ComponentsSegment = "/components/";
         public const string Consumes = "consumes";
         public const string Contact = "contact";
         public const string Content = "content";

Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)`
`253`	`253`	`FixRequestBodyReferences(openApiDoc);`
`254`	`254`
`255`	`255`	`// Register components`
`256`		`- openApiDoc.Workspace.RegisterComponents(openApiDoc);`
	`256`	`+ openApiDoc.Workspace.RegisterComponents(openApiDoc, OpenApiSpecVersion.OpenApi2_0);`
`257`	`257`
`258`	`258`	`return openApiDoc;`
`259`	`259`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)`
`54`	`54`	`ParseMap(openApiNode, openApiDoc, _openApiFixedFields, _openApiPatternFields);`
`55`	`55`
`56`	`56`	`// Register components`
`57`		`- openApiDoc.Workspace.RegisterComponents(openApiDoc);`
	`57`	`+ openApiDoc.Workspace.RegisterComponents(openApiDoc, OpenApiSpecVersion.OpenApi3_0);`
`58`	`58`
`59`	`59`	`return openApiDoc;`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)`
`53`	`53`	`ParseMap(openApiNode, openApiDoc, _openApiFixedFields, _openApiPatternFields);`
`54`	`54`
`55`	`55`	`// Register components`
`56`		`- openApiDoc.Workspace.RegisterComponents(openApiDoc);`
	`56`	`+ openApiDoc.Workspace.RegisterComponents(openApiDoc, OpenApiSpecVersion.OpenApi3_1);`
`57`	`57`
`58`	`58`	`return openApiDoc;`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,86 +1,98 @@`
`1`	`1`	`// Copyright (c) Microsoft Corporation. All rights reserved.`
`2`	`2`	`// Licensed under the MIT license.`
`3`	`3`
	`4`	`+using Json.Schema;`
`4`	`5`	`using Microsoft.OpenApi.Extensions;`
`5`	`6`	`using Microsoft.OpenApi.Models;`
`6`	`7`
`7`	`8`	`namespace Microsoft.OpenApi.Services`
`8`	`9`	`{`
`9`	`10`	`internal static class OpenApiComponentsRegistryExtensions`
`10`	`11`	`{`
`11`		`- public static void RegisterComponents(this OpenApiWorkspace workspace, OpenApiDocument document)`
	`12`	`+ public static void RegisterComponents(this OpenApiWorkspace workspace, OpenApiDocument document, OpenApiSpecVersion version = OpenApiSpecVersion.OpenApi3_0)`
`12`	`13`	`{`
`13`	`14`	`if (document?.Components == null) return;`
`14`	`15`
`15`		`- var baseUri = document.BaseUri + "/components/";`
	`16`	`+ string baseUri = document.BaseUri + OpenApiConstants.ComponentsSegment;`
	`17`	`+ string location;`
`16`	`18`
`17`	`19`	`// Register Schema`
`18`	`20`	`foreach (var item in document.Components.Schemas)`
`19`	`21`	`{`
`20`		`- var location = baseUri + ReferenceType.Schema.GetDisplayName() + "/" + item.Key;`
	`22`	`+ if (item.Value.GetId() != null)`
	`23`	`+ {`
	`24`	`+ location = document.BaseUri + item.Value.GetId().ToString();`
	`25`	`+ }`
	`26`	`+ else`
	`27`	`+ {`
	`28`	`+ location = version == OpenApiSpecVersion.OpenApi2_0`
	`29`	`+ ? document.BaseUri + "/" + OpenApiConstants.Definitions + "/" + item.Key`
	`30`	`+ : baseUri + ReferenceType.Schema.GetDisplayName() + "/" + item.Key;`
	`31`	`+ }`
	`32`	`+`
`21`	`33`	`workspace.RegisterComponent(location, item.Value);`
`22`	`34`	`}`
`23`	`35`
`24`	`36`	`// Register Parameters`
`25`	`37`	`foreach (var item in document.Components.Parameters)`
`26`	`38`	`{`
`27`		`- var location = baseUri + ReferenceType.Parameter.GetDisplayName() + "/" + item.Key;`
	`39`	`+ location = baseUri + ReferenceType.Parameter.GetDisplayName() + "/" + item.Key;`
`28`	`40`	`workspace.RegisterComponent(location, item.Value);`
`29`	`41`	`}`
`30`	`42`
`31`	`43`	`// Register Responses`
`32`	`44`	`foreach (var item in document.Components.Responses)`
`33`	`45`	`{`
`34`		`- var location = baseUri + ReferenceType.Response.GetDisplayName() + "/" + item.Key;`
	`46`	`+ location = baseUri + ReferenceType.Response.GetDisplayName() + "/" + item.Key;`
`35`	`47`	`workspace.RegisterComponent(location, item.Value);`
`36`	`48`	`}`
`37`	`49`
`38`	`50`	`// Register RequestBodies`
`39`	`51`	`foreach (var item in document.Components.RequestBodies)`
`40`	`52`	`{`
`41`		`- var location = baseUri + ReferenceType.RequestBody.GetDisplayName() + "/" + item.Key;`
	`53`	`+ location = baseUri + ReferenceType.RequestBody.GetDisplayName() + "/" + item.Key;`
`42`	`54`	`workspace.RegisterComponent(location, item.Value);`
`43`	`55`	`}`
`44`	`56`
`45`	`57`	`// Register Links`
`46`	`58`	`foreach (var item in document.Components.Links)`
`47`	`59`	`{`
`48`		`- var location = baseUri + ReferenceType.Link.GetDisplayName() + "/" + item.Key;`
	`60`	`+ location = baseUri + ReferenceType.Link.GetDisplayName() + "/" + item.Key;`
`49`	`61`	`workspace.RegisterComponent(location, item.Value);`
`50`	`62`	`}`
`51`	`63`
`52`	`64`	`// Register Callbacks`
`53`	`65`	`foreach (var item in document.Components.Callbacks)`
`54`	`66`	`{`
`55`		`- var location = baseUri + ReferenceType.Callback.GetDisplayName() + "/" + item.Key;`
	`67`	`+ location = baseUri + ReferenceType.Callback.GetDisplayName() + "/" + item.Key;`
`56`	`68`	`workspace.RegisterComponent(location, item.Value);`
`57`	`69`	`}`
`58`	`70`
`59`	`71`	`// Register PathItems`
`60`	`72`	`foreach (var item in document.Components.PathItems)`
`61`	`73`	`{`
`62`		`- var location = baseUri + ReferenceType.PathItem.GetDisplayName() + "/" + item.Key;`
	`74`	`+ location = baseUri + ReferenceType.PathItem.GetDisplayName() + "/" + item.Key;`
`63`	`75`	`workspace.RegisterComponent(location, item.Value);`
`64`	`76`	`}`
`65`	`77`
`66`	`78`	`// Register Examples`
`67`	`79`	`foreach (var item in document.Components.Examples)`
`68`	`80`	`{`
`69`		`- var location = baseUri + ReferenceType.Example.GetDisplayName() + "/" + item.Key;`
	`81`	`+ location = baseUri + ReferenceType.Example.GetDisplayName() + "/" + item.Key;`
`70`	`82`	`workspace.RegisterComponent(location, item.Value);`
`71`	`83`	`}`
`72`	`84`
`73`	`85`	`// Register Headers`
`74`	`86`	`foreach (var item in document.Components.Headers)`
`75`	`87`	`{`
`76`		`- var location = baseUri + ReferenceType.Header.GetDisplayName() + "/" + item.Key;`
	`88`	`+ location = baseUri + ReferenceType.Header.GetDisplayName() + "/" + item.Key;`
`77`	`89`	`workspace.RegisterComponent(location, item.Value);`
`78`	`90`	`}`
`79`	`91`
`80`	`92`	`// Register SecuritySchemes`
`81`	`93`	`foreach (var item in document.Components.SecuritySchemes)`
`82`	`94`	`{`
`83`		`- var location = baseUri + ReferenceType.SecurityScheme.GetDisplayName() + "/" + item.Key;`
	`95`	`+ location = baseUri + ReferenceType.SecurityScheme.GetDisplayName() + "/" + item.Key;`
`84`	`96`	`workspace.RegisterComponent(location, item.Value);`
`85`	`97`	`}`
`86`	`98`	`}`