-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
fix: support backwards compatible changes in discriminators #20983
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: support backwards compatible changes in discriminators #20983
Conversation
a286232 to
c4e6905
Compare
aeneasr
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed that this doesn't generate any changes for fromJSONTyped, probably because a dedicated openapi definition is missing for this specific case (discriminator + fromJSONTyped`.
However, there too the changes are type safe because the signature looks like this:
UiNodeAttributesFromJSONTyped(json: any, ignoreDiscriminator: boolean): UiNodeAttributes;
so if we return json (type any) it can be casted to UiNodeAttributes. It's not pretty, but it's better than the SDK client not being able to make API calls, because it's throwing exceptions left and right!
| return ChildWithNullableToJSONTyped(value as ChildWithNullable, ignoreDiscriminator); | ||
| default: | ||
| throw new Error(`No variant of ParentWithNullable exists with 'type=${value['type']}'`); | ||
| return value; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since the expected return type is : any, this is fine.
| return DogToJSONTyped(value as Dog, ignoreDiscriminator); | ||
| default: | ||
| throw new Error(`No variant of Animal exists with 'className=${value['className']}'`); | ||
| return value; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since the expected return type is : any, this is fine.
| return DogToJSONTyped(value as Dog, ignoreDiscriminator); | ||
| default: | ||
| throw new Error(`No variant of Animal exists with 'className=${value['className']}'`); | ||
| return value; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since the expected return type is : any, this is fine.
|
CC for tech committee @davidgamero @mkusaka @joscha |
|
thanks for the PR cc |
macjohnny
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks!
Closes #20982
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)