[scala-http4s] Fix name mapping of discriminator property

Merged
MI
5mo ago
+10-10

Fixes #23792
This updates model.mustache for the scala-http4s generator to properly use propertyBaseName instead of propertyName when using nameMappings. Generated Decoders will no longer use the mapped names for lookup, but the actual property. For Encoders 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:

  • No mapping of the discriminator value, no nested oneOfs
  • Mapping of the discriminator value, no nested oneOfs
  • No mapping of the discriminator value, with nested oneOfs
  • Mapping of the discriminator value, with nested oneOfs

For a better understanding, I have updated the example openapi.yaml file 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 type instead 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

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@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-http4s generator so encoders/decoders use the JSON base field name instead of the Scala-safe name, including nested oneOf cases. This makes generated models correctly read and write discriminator fields when nameMappings are used. Fixes #23792.

  • Bug Fixes
    • Use propertyBaseName for discriminator lookups and writes in model.mustache (mapped/unmapped, nested/not nested).
    • Provide parent discriminator via x-parentDiscriminatorBaseName in ScalaHttp4sClientCodegen.java.
    • Result: Decoders read the actual JSON field; Encoders set the expected field.