Skip to content
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

[Rust-Axum][Breaking Change] Improve the oneOf model generator #20336

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

Victoria-Casasampere-BeeTheData
Copy link
Contributor

@Victoria-Casasampere-BeeTheData Victoria-Casasampere-BeeTheData commented Dec 16, 2024

This PR aims to replace the current oneOf and discriminator implementation for the rust-axum generator to one that is usable.

The idea is to generate an enum for oneOf models, with a variant for each specified model. It uses untagged when the discriminator is not specified, and tag = "discriminator" when it is.
This implementation however is not the default present in serde, as it lacks serialization for the discriminator field, a field that has to be specified in all oneOf variants per OAS, and will fail to serialize when present in the generated structure. The custom implementation allows for the field to be present, and still be able to serialize to the adequate model.
Another benefit of the custom serialization is that the variant structure can be serialized directly without the need to convert to the original enum (an option which is still available), which has its benefits when the models have further use outside the API (such as WS messages), and facilitates the use of the frunk crate.

TODO:

  • Figure out why ./bin/generate-samples.sh bin/configs/manual/rust-axum-* freezes, but manually generating each model still works.
  • Fix the validator implementation of primitive type enum variants.
  • Move model modifications from postProcessOperationsWithModels to its own method.
  • Support discriminators specified in non oneOf objects...?
  • Add a test case for tagged discriminators in oneOf objects.

Fixes #20101

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.

Comment on lines +1086 to +1087
sb.append(", isNull='").append(isNull).append('\'');
sb.append(", hasValidation='").append(hasValidation).append('\'');
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was annoying to me, it broke string formatting, which made debugging slightly harder.

@Victoria-Casasampere-BeeTheData Victoria-Casasampere-BeeTheData changed the title [Rust-Axum][Breaking Change] Improve the oneOf model generator. [Rust-Axum][Breaking Change] Improve the oneOf model generator Dec 16, 2024
@Victoria-Casasampere-BeeTheData Victoria-Casasampere-BeeTheData marked this pull request as ready for review December 16, 2024 15:28
@Victoria-Casasampere-BeeTheData Victoria-Casasampere-BeeTheData marked this pull request as draft December 16, 2024 15:47
@Victoria-Casasampere-BeeTheData Victoria-Casasampere-BeeTheData marked this pull request as ready for review December 18, 2024 15:33
@Victoria-Casasampere-BeeTheData
Copy link
Contributor Author

@linxGnu @wing328
Ready for review

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] [Rust-Axum] Unable to use oneOf generated structures
1 participant