OpenAPITools / OpenAPITools/openapi-generator

[BUG][spring] schema with both `$ref` and `type: object` sometimes results in `$ref` being ignored

Open
#24,710 6 comments 0 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?
  • 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

For a property like the following:

lifeCycle:
  type: object
  $ref: "LifeCycle"

the generated code might end up using java.lang.Object as the type instead of the generated LifeCycle model.

openapi-generator version

7.24.0

OpenAPI declaration file content or url

openapi.yaml

Generation Details

config.json

Steps to reproduce
  • in a directory X, create openapi.yaml and config.json with the contents as above
  • from within X, run docker run --rm -v .:/local openapitools/openapi-generator-cli:v7.24.0 generate --strict-spec true --input-spec /local/openapi.yaml --generator-name spring --config /local/config.json --output /local/output
  • open the generated BankAccount model: ./output/src/main/java/org/openapitools/model/BankAccount.java

actual: private @Nullable Object lifeCycle = null;
expected: private @Nullable LifeCycle lifeCycle;

Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/issues/13295

Suggest a fix

Note that the allOf is required to reproduce the bug.

OpenAPINormalizer logs a warning:

[main] WARN o.o.codegen.OpenAPINormalizer - Type(s) cleared (set to null) given $ref is set to #/components/schemas/LifeCycle.

The related issue is not tied to a specific generator, so I assume this issue is generic as well.

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 supplied openapi.yaml and config.json, reproducing the issue with the v7.24.0 Docker command and spring generator. Read OpenAPINormalizer.java around line 1082, then inspect how the generated BankAccount model resolves the lifeCycle property. Done means the allOf case preserves the LifeCycle reference instead of generating Object, with a regression test covering the input.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.