[BUG] typescript-fetch missing model imports when using oneOf

[srsudar]

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

I am trying to use the typescript-fetch generator to generate libraries for my openapi spec. When I define a 400 response that has oneOf, the resulting TS file does not include the imports for the referenced files, resulting in invalid typescript.

openapi-generator version

$ openapi-generator --version
openapi-generator-cli 7.14.0
  commit : 5eb083e
  built  : -999999999-01-01T00:00:00+18:00
  source : https://github.com/openapitools/openapi-generator
  docs   : https://openapi-generator.tech/

OpenAPI declaration file content or url

openapi: 3.1.0
info:
  title: Example API
  version: 1.0.0
  license:
    name: UNLICENSED
    url: 'https://example.com/tos'
servers:
  - url: https://example.com
    description: Main API server
paths:
  /api/v1/islands/cms/posts:
    get:
      tags:
        - Islands
      operationId: GetIslandPosts
      summary: Get all posts
      security: []
      parameters:
        - in: query
          name: limit
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 30
            default: 20
        - in: query
          name: nextCursor
          required: false
          schema:
            type: string
      responses:
        '200':
          description: List of posts
          content:
            application/json:
              schema:
                $ref: '../generated/openapi/types/json-schema/islands/GetIslandPostsResponse.json'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '../generated/openapi/types/json-schema/shared/BadRequestError.json'
                  - $ref: '../generated/openapi/types/json-schema/shared/AppError.json'

Generation Details

openapi-generator generate \
  -i ./openapi/openapi.yaml \
  -g typescript-fetch \
  -o generated/openapi/typescript/client \
  --additional-properties=supportsES6=true,modelPropertyNaming=original,withoutDate=true

Steps to reproduce

Running the command above produces a file, dist/openapi/typescript/client/models/GetIslandPosts400Response.ts, that is missing imports for the referenced models in oneOf.

It produces this snippet:

/* tslint:disable */
/* eslint-disable */
/**
 * Example API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

/**
 * @type GetIslandPosts400Response
 * 
 * @export
 */
export type GetIslandPosts400Response = GetIslandPosts400ResponseOneOf | GetIslandPosts400ResponseOneOf1;

export function GetIslandPosts400ResponseFromJSON(json: any): GetIslandPosts400Response {
    return GetIslandPosts400ResponseFromJSONTyped(json, false);
}
<snip>

If I add these imports, it is fixed:

import { GetIslandPosts400ResponseOneOf } from './GetIslandPosts400ResponseOneOf';
import { GetIslandPosts400ResponseOneOf1 } from './GetIslandPosts400ResponseOneOf1';

export type GetIslandPosts400Response = GetIslandPosts400ResponseOneOf | GetIslandPosts400ResponseOneOf1;

Related issues/PRs

1. Fix typescript-fetch broken files when mixing basic types and refs in oneOf #21057
2. [BUG] [typescript-fetch] Imports are absent for oneof field with discriminator #21441

Suggest a fix

Importing the models seems like it would be enough. My entire .yaml file passes redocly lint. I don't know if I'm misusing something else, but it looks like this should be valid to me?

[btpnlsl]

@srsudar I tried to reproduce your issue using the OpenAPI spec provided and some generic definitions for GetIslandPostsResponse.json, BadRequestError.json and AppError.json, but was unable to get the same results.

When I generated code using openapi: 3.1.0 no model files were generated & the resulting API was using any as a return type.
When I generated code using openapi: 3.0.1 a model was generated for the endpoint response, but not using oneOf like your result.

Most likely the failure to reproduce your results is due to not having the same referenced specs. Is there any way you can provide those specs, or something similar, that can reproduce your issue?

[srsudar]

@btpnlsl , thanks for the reply. I've put together a repro case here, simplifying everything down quite a bit and still getting the same issue:

https://github.com/srsudar/openapitools-missing-imports-repro

Installation / repro instructions, as well as how to verify, are in the README.

Please let me know if you see something different, or if you need more information!

[ThorinEk]

Hello. I seem to be facing the same issue:

{
  "openapi": "3.0.3",
  "info": {
    "title": "Laneflow Command API",
    "version": "1.0.0"
  },
  "paths": {
    "/executeCommand": {
      "post": {
        "summary": "Execute a command",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  { "$ref": "#/components/schemas/CreateOrderCommand" },
                  { "$ref": "#/components/schemas/UpdateCustomerCommand" }
                ],
                "discriminator": {
                  "propertyName": "command",
                  "mapping": {
                    "createOrder": "#/components/schemas/CreateOrderCommand",
                    "updateCustomer": "#/components/schemas/UpdateCustomerCommand"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    { "$ref": "#/components/schemas/CreateOrderResponse" },
                    { "$ref": "#/components/schemas/UpdateCustomerResponse" }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CreateOrderCommand": {
        "type": "object",
        "required": ["command", "data"],
        "properties": {
          "command": {
            "type": "string",
            "enum": ["createOrder"]
          },
          "data": {
            "$ref": "#/components/schemas/CreateOrderData"
          }
        }
      },
      "CreateOrderData": {
        "type": "object",
        "required": ["customerId", "items"],
        "properties": {
          "customerId": { "type": "string" },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "required": ["articleId", "quantity"],
              "properties": {
                "articleId": { "type": "string" },
                "quantity": { "type": "number" }
              }
            }
          }
        }
      },
      "CreateOrderResponse": {
        "type": "object",
        "properties": {
          "orderId": { "type": "string" },
          "createdAt": { "type": "string", "format": "date-time" }
        }
      },
      "UpdateCustomerCommand": {
        "type": "object",
        "required": ["command", "data"],
        "properties": {
          "command": {
            "type": "string",
            "enum": ["updateCustomer"]
          },
          "data": {
            "$ref": "#/components/schemas/UpdateCustomerData"
          }
        }
      },
      "UpdateCustomerData": {
        "type": "object",
        "required": ["customerId", "email"],
        "properties": {
          "customerId": { "type": "string" },
          "email": { "type": "string", "format": "email" }
        }
      },
      "UpdateCustomerResponse": {
        "type": "object",
        "properties": {
          "updated": { "type": "boolean" }
        }
      }
    }
  }
}

Generator CLI version: "@openapitools/openapi-generator-cli": "^2.21.3",

Problem output (missing imports, but also json variable name is not defined at line 55:

/* tslint:disable */
/* eslint-disable */
/**
 * Laneflow Command API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


/**
 * @type ExecuteCommandPostRequest
 * 
 * @export
 */
export type ExecuteCommandPostRequest = { command: 'createOrder' } & CreateOrderCommand | { command: 'updateCustomer' } & UpdateCustomerCommand;

export function ExecuteCommandPostRequestFromJSON(json: any): ExecuteCommandPostRequest {
    return ExecuteCommandPostRequestFromJSONTyped(json, false);
}

export function ExecuteCommandPostRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExecuteCommandPostRequest {
    if (json == null) {
        return json;
    }
    switch (json['command']) {
        case 'createOrder':
            return Object.assign({}, CreateOrderCommandFromJSONTyped(json, true), { command: 'createOrder' } as const);
        case 'updateCustomer':
            return Object.assign({}, UpdateCustomerCommandFromJSONTyped(json, true), { command: 'updateCustomer' } as const);
        default:
            return json;
    }
}

export function ExecuteCommandPostRequestToJSON(json: any): any {
    return ExecuteCommandPostRequestToJSONTyped(json, false);
}

export function ExecuteCommandPostRequestToJSONTyped(value?: ExecuteCommandPostRequest | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }
    switch (value['command']) {
        case 'createOrder':
            return Object.assign({}, CreateOrderCommandToJSON(value), { command: 'createOrder' } as const);
        case 'updateCustomer':
            return Object.assign({}, UpdateCustomerCommandToJSON(value), { command: 'updateCustomer' } as const);
        default:
            return json;
    }
}

Notice that there are a lot of imports missing at the top of the file.

[btpnlsl]

@srsudar thanks for the complete repro case. I was able to repro this locally.

I think I have a better understanding of what is going on and might have a plan to fix the issue. It looks like the PR for #21057 regressed the imports in the case you encountered.

Unfortunately the original PR did not contain any unit tests for the problem it was trying to address, which was imports on primitive types for models composed by oneOf. Before I try to fix the current issue I opened a PR to write some unit tests to ensure that we don't regress that case while trying to fix things.

Here's the PR for the unit tests: #21638

[srsudar]

Oh great, thank you! I'd be interested in taking a look just for fun, though no doubt you'd be faster than I would be. Do you have a command that runs just the tests in that file?

I've tried things like this: ./mvnw verify -Ptypescript-fetch-client-tests-default, but I'm struggling to find the right incantation for the test in question.

[srsudar]

A-ha, nevermind! Used an IDE and found it.

[btpnlsl]

Hey! Thanks for looking.

OpenAPI is using the maven-surefire-plugin to execute unit tests and (I believe) the TestNG framework for writing unit tests.

You can run a specific suite (class) of tests using the command line like this:

mvn test -Dtest=TestClassName -pl :openapi-generator

The -pl :openapi-generator argument limits the build to a specific project without building dependencies or other projects in the build.

There is some documentation in the Surefire Plugin page about some of the options that can be used to specify which tests are run.

That being said, I just generally run tests from the IDE (I'm using Intelli-J) too.

[btpnlsl]

@ThorinEk the good news is that the sample that you provided seems to be generating the imports correctly with the latest code from the master branch. The bad news is that, you are correct, it has a problem in the ToJSONTyped method were it is returning json instead of value.

This is a regression introduced by PR #20983 in the modelOneOf.mustache template .

The fix for this should be simple. If you open another issue and include the sample input / output I can get a PR up quickly.

[btpnlsl]

@srsudar It seems that the failure to include the imports for your sample is related to the use of the additionalProperties: true in your AppError and BadRequestError schemas. I think this is why I could not reproduce the bug without your additional files.

The Schemas generated for these specs do not get marked as a model in IJsonSchemaValidationProperties.setTypeProperties because ModelUtils.isModelWithPropertiesOnly evaluates to false due to the presence of the additional properties.

Later, when TypescriptFetchClientCodegen.processCodeGenModel filters out the imports for these schemas because getIsModel will return false.

That probably wasn't the intention of the original PR, which was to filter out imports for primitive types. I'll work on a fix.

In the meantime, you might be able to work around this by removing the additionalProperties: true from your schema if that is a possibility.

[srsudar]

I tried to look into this a bit and got absolutely nowhere. Thank you for taking the time and for the detailed response! Let me know if I can do anything else to be helpful.

[Kludgy4]

I was encountering this same issue in parallel to you I think lol. Good to hear it is being fixed.

[Kludgy4]

Is oneOf even officially supported yet? the documentation suggests otherwise (for almost every generator? are these up to date?)

https://openapi-generator.tech/docs/generators/typescript-fetch/#schema-support-feature