[kotlin-spring] add @ModelAttribute to complex non-json query params#23876
Closed
Picazsoo wants to merge 9 commits into
Closed
[kotlin-spring] add @ModelAttribute to complex non-json query params#23876Picazsoo wants to merge 9 commits into
Picazsoo wants to merge 9 commits into
Conversation
…lin Spring codegen
…y parameters; add tests
Contributor
Author
|
This implementation is mostly nonsense and was based on incorrect understanding of the matters. Closing the PR. |
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 fixes kotlin-spring generator to correctly annotate complex query parameters (
isModel=true) with@ModelAttribute("paramName"). Previously, model query params received no Spring binding annotation at all, which meant Spring couldn't reliably bind nested fields likefilter.statuses=activein Kotlin where parameter names aren't discoverable without-java-parameterscompile flag. Additionally, query params with hyphenated names (e.g.order-status,item-status) that can't be Kotlin identifiers had no way to be bound at all without the explicit annotation value.A guard was added for the
content: application/jsoncase so when the parameter carries a JSON-encoded object as a single string on the parameter (e.g.?filter={"statuses":["active"]}),@ModelAttributewould be wrong - Spring's data binder would try to readfilter.statuses=…style fields rather than deserializing the JSON blob. These params instead properly get@RequestParamannotation, which delivers the raw string to a (user provided and registered)Converter<String, T>.Tests:
Note: I will eventually implement the same in java-spring as well.
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)Summary by cubic
Adds @ModelAttribute("") for complex (model) query parameters in
kotlin-springto enable deepObject binding and preserve wire names, while keeping @RequestParam for JSON-encoded (content: application/json) query params. Updates samples and tests to verify correct binding, including hyphenated names, multiple model params, and valid-identifier params.@ModelAttribute("<baseName>")for deepObject/form-style; use @RequestParam when the param usescontent: application/json.OrderStatusschema, a KotlinOrdersApiimplementation with runtime assertions, a Java controller, and tests (MockMvc + codegen) covering hyphenated names, multiple model params, valid-identifier params, and the JSON-content exclusion.Written for commit 2634014. Summary will update on new commits. Review in cubic