OpenApiStreamReader.ReadAsync() throws an InvalidOperation exception when using ResolveAllReferences #609

Activity

1. darrelmiller commented on Jun 25, 2021

   

   Darrel (darrelmiller)

   on Jun 25, 2021

   Member

   More actions

   As mentioned in the release notes currently remote references only works for absolute paths.
2. Zaid-Ajaj commented on Jun 27, 2021

   

   Zaid Ajaj (Zaid-Ajaj)

   on Jun 27, 2021

   More actions

   Hi Darrel (@darrelmiller), I have encountered the same issue. However, I wrote my own JSON preprocessor which correctly turned all relative paths into absolute ones. See here a public gist of the OpenAPI schema for ApplicationInsights

   The error remains the same even though there no more relative paths in the initial document itself. Here is a dotnet fiddle snippet to reproduce the issue:

   using System;
   using System.Net.Http;
   using System.Threading.Tasks;
   using Microsoft.OpenApi.Readers;
   
   public class Program
   {
   	static HttpClient client = new HttpClient();
   	
   	public static async Task Main()
   	{
   		var schemaGist = "https://github.com/proxy/gist.githubusercontent.com/Zaid-Ajaj/f27da5d9ddc8dfeceb26fe2a1f5b75a4/raw/7ca33215e113a8c91ad445a03d7352cd937a2c18/appinsight.json";
   		var schema = await client.GetStreamAsync(schemaGist);
   		var settings = new OpenApiReaderSettings 
   		{ 
   			ReferenceResolution = ReferenceResolutionSetting.ResolveAllReferences
   		};
   		
   		var result = await new OpenApiStreamReader(settings).ReadAsync(schema);
   	}
   }

   I guess the error still happens because one of the transitive documents itself has a relative path?
3. darrelmiller commented on Jun 27, 2021

   

   Darrel (darrelmiller)

   on Jun 27, 2021

   Member

   More actions

   I'm working on fixing this at the moment. Thanks for the repro instructions.
4. Zaid-Ajaj commented on Jun 27, 2021

   

   Zaid Ajaj (Zaid-Ajaj)

   on Jun 27, 2021

   More actions

   Another half solution I found is changing the custom resource loader when the initial schema url is known and is used as base path. (the following is in F# but you get the idea)

   type ExternalResouceLoader(schema: string) =
       interface Interface.IStreamLoader with
           member self.Load(uri: Uri) =
               let absoluteUri =
                   if not uri.IsAbsoluteUri then
                       Uri(Uri(schema), uri.OriginalString)
                   else
                       uri
   
               httpClient.GetStreamAsync(absoluteUri)
               |> Async.AwaitTask
               |> Async.RunSynchronously
   
           member self.LoadAsync(uri: Uri) =
               let absoluteUri =
                   if not uri.IsAbsoluteUri then
                       Uri(Uri(schema), uri.OriginalString)
                   else
                       uri
   
               httpClient.GetStreamAsync(absoluteUri)

   However, the resolved parts are not really useful: types are not added to the global components and external parameters are empty (except for the Reference property)
5. vivian (adhiambovivian)

   assigned

   Darrel (darrelmiller)

   on Apr 3, 2023
6. vivian (adhiambovivian)

   added

   status:waiting-for-internal-feedbackNeeds internal stakeholder(s) input to resolveNeeds internal stakeholder(s) input to resolve

   on Apr 4, 2023