OpenAPITools / OpenAPITools/openapi-generator

[BUG] [typescript-fetch] oneOf with primitive type gives compilation errors

Open
#14,831 1 comment 5 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

a oneOf schema that has a primitive type, such as string, as one of the options generates invalid typescript code that doesn't compile, (but can be fixed with a couple small manual tweaks)

(I think this also applies to anyOf)

openapi-generator version

typescript-fetch, using openapi-generator version 6.2.1

OpenAPI declaration file content or url
{
   "components": {
      "schemas": {
         "StringSchema": {
            "description": "meep ent",
            "type": "string"
         },
         "FooEntity": {
            "oneOf": [
               {
                  "$ref": "#/components/schemas/ObjectA"
               },
               {
                  "$ref": "#/components/schemas/StringSchema"
               }
            ]
         }
      }
   }
}

this generates code that looks like:

import {
  ObjectA,
  instanceOfObjectA,
  ObjectAFromJSON,
  ObjectAFromJSONTyped,
  ObjectAToJSON,
} from './ObjectA';
import {
  string,
  instanceOfstring,
  stringFromJSON,
  stringFromJSONTyped,
  stringToJSON,
} from './string'; // <-- THIS IS INVALID

/**
* @type FooEntity
* 
* @export
*/
export type FooEntity = ObjectA | string;

Also, the JSON-serialization function that gets generated (FooEntityToJSON) is invalid too.

Steps to reproduce

generate a typescript client using from the given example schemas above ☝️

Related issues/PRs
Suggest a fix
  • primitive types in oneOf shouldn't have imports generated for them.
  • the serialization function should use typeof(...) === "string" instead of instanceOfstring
  • the serialization if checks for primtives should be moved to be before the ifs of objects

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 schemas using the typescript-fetch generator, then inspect the generated FooEntity imports and FooEntityToJSON function. Done means the generated TypeScript compiles, primitive oneOf handling avoids invalid imports and instanceOfstring checks, and the serialization branches work for both primitive and object options.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.