Use the server URL to uniquely ID schema models from different clouds during registration

src/Microsoft.OpenApi.Readers/V2/OpenApiDocumentDeserializer.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
+using System.Xml.Linq;
 using Json.Schema;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
@@ -156,9 +157,9 @@ private static void MakeServers(IList<OpenApiServer> servers, ParsingContext con
             // Fill in missing information based on the defaultUrl
             if (defaultUrl != null)
             {
-                host = host ?? defaultUrl.GetComponents(UriComponents.NormalizedHost, UriFormat.SafeUnescaped);
-                basePath = basePath ?? defaultUrl.GetComponents(UriComponents.Path, UriFormat.SafeUnescaped);
-                schemes = schemes ?? new List<string> { defaultUrl.GetComponents(UriComponents.Scheme, UriFormat.SafeUnescaped) };
+                host ??= defaultUrl.GetComponents(UriComponents.NormalizedHost, UriFormat.SafeUnescaped);
+                basePath ??= defaultUrl.GetComponents(UriComponents.Path, UriFormat.SafeUnescaped);
+                schemes ??= [defaultUrl.GetComponents(UriComponents.Scheme, UriFormat.SafeUnescaped)];
             }
             else if (String.IsNullOrEmpty(host) && String.IsNullOrEmpty(basePath))
             {
@@ -197,6 +198,8 @@ private static void MakeServers(IList<OpenApiServer> servers, ParsingContext con
                     server.Url = server.Url.Substring(0, server.Url.Length - 1);
                 }
             }
+
+            context.SetTempStorage(TempStorageKeys.Servers, servers);
         }
 
         private static string BuildUrl(string scheme, string host, string basePath)
@@ -211,7 +214,7 @@ private static string BuildUrl(string scheme, string host, string basePath)
 #if NETSTANDARD2_1_OR_GREATER
             if (!String.IsNullOrEmpty(host) && host.Contains(':', StringComparison.OrdinalIgnoreCase))
 #else
-            if (!String.IsNullOrEmpty(host) && host.Contains(':'))
+            if (!string.IsNullOrEmpty(host) && host.Contains(':'))
 #endif
             {
                 var pieces = host.Split(':');
@@ -263,7 +266,7 @@ public static OpenApiDocument LoadOpenApi(RootNode rootNode)
             MakeServers(openApidoc.Servers, openApiNode.Context, rootNode);
 
             FixRequestBodyReferences(openApidoc);
-            RegisterComponentsSchemasInGlobalRegistry(openApidoc.Components?.Schemas);
+            RegisterComponentsSchemasInGlobalRegistry(openApiNode.Context, openApidoc.Components?.Schemas);
 
             return openApidoc;
         }
@@ -312,7 +315,7 @@ private static bool IsHostValid(string host)
             return Uri.CheckHostName(hostPart) != UriHostNameType.Unknown;
         }
 
-        private static void RegisterComponentsSchemasInGlobalRegistry(IDictionary<string, JsonSchema> schemas)
+        private static void RegisterComponentsSchemasInGlobalRegistry(ParsingContext context, IDictionary<string, JsonSchema> schemas)
         {
             if (schemas == null)
             {
@@ -321,7 +324,19 @@ private static void RegisterComponentsSchemasInGlobalRegistry(IDictionary<string
 
             foreach (var schema in schemas)
             {
-                var refUri = new Uri(OpenApiConstants.V2ReferenceUri + schema.Key);
+                var servers = context.GetFromTempStorage<IList<OpenApiServer>>(TempStorageKeys.Servers);
+                var serverUrl = servers?.FirstOrDefault()?.Url;
+
+                // Remove any trailing slashes from the server URL
+                if (!string.IsNullOrEmpty(serverUrl) && serverUrl.EndsWith("/"))
+                {
+                    serverUrl = serverUrl.Substring(0, serverUrl.Length - 1);
+                }
+
+                var refPath = !string.IsNullOrEmpty(serverUrl) ? string.Concat(serverUrl, OpenApiConstants.V2ReferencedSchemaPath)
+                    : OpenApiConstants.V2ReferenceUri;
+
+                var refUri = new Uri(refPath + schema.Key);
                 SchemaRegistry.Global.Register(refUri, schema.Value);
             }
         }

src/Microsoft.OpenApi.Readers/V2/TempStorageKeys.cs

@@ -17,5 +17,6 @@ internal static class TempStorageKeys
         public const string GlobalConsumes = "globalConsumes";
         public const string GlobalProduces = "globalProduces";
         public const string ParameterIsBodyOrFormData = "parameterIsBodyOrFormData";
+        public const string Servers = "servers";
     }
 }

src/Microsoft.OpenApi.Readers/V3/OpenApiComponentsDeserializer.cs

@@ -2,13 +2,17 @@
 // Licensed under the MIT license.
 
 using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
 using System.Reflection;
 using System.Text.Json;
 using System.Text.Json.Nodes;
 using Json.Schema;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Readers.V2;
 
 namespace Microsoft.OpenApi.Readers.V3
 {
@@ -44,10 +48,17 @@ public static OpenApiComponents LoadComponents(ParseNode node)
             var components = new OpenApiComponents();
 
             ParseMap(mapNode, components, _componentsFixedFields, _componentsPatternFields);
-
+
+            var servers = node.Context.GetFromTempStorage<IList<OpenApiServer>>(TempStorageKeys.Servers);
+            var serverUrl = servers?.FirstOrDefault()?.Url;
+
+            // Examples of server url ----> "https://graph.microsoft.com/v1.0", "https://graph.microsoft.com/v1.0-fairfax"
             foreach (var schema in components.Schemas)
             {
-                var refUri = new Uri(OpenApiConstants.V3ReferenceUri + schema.Key);
+                var refPath = !string.IsNullOrEmpty(serverUrl) ? string.Concat(serverUrl, OpenApiConstants.V3ReferencedSchemaPath)
+                    : OpenApiConstants.V3ReferenceUri;
+
+                var refUri = new Uri(refPath + schema.Key);
                 SchemaRegistry.Global.Register(refUri, schema.Value);
             }
 

src/Microsoft.OpenApi.Readers/V3/OpenApiDocumentDeserializer.cs

@@ -4,6 +4,7 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Readers.V2;
 
 namespace Microsoft.OpenApi.Readers.V3
 {
@@ -21,7 +22,7 @@ internal static partial class OpenApiV3Deserializer
                 } /* Version is valid field but we already parsed it */
             },
             {"info", (o, n) => o.Info = LoadInfo(n)},
-            {"servers", (o, n) => o.Servers = n.CreateList(LoadServer)},
+            {"servers", (o, n) => n.Context.SetTempStorage(TempStorageKeys.Servers, o.Servers = n.CreateList(LoadServer))},
             {"paths", (o, n) => o.Paths = LoadPaths(n)},
             {"components", (o, n) => o.Components = LoadComponents(n)},
             {"tags", (o, n) => {o.Tags = n.CreateList(LoadTag);

src/Microsoft.OpenApi.Readers/V31/OpenApiComponentsDeserializer.cs

@@ -2,10 +2,13 @@
 // Licensed under the MIT license.
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using Json.Schema;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Readers.V2;
 
 namespace Microsoft.OpenApi.Readers.V31
 {
@@ -42,9 +45,15 @@ public static OpenApiComponents LoadComponents(ParseNode node)
 
             ParseMap(mapNode, components, _componentsFixedFields, _componentsPatternFields);
 
+            var servers = node.Context.GetFromTempStorage<IList<OpenApiServer>>(TempStorageKeys.Servers);
+            var serverUrl = servers?.FirstOrDefault()?.Url;
+
             foreach (var schema in components.Schemas)
             {
-                var refUri = new Uri(OpenApiConstants.V3ReferenceUri + schema.Key);
+                var refPath = !string.IsNullOrEmpty(serverUrl) ? string.Concat(serverUrl, OpenApiConstants.V3ReferencedSchemaPath)
+                    : OpenApiConstants.V3ReferenceUri;
+
+                var refUri = new Uri(refPath + schema.Key);
                 SchemaRegistry.Global.Register(refUri, schema.Value);
             }
 

src/Microsoft.OpenApi.Readers/V31/OpenApiDocumentDeserializer.cs

@@ -1,6 +1,7 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Readers.V2;
 
 namespace Microsoft.OpenApi.Readers.V31
 {
@@ -19,7 +20,7 @@ internal static partial class OpenApiV31Deserializer
             },
             {"info", (o, n) => o.Info = LoadInfo(n)},
             {"jsonSchemaDialect", (o, n) => o.JsonSchemaDialect = n.GetScalarValue() },
-            {"servers", (o, n) => o.Servers = n.CreateList(LoadServer)},
+            {"servers", (o, n) => n.Context.SetTempStorage(TempStorageKeys.Servers, o.Servers = n.CreateList(LoadServer))},
             {"paths", (o, n) => o.Paths = LoadPaths(n)},
             {"webhooks", (o, n) => o.Webhooks = LoadPaths(n)},
             {"components", (o, n) => o.Components = LoadComponents(n)},

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

@@ -595,6 +595,16 @@ public static class OpenApiConstants
         /// </summary>
         public static readonly Uri defaultUrl = new("http://localhost/");
 
+        /// <summary>
+        /// Field: V3 JsonSchema Reference Uri
+        /// </summary>
+        public const string V3ReferencedSchemaPath = "/components/schemas/";
+
+        /// <summary>
+        /// Field: V2 JsonSchema Reference Uri
+        /// </summary>
+        public const string V2ReferencedSchemaPath = "/definitions/";
+
         /// <summary>
         /// Field: V3 JsonSchema Reference Uri
         /// </summary>

src/Microsoft.OpenApi/Services/OpenApiReferenceResolver.cs

@@ -252,7 +252,13 @@ private Dictionary<string, JsonSchema> ResolveJsonSchemas(IDictionary<string, Js
         /// <returns></returns>
         public JsonSchema ResolveJsonSchemaReference(Uri reference, string description = null, string summary = null)
         {
-            var refUri = $"https://registry{reference.OriginalString.Split('#').LastOrDefault()}";
+            var servers = _currentDocument.Servers;
+            var basePath = servers?.FirstOrDefault()?.Url;
+
+            basePath = RemoveTrailingSlash(basePath);
+            var refPath = basePath ?? "https://registry";
+
+            var refUri = $"{refPath}{reference.OriginalString.Split('#').LastOrDefault()}";
             var resolvedSchema = (JsonSchema)SchemaRegistry.Global.Get(new Uri(refUri));
 
             if (resolvedSchema != null)
@@ -443,5 +449,14 @@ private bool IsUnresolvedReference(IOpenApiReferenceable possibleReference)
         {
             return possibleReference != null && possibleReference.UnresolvedReference;
         }
+
+        private string RemoveTrailingSlash(string url)
+        {
+            if (!string.IsNullOrEmpty(url) && url.EndsWith("/"))
+            {
+                return url.Substring(0, url.Length - 1);
+            }
+            return url;
+        }
     }
 }

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

@@ -159,7 +159,11 @@ public JsonSchema ResolveJsonSchemaReference(Uri reference)
                 {
                     foreach (var jsonSchema in doc.Components.Schemas)
                     {
-                        var refUri = new Uri(OpenApiConstants.V3ReferenceUri + jsonSchema.Key);
+                        var serverUrl = doc.Servers.FirstOrDefault()?.Url;
+                        var refPath = serverUrl != null ? string.Concat(serverUrl, OpenApiConstants.V3ReferencedSchemaPath)
+                                            : OpenApiConstants.V3ReferenceUri;
+
+                        var refUri = new Uri(refPath + jsonSchema.Key);
                         SchemaRegistry.Global.Register(refUri, jsonSchema.Value);
                     }
 

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

@@ -530,7 +530,9 @@ namespace Microsoft.OpenApi.Models
         public const string UniqueItems = "uniqueItems";
         public const string Url = "url";
         public const string V2ReferenceUri = "https://registry/definitions/";
+        public const string V2ReferencedSchemaPath = "/definitions/";
         public const string V3ReferenceUri = "https://registry/components/schemas/";
+        public const string V3ReferencedSchemaPath = "/components/schemas/";
         public const string Value = "value";
         public const string Variables = "variables";
         public const string Version = "version";