OpenAPITools / OpenAPITools/openapi-generator

[BUG] Upgrading to 3.1 breaks sharing types between APIs

Open
#20,722 0 comments 3 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

When updating a specs from OpenAPI 3.0 to OpenAPI 3.1, types cannot be shared anymore, as two unrelated types are generated.

openapi-generator version

7.11.0

Steps to reproduce

Given these files:

foo.yaml

openapi: 3.0.4
info:
  title: foo API
  version: 0.0.1
paths:
  /foo:
    get:
      responses:
        200:
          description: foo
          content:
            application/json:
              schema:
                $ref: 'user.yml#/Response'

bar.yaml

openapi: 3.0.4
info:
  title: bar API
  version: 0.0.1
paths:
  /bar:
    get:
      responses:
        200:
          description: bar
          content:
            application/json:
              schema:
                $ref: 'user.yml#/Response'

and the shared common.yaml

Response:
  properties:
    id:
      type: integer

Running this will generate two files, one being the shared class:

for f in foo.yaml bar.yaml; do openapi-generator generate -g java -i $f; done

tree src/main/java/org/openapitools/client/model
src/main/java/org/openapitools/client/model
├── AbstractOpenApiSchema.java
└── Response.java

But if you change these files to openapi: 3.1.0, each API will have its own class:

src/main/java/org/openapitools/client/model
├── AbstractOpenApiSchema.java
├── BarGet200Response.java
└── FooGet200Response.java

This will make re-using code very hard. What is the recommended way to share types (classes) between APIs?

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 by running the openapi-generator generate -g java -i command with foo.yaml and bar.yaml, comparing the OpenAPI 3.0 and 3.1 inputs and their shared common.yaml reference. Inspect the generated model paths and the handling of Response, BarGet200Response, and FooGet200Response; done means determining why the shared type diverges and documenting or restoring the expected reuse behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.