External ref resolve fails to resolve to same schema and creates duplicate classes

[jimshowalter]

As reported in #1081 and
#1422, something gets confused and creates Foo.java and Foo1.java, even though there is just one foo.json model.

Those issues report that the problem has been fixed, but it has not.

In https://github.com/jimshowalter/swagger-parser-external-ref-bug there is a schema that reproduces the problem.

Run the JavaJAXRSSpecServerCodegen.java code generator on it, and you'll see that it generates a Stunts.java and Stunts1.java, but there is only stunts.json.

Also in that repo is a fix, or at least a fix that works for us. Look for "// BEGIN REFERENCE FORK:".

[webron]

@jimshowalter which version of the parser do you use?

[jimshowalter]

implementation "io.swagger.codegen.v3:swagger-codegen-generators:${swaggerCodegenGeneratorsVersion}"
implementation "io.swagger.codegen.v3:swagger-codegen:${swaggerCodegenVersion}"
implementation "io.swagger.parser.v3:swagger-parser:${swaggerParserVersion}"
implementation "io.swagger.parser.v3:swagger-parser-v3:${swaggerParserVersion}"
implementation "io.swagger.parser.v3:swagger-parser-v2-converter:${swaggerParserVersion}"
implementation "io.swagger:swagger-parser:${swaggerParserVersion2}"
implementation "io.swagger.parser.v3:swagger-parser-core:${swaggerParserVersion}"
implementation "io.swagger.core.v3:swagger-models:${swaggerCoreVersion}"
implementation "io.swagger.core.v3:swagger-annotations:${swaggerCoreVersion}"
implementation "io.swagger.core.v3:swagger-core:${swaggerCoreVersion}"

swaggerCoreVersion=2.1.6
swaggerParserVersion=2.0.24
swaggerParserVersion2=1.0.54
swaggerCodegenVersion=3.0.24
swaggerCodegenGeneratorsVersion=1.0.24

[jimshowalter]

Were you able to reproduce the problem with those versions (which I think are current, or nearly so), and the repo I linked to?

[gracekarina]

Hi, may I ask why are you using two different kind of ref for the schemas?
in ones you use components schemas assuming it ir will be resolve and in the other you use the relative path to the file.

I also notice that in the main json file you don't use stunts, how ever is listed in the components->schemas section

      "oneOf": [
        {
          "$ref": "#/components/schemas/Rebato"
        },
        {
          "$ref": "#/components/schemas/Drabbet"
        },
        {
          "$ref": "#/components/schemas/Highvelds"
        },
        {
          "$ref": "#/components/schemas/Polly"
        }
      ],
      "description": "blah blah blah"
    },
    "tashotSipe": {
      "$ref": "../api.json#/components/schemas/TashotSipe"
    },
    "massage": {
      "type": "string",
      "description": "blah blah blah"
    },
    "stunts": {
      "$ref": "../api.json#/components/schemas/Stunts"
    }

[jimshowalter]

There's nothing in the OAS spec that makes this an invalid schema.

There's something in the implementation of the OAS parser that makes it unable to conclude that Stunts == Stunts.

If there's a way to rewrite the schema that will produce the same output (other than fixing the duplicates), please explain how to do that, and we can use that as a workaround.

[gracekarina]

Hi @jimshowalter , I will start working on a fix for this duplication issue. Haven't found a workaround so far.

[jimshowalter]

Thank you--the problem is in some of the most-complicated code in all of OAS!

[gracekarina]

Hi, @jimshowalter the only issue is that stunts_1 and TashotSipe_1 are being added? or is there an issue with the other schemas also being duplicated, as analemmata and reachless.

• Is it possible for you to please create a simpler sample for me to work on, it would help the debugging, and also narrow down the real issue. thanks.

[jimshowalter]

I'll try to create a simpler version, but having already reduced the original real schema to what's in the example, another pair of duplicates vanished. I'm afraid whittling it down will unconfuse the parser and the last duplicates will disappear.

[jimshowalter]

Try now: https://github.com/jimshowalter/swagger-parser-external-ref-bug

I noticed something interesting after boiling it down to essentials. If you remove the enums from stunts.json and tashotSipe.json, then it generates Stunts1.java and TashotSipe1.java, but doesn't generate Stunts.java or TashotSipe.java.

The names are still wrong, because they shouldn't end in "1", but that's a clue.

[jimshowalter]

Did the simplified example help?

[gracekarina]

Hi, @jimshowalter I had to work on another issues, but now I'm back on this one. Yes, the simplified example helped and the enum comment gave me an idea. Thanks. I hope to have a solution soon.

[gracekarina]

Hi @jimshowalter #1559 here I made some changes, and seems like there are not duplication, can you please check? thanks