fix(typescript-angular): handle Set in query parameter serialization#23442
Open
LeovR wants to merge 1 commit intoOpenAPITools:masterfrom
Open
fix(typescript-angular): handle Set in query parameter serialization#23442LeovR wants to merge 1 commit intoOpenAPITools:masterfrom
LeovR wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
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.
Fixes #23434
When a query parameter is defined with
type: arrayanduniqueItems: true, the typescript-angular generator produces aSet<T>type. However,addToHttpParamsonly checksArray.isArray(value)to detect collections. SinceArray.isArray(new Set())returnsfalse, theSetfalls through to the object-handling branch and query parameters are silently lost.This adds a
value instanceof Setcheck alongsideArray.isArray(value)in theaddToHttpParamsmethod ofapi.base.service.mustache. When aSetis detected, it is converted to anArraybefore serialization.cc @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha @dennisameling
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
Fixes lost query params when
uniqueItems: truearrays generateSet<T>in thetypescript-angularclient by serializingSetlike arrays inaddToHttpParams. Fixes #23434.api.base.service.mustache, detectSetvalues inaddToHttpParamsand serialize them viaArray.from(...)for form, space-delimited, and pipe-delimited styles.query-param-form.yamlwith atagsquery param (array,uniqueItems: true) to produceSet<string>.default.service.ts) and tests to verifySetserialization for explode and non-explode cases.Written for commit 6cdc1b5. Summary will update on new commits.