[Bug]: Ref resolution gets confused

[jimshowalter]

Description

Ref resolution gets confused.

Affected Version

2.1.30

We have no idea when this showed up, because we only started using swagger-parser a few weeks ago. The code generator we were using previously didn't have this problem.

Steps to Reproduce

Unzip the attached schema.

Compile this and run it in a debugger:

public class RefBug {

  public static void main(String[] args) {
    File apiJson = new File(<fill this in with a path to the api.json file from the unzipped zip>);
    ParseOptions parseOptions = new ParseOptions();
    parseOptions.setResolveResponses(true);
    parseOptions.setValidateExternalRefs(true);
    parseOptions.setResolveFully(true);
    OpenAPIV3Parser parser = new OpenAPIV3Parser();
    SwaggerParseResult result = parser.readLocation(apiJson.getAbsolutePath(), null, parseOptions);
    for (String error : result.getMessages()) {
      System.out.println(apiJson + ": " + error); // <<< Stop here in a debugger.
    }
  }
}

You will get an error about "Could not find /ref-bug/schemas/v2/m1/models/models/task.json on the classpath

The models/models isn't correct.

Also, there's a warning about task.json when the schema is viewed in IntelliJ. See screenshot.

Expected Behavior

It should resolve the file.

Actual Behavior

It can't find the file.

Environment

Java 21

Gradle 8.14.3

MacOS Sequoia 15.5 and RedHat RHEL 9.

[jimshowalter]

ref-bug.zip

[jimshowalter]

[jimshowalter]

We had to hack a workaround like this:

package io.swagger.v3.parser.util;
...
public class ClasspathHelper {

  public static String loadFileFromClasspath(String location) {
    String file = FilenameUtils.separatorsToUnix(location);

    // For some reason swagger-parser gets the path wrong for a few $refs,
    // per https://github.com/swagger-api/swagger-parser/issues/2213.
    // So, we special-case.
    if (file.contains("/schemas/v2/api.json")) {
      return readStringText(
          new File(file.replace("/schemas/v2/api.json", "/schemas/v2/m1/api.json")));
    }

package io.swagger.v3.parser.reference;
...
public interface Visitor {
...
  default String readFile(String path) throws Exception {
    // For some reason swagger-parser gets the path wrong for a few $refs,
    // per https://github.com/swagger-api/swagger-parser/issues/2213.
    // So, we special-case.
    if (path.contains("/schemas/v2/m1/models/models/taskLinkPermissions.json")) {
      path = path.replace("/models/models/", "/models/");
    } else if (path.contains("/schemas/v2/models/taskLinkPermissions.json")) {
      path = path.replace("/schemas/v2/models/", "/schemas/v2/m1/models/");
    }
    try (InputStream inputStream = new FileInputStream(path)) {
      return IOUtils.toString(inputStream, UTF_8);
    }
  }

We'd prefer not to have to do that!

[ewaostrowska]

Hi @jimshowalter!
Thank you for reaching out to us :) I have taken a look at the issue and tried reproducing it.

I did get the error "Could not find src/test/resources/issue2213/api.json on the classpath" when setting the apiPath to Path from the repository root ("src/test/resources/issue2213/api.json" in my case)

However if the path is set to the path from Content root ("src/test/resources/issue2213/schemas/v2/m1/api.json" in my case) or source root (issue2213/schemas/v2/m1/api.json) I do not get any error.

Can you please check if changing the path root resolves the issue?

[jimshowalter]

That fixed the ref resolution, but then it got a different error about an attribute being unexpected.

The weird thing is we have about 120 api json files, and more than 2,000 model files, and this is the only file with this problem.