Fixed issue with v2 external references

Author: darrelmiller

src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj

@@ -33,10 +33,10 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging" Version="6.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.1" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="6.0.0" />
-    <PackageReference Include="System.CommandLine" Version="2.0.0-beta2.21617.1" />
+    <PackageReference Include="System.CommandLine" Version="2.0.0-beta3.22114.1" />
     <PackageReference Include="Microsoft.OData.Edm" Version="7.10.0" />
     <PackageReference Include="Microsoft.OpenApi.OData" Version="1.0.10-preview1" />
   </ItemGroup>

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

@@ -40,7 +40,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="SharpYaml" Version="1.8.0" />
+        <PackageReference Include="SharpYaml" Version="1.9.0" />
     </ItemGroup>
 
     <ItemGroup>

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

@@ -130,6 +130,30 @@ private static string GetReferenceTypeV2Name(ReferenceType referenceType)
             }
         }
 
+        private static ReferenceType GetReferenceTypeV2FromName(string referenceType)
+        {
+            switch (referenceType)
+            {
+                case "definitions":
+                    return ReferenceType.Schema;
+
+                case "parameters":
+                    return ReferenceType.Parameter;
+
+                case "responses":
+                    return ReferenceType.Response;
+
+                case "tags":
+                    return ReferenceType.Tag;
+
+                case "securityDefinitions":
+                    return ReferenceType.SecurityScheme;
+
+                default:
+                    throw new ArgumentException();
+            }
+        }
+
         /// <summary>
         /// Parse the string to a <see cref="OpenApiReference"/> object.
         /// </summary>
@@ -176,12 +200,34 @@ public OpenApiReference ConvertToOpenApiReference(string reference, ReferenceTyp
                         }
                     }
 
+                    // Where fragments point into a non-OpenAPI document, the id will be the complete fragment identifier
+                    string id = segments[1];
+                    // $ref: externalSource.yaml#/Pet
+                    if (id.StartsWith("/definitions/"))
+                    {
+                        var localSegments = id.Split('/');
+                        var referencedType = GetReferenceTypeV2FromName(localSegments[1]);
+                        if (type == null)
+                        {
+                            type = referencedType;
+                        }
+                        else
+                        {
+                            if (type != referencedType)
+                            {
+                                throw new OpenApiException("Referenced type mismatch");
+                            }
+                        }
+                        id = localSegments[2];
+                    }
+
+
                     // $ref: externalSource.yaml#/Pet
                     return new OpenApiReference
                     {
                         ExternalResource = segments[0],
                         Type = type,
-                        Id = segments[1].Substring(1)
+                        Id = id
                     };
                 }
             }

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

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. 
 
 using System;

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

@@ -247,7 +247,7 @@
         </PackageReference>
         <PackageReference Include="Newtonsoft.Json" Version="13.0.1">
         </PackageReference>
-        <PackageReference Include="SharpYaml" Version="1.8.0">
+        <PackageReference Include="SharpYaml" Version="1.9.0">
         </PackageReference>
         <PackageReference Include="xunit" Version="2.4.1">
         </PackageReference>

test/Microsoft.OpenApi.Readers.Tests/ReferenceService/ConvertToOpenApiReferenceV2Tests.cs

@@ -17,14 +17,32 @@ public ConvertToOpenApiReferenceV2Tests()
             Diagnostic = new OpenApiDiagnostic();
         }
 
+        [Fact]
+        public void ParseExternalReferenceToV2OpenApi()
+        {
+            // Arrange
+            var versionService = new OpenApiV2VersionService(Diagnostic);
+            var externalResource = "externalSchema.json";
+            var id = "mySchema";
+            var input = $"{externalResource}#/definitions/{id}";
+
+            // Act
+            var reference = versionService.ConvertToOpenApiReference(input, null);
+
+            // Assert
+            reference.ExternalResource.Should().Be(externalResource);
+            reference.Type.Should().NotBeNull();
+            reference.Id.Should().Be(id);
+        }
+
         [Fact]
         public void ParseExternalReference()
         {
             // Arrange
             var versionService = new OpenApiV2VersionService(Diagnostic);
             var externalResource = "externalSchema.json";
-            var id = "externalPathSegment1/externalPathSegment2/externalPathSegment3";
-            var input = $"{externalResource}#/{id}";
+            var id = "/externalPathSegment1/externalPathSegment2/externalPathSegment3";
+            var input = $"{externalResource}#{id}";
 
             // Act
             var reference = versionService.ConvertToOpenApiReference(input, null);

test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj

@@ -17,11 +17,11 @@
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="6.5.1" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
-    <PackageReference Include="Moq" Version="4.16.1" />
+    <PackageReference Include="Moq" Version="4.17.2" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
-    <PackageReference Include="SharpYaml" Version="1.8.0" />
-    <PackageReference Include="Verify" Version="16.1.2" />
-    <PackageReference Include="Verify.Xunit" Version="16.1.2" />
+    <PackageReference Include="SharpYaml" Version="1.9.0" />
+    <PackageReference Include="Verify" Version="16.4.3" />
+    <PackageReference Include="Verify.Xunit" Version="16.4.3" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>