[Kotlin][Client] Enum toString handling #5327
Conversation
This toString avoids using the enum var name and uses the enum's value instead. This will fix cases when enum var name and value are quite different.
|
Thanks for your contribution 👍 |
modules/openapi-generator/src/main/resources/kotlin-client/enum_class.mustache
Outdated
Show resolved
Hide resolved
Co-Authored-By: Jim Schubert <[email protected]>
|
@4brunu I already run this but it caused no changes to the sample project. I guess the sample project are not using any enums? |
Looks like there are only two enums in the test yaml for Kotlin: a query string and a model property. We might want to regenerate at some point later with a yaml that tests more use cases. The Shippable error was a failure to build Elixir client due to Shippable being flaky. I've kicked off a rebuild. If it fails again, we shouldn't let this block merging. |
We should switch to the fake petstore spec which contains a lot more tests for enum. Last time I tried to switch but got compilation errors. I'll test again later to see if these PRs for the Kotlin generators fix the issue. |
* Added toString to enum_class script This toString avoids using the enum var name and uses the enum's value instead. This will fix cases when enum var name and value are quite different. * Updated enum template Co-Authored-By: Jim Schubert <[email protected]> Co-authored-by: Jim Schubert <[email protected]>
|
@Mordag thanks for the PR, which has been included in the 4.3.0 release: https://twitter.com/oas_generator/status/1243455743937789952 |
I have noticed that in certain cases, the enum usage for path parameter and url query parameter is incorrectly implemented.
In the case I have an enum with MY_ENUM("MyEnum") and I am using the enum as a path parameter. The path would look like that "myPath/.../MY_ENUM/...". This request would always fail. That is due to the different enum value than the server would expect.
To fix this issue, I suggest we add a custom toString to every enum class so that we will not use the enum var name but the value. That way the path would look like this "myPath/.../MyEnum/...".
Changes made with this PR:
PR checklist
./bin/(or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).master,4.3.x,5.0.x. Default:master.@jimschubert (2017/09) ❤️, @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11)