Add "encodeParams" option to rtkq-codegen-openapi #4568
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.
Overview
This PR introduces a new
encodeParams
option to the Redux Toolkit Query (RTKQ) OpenAPI code generator. When enabled, this option will automatically applyencodeURIComponent
to the generated query parameters, ensuring that special characters in query strings are correctly encoded.This feature will be useful for users who need to ensure their query parameters are URL safe, particularly in cases where special characters are commonly used.
Fixes #3822
This PR:
encodeParams
option to automatically perform URL safe encoding to the generated query and path parametersencodeParams
optionflattenArg
test case which was not passing due to formatting