-
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
rust: remove Default implementation for enums #17294
base: master
Are you sure you want to change the base?
Conversation
PR OpenAPITools#15856 removed the derived Default implementations for structs, but left those for enums. Since enums do not have a sensible default (see OpenAPITools#10845), these should not be derived either. This is technically a breaking change, but it's also a bug fix since Default was intended to be removed in 7.0.0.
Self::{{ enumVars.0.name }} | ||
{{/allowableValues}} | ||
} | ||
} |
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.
cc @Foorack who added these via #10720 to fix regression introduced by #10432 (authored by @PiDelport)
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 would be very thankful if you would introduce a feature flag, as this is also a breaking change. |
@Sngmng: are you referring to a Rust feature flag in the generated code or a flag to control openapi-generator's output? I think adding a Rust feature flag to the generated code would also be a breaking change since that requires declaring the flag in @wing328: Is there a recommended way to flag these sorts of outputs in openapi-generator? Maybe a vendor extension in the OpenAPI spec? |
what about adding an option called "generateDefaultTrait" (default to true) so that template can use {{#generateDefaultTrait}} ... {{/generateDefaultTrait}} to include the corresponding code block if needed? |
PR #15856 removed the derived Default implementations for structs, but left those for enums. Since enums do not have a sensible default (see #10845), they should not have the Default trait implemented either. This is technically a breaking change, but it's also a bug fix since Default itself was a breaking change intended to be removed in 7.0.0.
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
(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)cc: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro