[scala-http4s] Fix name mapping of discriminator property#23853
Open
MichaelKutzner wants to merge 4 commits into
Open
[scala-http4s] Fix name mapping of discriminator property#23853MichaelKutzner wants to merge 4 commits into
MichaelKutzner wants to merge 4 commits into
Conversation
6 tasks
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.
Fixes #23792
This updates
model.mustachefor thescala-http4sgenerator to properly usepropertyBaseNameinstead ofpropertyNamewhen usingnameMappings. GeneratedDecoders will no longer use the mapped names for lookup, but the actual property. ForEncoders the opposite holds true and the generator will now set the expected property.Notice that there are four cases handled, which should all be updated with this fix:
oneOfsoneOfsoneOfsoneOfsFor a better understanding, I have updated the example
openapi.yamlfile from the issue, so each of these cases can be tested, if the corresponding lines are uncommented:https://github.com/MichaelKutzner/openapi-discriminator-example/blob/50d8b38a5813107a98a699c60a18711b019d0036/openapi.yaml#L50-L56
For verification, check that the generated code uses
typeinstead of`type`, as explained in the issue.As I could change all cases without breaking any tests, I think, that it might be good to make some improvements there as well. But I don't know where to start.
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.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)@clasnake (2017/07), @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04) @Fish86 (2023/06)
Summary by cubic
Fixes discriminator name mapping in the
scala-http4sgenerator so encoders/decoders use the JSON base field name instead of the Scala-safe name, including nestedoneOfcases. This makes generated models correctly read and write discriminator fields whennameMappingsare used. Fixes #23792.propertyBaseNamefor discriminator lookups and writes inmodel.mustache(mapped/unmapped, nested/not nested).x-parentDiscriminatorBaseNameinScalaHttp4sClientCodegen.java.Written for commit f38a62e. Summary will update on new commits. Review in cubic