Skip to content

Conversation

btpnlsl
Copy link
Contributor

@btpnlsl btpnlsl commented Jul 27, 2025

There is an outstanding problem related to the models generated by the typescript-fetch generator, where in certain cases the generated code is not importing models for types composed using oneOf.

The current logic related to figuring out which types are imported is located in TypescriptFetchClientCodegen.processCodeGenModel

This was originally created in #21057 to address typescript imports of primitive types & was recently touched in #21464 to address a regression related to the removal of primitive types used with oneOf and return values of the FromJSONTyped & ToJSONTyped methods.

Shortly after #21057 was merged there were reports that the PR had broken typescript imports for some users with issues #21441 and #21587 being opened.

Unfortunately the PR for #21057 contained no unit tests, so this PR attempts to add a unit test using the sample OAS provided in that PR to establish a fix for the case where imports are not included does not break the fix for the case #21057 was attempting to fix. Once the unit test is in place I am going to look into a fix for the case described in #21587.

When writing the unit test I first regressed the changes in #21057 in order to have the unit test go from red / green when the change was applied.

@DavidGrath
I also made a couple of changes to the unit test provided for #21464 in order to simplify the typescript-fetch generation and to fix the case where enum values were being tested (which was due to an error in the OAS created for testing the issue).

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 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
PR #21464 - @DavidGrath

@DavidGrath
Copy link
Contributor

@btpnlsl , thank you for fixing that up

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 test!

@macjohnny macjohnny merged commit ee5a12a into OpenAPITools:master Jul 28, 2025
14 checks passed
@wing328 wing328 added this to the 7.15.0 milestone Aug 9, 2025
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.

5 participants