[kotlin][client] Explode query param properly#20714
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom Feb 26, 2025
Merged
Conversation
6 tasks
ebc8854 to
263057a
Compare
3c3476f to
8391747
Compare
Contributor
Author
|
@dr4ke616 @karismann @Zomzog @andrewemery @4brunu @yutaka0m @stefankoppier @e5l or anybody, hey folks! could you explain what does this message mean? I'm curious if it's a blocker for review |
Member
|
thanks for the PR, which has been merged |
Contributor
Author
Thanks for looking into it. qq: does the above "Merging is blocked" just say me that I have no permissions to merge? The message is unclear then, it looks like there are some settings in the repo blocking merge) |
Member
|
i would think so (i don't see this message in my side as i've the merge right) |
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.

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,varstemplate variables to filllocalVariableQuerywith 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.ktsample 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.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)