[Runtime] Support unexploded query items #35
Merged
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
…ility, so splitting and deprecating the old methods instead
glbrntt
reviewed
Aug 7, 2023
glbrntt
approved these changes
Aug 8, 2023
czechboy0
added a commit
to apple/swift-openapi-generator
that referenced
this pull request
Aug 8, 2023
[Generator] Support unexploded query items ### Motivation Depends on apple/swift-openapi-runtime#35. Fixes #52. By default, query items are encoded as exploded (`key=value1&key=value2`), but OpenAPI allows explicitly requesting them unexploded (`key=value1,value2`). This feature missing has shown up in a few OpenAPI documents recently. ### Modifications Adapt the generator to provide the two new `style` and `explode` parameters to query item encoding/decoding functions. ### Result We now support unexploded query items. ### Test Plan Expanded snippet-based tests to allow generating not just types, but also parts of the client/server. This has allowed us to not have to expand file-based reference tests here. Reviewed by: glbrntt Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (docc test) - Build finished. ✔︎ pull request validation (integration test) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #171
gjcairo
reviewed
Aug 8, 2023
| } else { | ||
| processedValues = untypedValues.flatMap { multiValue in | ||
| multiValue | ||
| .split(separator: ",", omittingEmptySubsequences: false) |
There was a problem hiding this comment.
I'm sorry for the late comment, but in theory I assume it would be possible to have values with commas in them. Would the commas be escaped or percent-encoded in this case? Just want to make sure this split doesn't split the string at incorrect places.
There was a problem hiding this comment.
Yeah exactly, if the comma is part of the value, it is percent escaped.
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.
Motivation
Fixes apple/swift-openapi-generator#52.
By default, query items are encoded as exploded (
key=value1&key=value2), but OpenAPI allows explicitly requesting them unexploded (key=value1,value2). This feature missing has shown up in a few OpenAPI documents recently.Modifications
Add support for unexploded query items by expanding the helper functions and allow passing in
styleandexplodeparameters. Thestyleis in preparation of also supporting alternative styles, but for now we just validate that only the supported style is provided.Result
Generated code can use these improved helper functions to encode/decode unexploded query items.
Test Plan
Updated/added unit tests for unexploded query items.