fix(typescript-fetch): correct ToJSON/ToJSONTyped type signatures - #24581
Open
fangd1997 wants to merge 3 commits into
Open
fix(typescript-fetch): correct ToJSON/ToJSONTyped type signatures#24581fangd1997 wants to merge 3 commits into
fangd1997 wants to merge 3 commits into
Conversation
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
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! |
Contributor
There was a problem hiding this comment.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix the incorrect parameter and return types in the generated ToJSON and ToJSONTyped functions for typescript-fetch models.
Fixes #21005
PR checklist
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.
Summary by cubic
Fixes incorrect ToJSON/ToJSONTyped type signatures in
typescript-fetchto 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).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.typescript-fetchsamples to apply the new signatures and delegation, including enum files.Written for commit 420421a. Summary will update on new commits.