OpenAPITools / OpenAPITools/openapi-generator

[BUG] Property with oneOf leads to wrong Typescript

Open
#14,806 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

Description

Generating Typescript Clients with a schema that have a property including "oneOf" gets rendered wrong.

openapi-generator version

6.4.0

OpenAPI declaration file content or url
Generation Details

Following the swagger:

"CarFactoryCreate": {
        "type": "object",
        "properties": {
          "vehicles": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/CarCreate"
                },
                {
                  "$ref": "#/components/schemas/BikeCreate"
                },
                {
                  "$ref": "#/components/schemas/BycicleCreate"
                }
              ],
              "description": ""
            },
            "description": "",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": ""
      },

leads to the following generation that is obvisiously wrong:

import type { CarCreate | BikeCreate | BycicleCreate } from './CarCreate | BikeCreate | BycicleCreate';
import {
    CarCreate | BikeCreate | BycicleCreateFromJSON,
    CarCreate | BikeCreate | BycicleCreateFromJSONTyped,
    CarCreate | BikeCreate | BycicleCreateToJSON,
} from './CarCreate | BikeCreate | BycicleCreate';
Steps to reproduce

Having the mentioned swagger, run generate "typescript-fetch" with interfaces= false

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 reproducing the issue with the provided OpenAPI schema using the typescript-fetch generator and interfaces=false. Inspect the generator path that handles array items with oneOf; done means the generated TypeScript imports and union type references are valid rather than using a union as a filename.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
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.