openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[Kotlin Spring] fix template request part and description

Open hahny93 opened this issue 2 years ago • 5 comments

So, what happend to us was that we had a particular problem with a file upload. We created the server side as well as the client side with OpenAPI generators and the typescript-angular client did not end up matching the naming in our endpoints. We discovered, that the Kotlin Spring generator did ignore any description and parameter names on multipart-form parameters.

This ended up being a smaller fix since I could look up on how the Java Spring generator behaves and how that template looked. Turns out, that the description and parameter name was just not used in all places, rather "file" and "file details" were just constantly.

PR checklist

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) 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.
  • [x] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

hahny93 avatar Feb 08 '24 08:02 hahny93

Hey @jimschubert @dr4ke616 would You please check out this MR and confirm I did not break anything? Thanks a lot!

hahny93 avatar Feb 08 '24 08:02 hahny93

can you please file a new one based on the latest master, which is for 7.4.0-SNAPSHOT version with updated samples?

wing328 avatar Feb 08 '24 09:02 wing328

can you please file a new one based on the latest master, which is for 7.4.0-SNAPSHOT version with updated samples?

Updated the branch to 7.4.0-SNAPSHOT and generated samples and docs again 👍🏻

hahny93 avatar Feb 08 '24 10:02 hahny93

thanks for the PR. I don't think https://github.com/OpenAPITools/openapi-generator/actions/runs/7827963718/job/21356869103?pr=17821 is caused by this change but if you've any clue, please let me know.

wing328 avatar Feb 08 '24 10:02 wing328

thanks for the PR. I don't think https://github.com/OpenAPITools/openapi-generator/actions/runs/7827963718/job/21356869103?pr=17821 is caused by this change but if you've any clue, please let me know.

Was there any change in the build pipeline? Because as soon as you let the kotlin-spring-boot-request subproject generate all of the classes the build seems to run trough. (and not just interfaces) image

hahny93 avatar Feb 08 '24 11:02 hahny93