OpenAPITools / OpenAPITools/openapi-generator

[BUG] Duplicate models are produced when a file is referenced multiple times by different paths

Open
#18,948 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

A recent openapi-generator release upgraded swagger-parser to 2.1.22. That upgrade resolved a bug where the parser was unable to resolve relative refs to real file paths, but it introduced a new bug where the parser creates duplicate schema objects for each unique relative path, rather than reusing an existing schema when two (or more) relative paths are equivalent.

openapi-generator version

v7.5.0

OpenAPI declaration file content or url

Refer to https://github.com/swagger-api/swagger-parser/pull/2105 for a reproduction OpenAPI spec.

Generation Details
Steps to reproduce
Related issues/PRs
Suggest a fix

I don't think there's a way to work around this issue in openapi-generator itself; instead it requires a fix in swagger-parser that is then pulled in to this project in a future parser upgrade.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue points to swagger-parser PR #2105 for the reproduction and says the fix belongs in swagger-parser before a future openapi-generator parser upgrade. Read that reproduction first, verify the duplicate schema objects with v7.5.0, and consider the work done when equivalent relative paths reuse one model.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.