Skip to content

Conversation

@aeneasr
Copy link
Contributor

@aeneasr aeneasr commented Mar 27, 2025

Closes #20982

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 Git BASH)
    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.

@aeneasr aeneasr force-pushed the fix-discriminator-error branch from a286232 to c4e6905 Compare March 27, 2025 13:35
@aeneasr aeneasr marked this pull request as ready for review March 27, 2025 13:36
Copy link
Contributor Author

@aeneasr aeneasr left a 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;
Copy link
Contributor Author

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;
Copy link
Contributor Author

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;
Copy link
Contributor Author

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.

@aeneasr
Copy link
Contributor Author

aeneasr commented Mar 27, 2025

CC for tech committee @davidgamero @mkusaka @joscha

@wing328
Copy link
Member

wing328 commented Mar 27, 2025

thanks for the PR

cc
@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)

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!

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] Adding new discriminators to polymorph classes breaks clients

3 participants