refactor(kotlin): remove unknown default enum case for inline operation enums in multiplatform library - #24521
Open
Mattias-Sehlstedt wants to merge 1 commit into
Conversation
…on enums in multiplatform library
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 7 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR changes how
enumUnknownDefaultCaseis handled with the operations inline enum support that was introduced to the kotlinmultiplatformlibrary with #16327.The background is that we do not want to have to conduct mustache magic with regards to hiding the unnecessary
enumUnknownDefaultCasecase (hidden since these enums are only used to send values).It is also tied to being able to place the
;after the last enum value, this so that the.toString()can be overridden in the enum, which would solve this issue.Thus we move the handling of the ignoring/removal of the
enumUnknownDefaultCasefrom the mustache file to the client codegen.Kotlin committee:
@karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10)
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.
Summary by cubic
Remove the
unknown_default_open_apienum case from inline operation enums in the Kotlinmultiplatformclient and move default-case handling from the template into codegen. This simplifies generated APIs and allows a trailing semicolon on enum declarations so enum methods (e.g.,toString()) can be added.Refactors
injectEnumUnknownDefaultCaseandremoveEnumUnknownDefaultCaseinDefaultCodegen; remove default enum case for non-body operation params.KotlinClientCodegenfor themultiplatformlibrary.kotlin-client/libraries/multiplatform/api.mustacheby removingenumUnknownDefaultCasebranching and always adding;after the last enum value.Tests
multiplatform-inline-query-enum.yamland a test ensuring inline header/query/path enums omit the default case while model/referenced enums keep it.;in generated enums.Written for commit 868633d. Summary will update on new commits.