Process swagger file cross reference when generating API review (#7438)

Azure · Dec 12, 2023 · 8240399 · 8240399
1 parent f55acff
commit 8240399
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/tools/apiview/parsers/swagger-api-parser/SwaggerApiParser/CHANGELOG b/tools/apiview/parsers/swagger-api-parser/SwaggerApiParser/CHANGELOG
@@ -1,5 +1,8 @@
 # Release History
 
+## 1.3.0 (12-12-2023)
++ Support local schema reference in another referred swagger file
+
 ## 1.2.0 (11-29-2023)
 + Added API version as PackageVersion in code file.
 

diff --git a/tools/apiview/parsers/swagger-api-parser/SwaggerApiParser/SwaggerAPIViewGenerator.cs b/tools/apiview/parsers/swagger-api-parser/SwaggerApiParser/SwaggerAPIViewGenerator.cs
@@ -173,18 +173,22 @@ public static async Task<SwaggerApiViewSpec> GenerateSwaggerApiView(Swagger swag
                     {
                         var resp = response;
                         var referenceSwaggerFilePath = swaggerFilePath;
+                        string referencePath = "";
 
                         if (response.IsRefObject())
                         {
                             resp = (Response)swaggerSpec.ResolveRefObj(response.@ref);
                             if (resp == null)
                             {
                                 resp = (Response)schemaCache.GetResponseFromCache(response.@ref, swaggerFilePath);
+                                // Update reference path if referenced object is in another swagger file
+                                if (response.IsRefObject() && !response.@ref.StartsWith("#"))
+                                    referencePath = response.@ref;
                             }
 
                             if (resp == null)
                             {
-                                var referencePath = response.@ref;
+                                referencePath = response.@ref;
                                 do
                                 {
                                     if (!Path.IsPathFullyQualified(referencePath))
@@ -216,7 +220,13 @@ public static async Task<SwaggerApiViewSpec> GenerateSwaggerApiView(Swagger swag
                         {
                             if (schema.IsRefObject())
                             {
-                                var referencePath = schema.@ref;
+                                // Update swagger file path to correct file if schema reference is local but parent itself is in another swagger file
+                                if (schema.@ref.StartsWith("#") && !string.IsNullOrEmpty(referencePath))
+                                {
+                                    referenceSwaggerFilePath = Utils.GetReferencedSwaggerFile(referencePath, referenceSwaggerFilePath);
+                                }
+
+                                referencePath = schema.@ref;
                                 do
                                 {
                                     referenceSwaggerFilePath = Utils.GetReferencedSwaggerFile(referencePath, referenceSwaggerFilePath);

diff --git a/tools/apiview/parsers/swagger-api-parser/SwaggerApiParser/SwaggerApiParser.csproj b/tools/apiview/parsers/swagger-api-parser/SwaggerApiParser/SwaggerApiParser.csproj
@@ -6,7 +6,7 @@
     <ToolCommandName>swaggerAPIParser</ToolCommandName>
     <TargetFramework>net7.0</TargetFramework>
     <RootNamespace>SwaggerApiParser</RootNamespace>
-    <VersionPrefix>1.2.0</VersionPrefix>
+    <VersionPrefix>1.3.0</VersionPrefix>
     <AssemblyName>Azure.Sdk.Tools.SwaggerApiParser</AssemblyName>
     <SignAssembly>True</SignAssembly>
     <InformationalVersion>$(OfficialBuildId)</InformationalVersion>