Merge branch 'main' into feat/enable-NRT

MaggieKimani1 · web-flow · commit c99dfc336a96 · 2025-02-13T15:15:30.000+03:00
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "2.0.0-preview8"
+  ".": "2.0.0-preview7"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,13 +1,5 @@
 # Changelog
 
-## [2.0.0-preview8](https://github.com/microsoft/OpenAPI.NET/compare/v2.0.0-preview7...v2.0.0-preview8) (2025-02-06)
-
-
-### Bug Fixes
-
-* add meaningful exception message during validation ([4a6547d](https://github.com/microsoft/OpenAPI.NET/commit/4a6547d08c86194e1783ce7f52e8248ca15556e0))
-* add meaningful exception message during validation ([74d20ed](https://github.com/microsoft/OpenAPI.NET/commit/74d20edebb6c5ee6150e8e03a42a40ed8c01d1da))
-
 ## [2.0.0-preview7](https://github.com/microsoft/OpenAPI.NET/compare/v2.0.0-preview6...v2.0.0-preview7) (2025-02-06)
 
 
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -12,7 +12,7 @@
     <PackageProjectUrl>https://github.com/Microsoft/OpenAPI.NET</PackageProjectUrl>
     <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
     <PackageTags>OpenAPI .NET</PackageTags>
-    <Version>2.0.0-preview8</Version>
+    <Version>2.0.0-preview7</Version>
   </PropertyGroup>
   <!-- https://github.com/clairernovotny/DeterministicBuilds#deterministic-builds -->
   <PropertyGroup Condition="'$(TF_BUILD)' == 'true'">
diff --git a/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj b/src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj
@@ -28,17 +28,17 @@
 
   <ItemGroup>
     <PackageReference Include="Humanizer.Core" Version="2.14.1" />
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.1" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.2" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.2" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="9.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="9.0.1" />
-    <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.12.19">
+    <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="9.0.2" />
+    <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.13.2">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
     <PackageReference Include="Microsoft.OData.Edm" Version="8.2.3" />
-    <PackageReference Include="Microsoft.OpenApi.OData" Version="2.0.0-preview.7" />
+    <PackageReference Include="Microsoft.OpenApi.OData" Version="2.0.0-preview8" />
     <PackageReference Include="Microsoft.OpenApi.ApiManifest" Version="0.5.6-preview" />
     <PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
     <!--STJ
diff --git a/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj b/src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj
@@ -28,7 +28,7 @@
 
     <ItemGroup>
 
-        <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.12.19">
+        <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.13.2">
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
           <PrivateAssets>all</PrivateAssets>
         </PackageReference>
diff --git a/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj b/src/Microsoft.OpenApi/Microsoft.OpenApi.csproj
@@ -49,7 +49,7 @@
     </ItemGroup>
 
     <ItemGroup>
-      <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.12.19">
+      <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.13.2">
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         <PrivateAssets>all</PrivateAssets>
       </PackageReference>
diff --git a/src/Microsoft.OpenApi/Reader/V3/OpenApiV3Deserializer.cs b/src/Microsoft.OpenApi/Reader/V3/OpenApiV3Deserializer.cs
@@ -159,9 +159,12 @@ private static (string, string?) GetReferenceIdAndExternalResource(string pointe
             var refSegments = pointer.Split('/');
             var refId = refSegments[refSegments.Count() -1];
             var isExternalResource = !refSegments[0].StartsWith("#", StringComparison.OrdinalIgnoreCase);
-
-            string? externalResource = isExternalResource ? $"{refSegments[0]}/{refSegments[1].TrimEnd('#')}" : null;
-
+          
+            string? externalResource = null;
+            if (isExternalResource)
+            {
+                externalResource = pointer.Split('#')[0].TrimEnd('#');
+            }
             return (refId, externalResource);
         }
     }
diff --git a/src/Microsoft.OpenApi/Reader/V31/OpenApiV31Deserializer.cs b/src/Microsoft.OpenApi/Reader/V31/OpenApiV31Deserializer.cs
@@ -173,7 +173,7 @@ private static (string, string?) GetReferenceIdAndExternalResource(string pointe
             string? externalResource = null;
             if (isExternalResource && pointer.Contains('#'))
             {
-                externalResource = $"{refSegments[0]}/{refSegments[1].TrimEnd('#')}";
+                externalResource = pointer.Split('#')[0].TrimEnd('#');
             }
 
             return (refId, externalResource);
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj b/test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj
@@ -12,10 +12,10 @@
 
   <ItemGroup>
     <PackageReference Include="coverlet.msbuild" Version="6.0.4" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
     <PackageReference Include="Moq" Version="4.20.72" />
     <PackageReference Include="xunit" Version="2.9.3" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.1" PrivateAssets="all" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.2" PrivateAssets="all" />
     <PackageReference Include="coverlet.collector" Version="6.0.4" PrivateAssets="all" />
   </ItemGroup>
 
diff --git a/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj b/test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
@@ -17,11 +17,11 @@
     <ItemGroup>
         <PackageReference Include="coverlet.collector" Version="6.0.4" PrivateAssets="all" />
         <PackageReference Include="coverlet.msbuild" Version="6.0.4" PrivateAssets="all" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
         <PackageReference Include="FluentAssertions" Version="7.1.0" />
         <PackageReference Include="SharpYaml" Version="2.1.1" />
         <PackageReference Include="xunit" Version="2.9.3" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="3.0.1" PrivateAssets="all" />
+        <PackageReference Include="xunit.runner.visualstudio" Version="3.0.2" PrivateAssets="all" />
         <!--STJ required until Microsoft.Extensions.Logging.Console and Microsoft.Extensions.Configuration.Json update their dependencies -->
         <PackageReference Include="System.Text.Json" Version="9.0.0" />
     </ItemGroup>
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiCompoentsTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiCompoentsTests.cs
@@ -0,0 +1,41 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.References;
+using Microsoft.OpenApi.Reader;
+using Xunit;
+
+namespace Microsoft.OpenApi.Readers.Tests.V31Tests
+{
+    public class OpenApiCompoentsTests
+    {
+        [Theory]
+        [InlineData("./FirstLevel/SecondLevel/ThridLevel/File.json#/components/schemas/ExternalRelativePathModel", "ExternalRelativePathModel", "./FirstLevel/SecondLevel/ThridLevel/File.json")]
+        [InlineData("File.json#/components/schemas/ExternalSimpleRelativePathModel", "ExternalSimpleRelativePathModel", "File.json")]
+        [InlineData("A:\\Dir\\File.json#/components/schemas/ExternalAbsWindowsPathModel", "ExternalAbsWindowsPathModel", "A:\\Dir\\File.json")]
+        [InlineData("/Dir/File.json#/components/schemas/ExternalAbsUnixPathModel", "ExternalAbsUnixPathModel", "/Dir/File.json")]
+        [InlineData("https://host.lan:1234/path/to/file/resource.json#/components/schemas/ExternalHttpsModel", "ExternalHttpsModel", "https://host.lan:1234/path/to/file/resource.json")]
+        [InlineData("File.json", "File.json", null)]
+        public void ParseExternalSchemaReferenceShouldSucceed(string reference, string referenceId, string externalResource)
+        {
+            var input = $@"{{
+    ""schemas"": {{
+        ""Model"": {{
+            ""$ref"": ""{reference.Replace("\\", "\\\\")}""
+        }}
+    }}
+}}
+";
+            var openApiDocument = new OpenApiDocument();
+
+            // Act
+            var components = OpenApiModelFactory.Parse<OpenApiComponents>(input, OpenApiSpecVersion.OpenApi3_1, openApiDocument, out _, "json");
+
+            // Assert
+            var schema = components.Schemas["Model"] as OpenApiSchemaReference;
+            var expected = new OpenApiSchemaReference(referenceId, openApiDocument, externalResource);
+            Assert.Equivalent(expected, schema);
+        }
+    }
+}
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiSchemaTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiSchemaTests.cs
@@ -388,5 +388,65 @@ public async Task ParseAdvancedSchemaWithReferenceShouldSucceed()
             // Assert
             Assert.Equal(expected, actual);
         }
+
+        [Fact]
+        public async Task ParseExternalReferenceSchemaShouldSucceed()
+        {
+            // Act
+            var result = await OpenApiDocument.LoadAsync(Path.Combine(SampleFolderPath, "externalReferencesSchema.yaml"));
+
+            // Assert
+            var components = result.Document.Components;
+
+            Assert.Equivalent(
+                new OpenApiDiagnostic()
+                {
+                    SpecificationVersion = OpenApiSpecVersion.OpenApi3_0
+                }, result.Diagnostic);
+
+            var expectedComponents = new OpenApiComponents
+            {
+                Schemas =
+                {
+                    ["RelativePathModel"] = new OpenApiSchema()
+                    {
+                        AllOf =
+                        {
+                            new OpenApiSchemaReference("ExternalRelativePathModel", result.Document, "./FirstLevel/SecondLevel/ThridLevel/File.json")
+                        }
+                    },
+                    ["SimpleRelativePathModel"] = new OpenApiSchema()
+                    {
+                        AllOf =
+                        {
+                            new OpenApiSchemaReference("ExternalSimpleRelativePathModel", result.Document, "File.json")
+                        }
+                    },
+                    ["AbsoluteWindowsPathModel"] = new OpenApiSchema()
+                    {
+                        AllOf =
+                        {
+                            new OpenApiSchemaReference("ExternalAbsWindowsPathModel", result.Document, @"A:\Dir\File.json")
+                        }
+                    },
+                    ["AbsoluteUnixPathModel"] = new OpenApiSchema()
+                    {
+                        AllOf =
+                        {
+                            new OpenApiSchemaReference("ExternalAbsUnixPathModel", result.Document, "/Dir/File.json")
+                        }
+                    },
+                    ["HttpsUrlModel"] = new OpenApiSchema()
+                    {
+                        AllOf =
+                        {
+                            new OpenApiSchemaReference("ExternalHttpsModel", result.Document, "https://host.lan:1234/path/to/file/resource.json")
+                        }
+                    }
+                }
+            };
+
+            Assert.Equivalent(expectedComponents, components);
+        }
     }
 }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiSchema/externalReferencesSchema.yaml b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiSchema/externalReferencesSchema.yaml
@@ -0,0 +1,23 @@
+﻿# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject
+openapi: 3.0.0
+info:
+  title: Simple Document
+  version: 0.9.1
+paths: { }
+components:
+  schemas:
+    RelativePathModel:
+      allOf:
+      - $ref: './FirstLevel/SecondLevel/ThridLevel/File.json#/components/schemas/ExternalRelativePathModel'
+    SimpleRelativePathModel:
+      allOf:
+      - $ref: 'File.json#/components/schemas/ExternalSimpleRelativePathModel'
+    AbsoluteWindowsPathModel:
+      allOf:
+      - $ref: 'A:\Dir\File.json#/components/schemas/ExternalAbsWindowsPathModel'
+    AbsoluteUnixPathModel:
+      allOf:
+      - $ref: '/Dir/File.json#/components/schemas/ExternalAbsUnixPathModel'
+    HttpsUrlModel:
+      allOf:
+      - $ref: 'https://host.lan:1234/path/to/file/resource.json#/components/schemas/ExternalHttpsModel'
diff --git a/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj b/test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj
@@ -11,12 +11,12 @@
     <PackageReference Include="coverlet.collector" Version="6.0.4" PrivateAssets="all" />
     <PackageReference Include="coverlet.msbuild" Version="6.0.4" PrivateAssets="all" />
     <PackageReference Include="FluentAssertions" Version="7.1.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
     <PackageReference Include="Moq" Version="4.20.72" />
     <PackageReference Include="SharpYaml" Version="2.1.1" />
     <PackageReference Include="Verify.Xunit" Version="28.10.1" />
     <PackageReference Include="xunit" Version="2.9.3" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.1" PrivateAssets="all" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.0.2" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
     <PackageReference Include="PublicApiGenerator" Version="11.4.1" />
   </ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "2.0.0-preview8"`
	`2`	`+ ".": "2.0.0-preview7"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ private static (string, string?) GetReferenceIdAndExternalResource(string pointe`
`173`	`173`	`string? externalResource = null;`
`174`	`174`	`if (isExternalResource && pointer.Contains('#'))`
`175`	`175`	`{`
`176`		`- externalResource = $"{refSegments[0]}/{refSegments[1].TrimEnd('#')}";`
	`176`	`+ externalResource = pointer.Split('#')[0].TrimEnd('#');`
`177`	`177`	`}`
`178`	`178`
`179`	`179`	`return (refId, externalResource);`