Skip to content

fix(typescript-fetch): correct ToJSON/ToJSONTyped type signatures - #24581

Open
fangd1997 wants to merge 3 commits into
OpenAPITools:masterfrom
fangd1997:fix/typescript-fetch-tojson-type-signatures
Open

fix(typescript-fetch): correct ToJSON/ToJSONTyped type signatures#24581
fangd1997 wants to merge 3 commits into
OpenAPITools:masterfrom
fangd1997:fix/typescript-fetch-tojson-type-signatures

Conversation

@fangd1997

@fangd1997 fangd1997 commented Aug 3, 2026

Copy link
Copy Markdown

Fix the incorrect parameter and return types in the generated ToJSON and ToJSONTyped functions for typescript-fetch models.

  • modelGeneric/mustache, modelOneOf.mustache: Fix ToJSON signature from (json: any): Model to (value?: Model | null): any
  • modelEnum.mustache: Fix ToJSONTyped signature from (value: any, ignoreDiscriminator: boolean): Enum to (value?: Enum | null, ignoreDiscriminator: boolean): any Also make ToJSON delegate to ToJSONTyped instead of a raw cast

Fixes #21005

PR checklist

  • Read the contribution guidelines.
  • 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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes incorrect ToJSON/ToJSONTyped type signatures in typescript-fetch to match runtime behavior and improve type safety. All ToJSON functions now accept optional model values and delegate to ToJSONTyped; enum ToJSONTyped returns any and defaults ignoreDiscriminator to false (fixes #21005).

  • Bug Fixes
    • modelGeneric.mustache, modelOneOf.mustache: change ToJSON from (json: any): Model to (value?: Model | null): any; delegate to ToJSONTyped.
    • modelEnum.mustache: make ToJSON call ToJSONTyped; change ToJSONTyped to (value?: Enum | null, ignoreDiscriminator: boolean = false): any.
    • Regenerated typescript-fetch samples to apply the new signatures and delegation, including enum files.

Written for commit 420421a. Summary will update on new commits.

Review in cubic

Fix the incorrect parameter and return types in the generated
ToJSON and ToJSONTyped functions for typescript-fetch models.

- modelGeneric/mustache, modelOneOf.mustache: Fix ToJSON signature
  from (json: any): Model to (value?: Model | null): any
- modelEnum.mustache: Fix ToJSONTyped signature from
  (value: any, ignoreDiscriminator: boolean): Enum to
  (value?: Enum | null, ignoreDiscriminator: boolean): any
  Also make ToJSON delegate to ToJSONTyped instead of a raw cast

Fixes OpenAPITools#21005
@fangd1997

fangd1997 commented Aug 3, 2026

Copy link
Copy Markdown
Author

@wing328@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) @KannaKim (2026/07) Could you take a look at this PR when you have a chance? Thanks!

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All reported issues were addressed across 250 files

Note: This PR contains a large number of files. cubic only reviews up to 200 files per PR, so some files may not have been reviewed. cubic prioritizes the most important files to review.

Re-trigger cubic

Comment thread modules/openapi-generator/src/main/resources/typescript-fetch/modelEnum.mustache Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] [typescript-fetch] regression: modelToJSON method has incorrect type signature

1 participant