[kotlin][client] Explode query param properly #20714
Merged
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.
Problem
It's not possible to use request objects in the API (e.g.
findItems(SearchRequest(name, status, fromDate, ...))
). One more example is a pagination parameter, something likePage(size,offset)
. I'd like to use a model in the API but it's not possible at the moment.Kotlin Client generator is not exploding a query object properly. It uses the object
toString()
method, so API request doesn't work. See OpenAPI Parameter Serialization.Used
isModel
,isDeepObject
,vars
template variables to filllocalVariableQuery
with the fields of the query object.It should work fine for objects with primitive, enum, date props. The behavior for nested objects and arrays is undefined (And it is mentioned in the doc)
The generated
QueryApi.kt
sample from the echo-api shows the expected query parameters.To close #20715
CC: @dr4ke616 @karismann @Zomzog @andrewemery @4brunu @yutaka0m @stefankoppier @e5l
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.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)