-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
[Rust-Axum][Breaking Change] Improve the oneOf
model generator
#20336
Conversation
sb.append(", isNull='").append(isNull).append('\''); | ||
sb.append(", hasValidation='").append(hasValidation).append('\''); |
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.
This was annoying to me, it broke string formatting, which made debugging slightly harder.
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 for the fix.
cc @OpenAPITools/generator-core-team
oneOf
model generator.oneOf
model generator
thanks for the PR would it be possible to add some oneOf model tests (serialization, deserialization) similar to what we've done in the java client, e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/JSONTest.java#L410 ? |
I will have a look at implementing a test case |
c488a48
to
ab259fa
Compare
@wing328 Tests for tagged and untagged enums have been implemented and are passing on the CI. Ready for review. |
@Victoria-Casasampere-BeeTheData thanks for adding the tests. @linxGnu can you please review when you've time? |
@Victoria-Casasampere-BeeTheData thank you for your contribution and happy new year. Please wait for me, about 1 or 2 days to review. |
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.
Hi @Victoria-Casasampere-BeeTheData
- Please find my comments below
- Could you please describe the scope of the PR? Is it for
Response
Model only?
...penapi-generator/src/main/java/org/openapitools/codegen/languages/RustAxumServerCodegen.java
Outdated
Show resolved
Hide resolved
...penapi-generator/src/main/java/org/openapitools/codegen/languages/RustAxumServerCodegen.java
Outdated
Show resolved
Hide resolved
...penapi-generator/src/main/java/org/openapitools/codegen/languages/RustAxumServerCodegen.java
Outdated
Show resolved
Hide resolved
...penapi-generator/src/main/java/org/openapitools/codegen/languages/RustAxumServerCodegen.java
Show resolved
Hide resolved
{{#vars}} | ||
{{#isDiscriminator}} | ||
impl {{{classname}}} { | ||
fn __name_for_{{{name}}}() -> String { |
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.
Could you please explain why we need __
as prefix?
@@ -0,0 +1,9 @@ | |||
#[test] |
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.
Please add tests in another PR
The models are needed for both incoming (request body) and outgoing (response) requests, which the added test sample includes. An example where this is useful is, for example, a WebSocket service, where you receive different models through the same endpoint, and outgoing models vary as well. This change goes a step further to allow the individual models as a possible response, without the need to upcast to the enum of the endpoint, which is a grateful QOL improvement. |
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.
LGTM.
I have reviewed everything. It's a wonderful PR from @Victoria-Casasampere-BeeTheData which leverages the power of serde enum internal tag
Kindly ping @wing328 for further actions
@Victoria-Casasampere-BeeTheData thanks for the PR when you've time, can you please PM me via Slack when you've time? https://join.slack.com/t/openapi-generator/shared_invite/zt-2wmkn4s8g-n19PJ99Y6Vei74WMUIehQA @linxGnu thanks for reviewing the change If anyone prefers to previous/old implementation somehow, we can create an option to fallback to the old template but users will need to maintain it moving forward |
This PR aims to replace the current
oneOf
anddiscriminator
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 usesuntagged
when the discriminator is not specified, andtag = "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:
./bin/generate-samples.sh bin/configs/manual/rust-axum-*
freezes, but manually generating each model still works.postProcessOperationsWithModels
to its own method.oneOf
objects...?oneOf
objects.Fixes #20101
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.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)