Skip to content

Conversation

btpnlsl
Copy link
Contributor

@btpnlsl btpnlsl commented Jul 29, 2025

Closes #21587

The typescript-fetch client generator has a bug when generating model code where the list of imports will be missing items if the OAS spec includes a schema a oneOf section and the oneOf schema has additionalProperties: true.

An example OAS would be

openapi: 3.0.1
info:
  title: Example API
  version: 1.0.0
paths:
  /api/endpoint:
    get:
      operationId: GetEndpoint
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: OneOfResponse
                oneOf:
                  - $ref: '#/components/schemas/OptionOne'
                  - $ref: '#/components/schemas/OptionTwo'
components:
  schemas:
    OptionOne:
      type: object
      title: OptionOne
      properties:
        propOne:
          type: number
      additionalProperties: true
    OptionTwo:
      type: object
      title: OptionTwo
      properties:
        propTwo:
          type: string

The model code generated for OneOfResponse.ts includes the following type:
export type OneOfResponse = OptionOne | OptionTwo;

However, the imports in OneOfResponse.ts will only have imports for OptionTwo.

The underlying issue is that TypeScriptFetchClientCodegen.processCodeGenModel is creating a set of model imports by filtering out schemas using the CodegenProperty::getIsModel method.

        cm.oneOfModels = oneOfsList.stream()
                .filter(CodegenProperty::getIsModel)
                .map(CodegenProperty::getBaseType)
                .filter(Objects::nonNull)
                .collect(Collectors.toCollection(TreeSet::new));

Schemas which have additional properties set will not be marked as models because IJsonSchemaValidationProperties.setTypeProperties because ModelUtils.isModelWithPropertiesOnly evaluates to false due to the presence of the additional properties.

That probably wasn't the intention of the original PR #21057 (addressing #19909), which was to filter out imports for built-in language primitive types like string, object, Array, etc.

This PR changes the filter used in TypeScriptFetchClientCodegen to use .filter(cp -> !cp.getIsPrimitiveType() && !cp.isArrayType()) to filter out schemas for language built-in types or arrays.

The language built-in types are defined in AbstractTypeScriptClientCodegen as a combination between the -languageSpecificPrimitives variable and the default typeMapping. Types will be mapped first using the typeMapping map and then be compared against the list of language specific primitives.

I've added a unit test for this bug using the OAS issue_21587.yaml which uses a oneOf composed of a schema with additionalProperties: true and also a bunch of primitive types which should hit most of primitives available with the default type mappings.

One area I wasn't entirely 100% on is the use of Set as a primitive. My understanding is that the Set type is only available starting with ES6. The typescript client generators have a setting, supportsES6, which is false by default. I'm not sure how valid it is to have Set as a language primitive type if supportsES6 is false.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Typescript: @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10)
Prior work: PR #21057 - @GregoryMerlet

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the fix!

@macjohnny macjohnny merged commit d29a4be into OpenAPITools:master Jul 30, 2025
14 checks passed
@wing328 wing328 added this to the 7.15.0 milestone Aug 9, 2025
Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
…penAPITools#21656)

* Add unit tests for bug in imports for oneOf schemas with additional properties set to true OpenAPITools#21587

* Fix bug in filtering primitive, built-in types from model imports in TypeScriptFetchClientCodegen

* Add YAML OAS file for OpenAPITools#21587

* Revert change to issue_21259.yaml

* Remove comment from issue_21259.yaml

* Filter out arrays from oneOfModels along with primitive types

* Update issue_21587 unit test to catch the Array<Model> case

---------

Co-authored-by: Chris Gual <cgual@omnidian.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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