OpenAPITools / OpenAPITools/openapi-generator

[BUG] References inside Referenced files do not work

Open
#2,412 0 comments 4 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

Sample Project:
https://github.com/TruthNZ/OpenAPICodegenTest/tree/master/RelativeReferenceError

Cannot run mvn generate-sources, I get the error:
-Unable to load RELATIVE ref: ../schemas/Path1Request.yml path: C:\Development\OpenAPICodeGenTest\RelativeReferenceError\src\main\resources\api

Yet I can validate and review the API fine - at least using OpenAPI Designer in VS Code.

It looks like the direct references in the API (RelativeReferenceError.yml) works fine, but any further references in those referenced files do not.

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

Start with the linked RelativeReferenceError sample, especially RelativeReferenceError.yml and the nested ../schemas/Path1Request.yml reference. Run mvn generate-sources and trace how relative references are resolved from the referenced file; done means generation succeeds with nested relative references.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.