feat: add x-allowReserved support for query parameters in respect#2656
Merged
feat: add x-allowReserved support for query parameters in respect#2656
Conversation
🦋 Changeset detectedLatest commit: 4d2a398 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Coverage Report
File Coverage
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contributor
|
Contributor
|
📦 A new experimental 🧪 version v0.0.0-snapshot.1773672987 of Redocly CLI has been published for testing. Install with NPM: npm install @redocly/cli@0.0.0-snapshot.1773672987
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1773672987
# or
npm install @redocly/respect-core@0.0.0-snapshot.1773672987 |
JLekawa
approved these changes
Mar 16, 2026
tests/e2e/respect/allow-reserved-query-param/allow-reserved-query-param.arazzo.yaml
Outdated
Show resolved
Hide resolved
DmitryAnansky
requested changes
Mar 17, 2026
Contributor
|
Consider adding some documentation for your new extension (check |
Contributor
cc: @Redocly/technical-writers |
Contributor
|
Could you please also update PR title and description. |
…r and built-in rules
5 tasks
JLekawa
reviewed
Mar 18, 2026
JLekawa
approved these changes
Mar 18, 2026
DmitryAnansky
approved these changes
Mar 18, 2026
.../respect-core/src/modules/__tests__/description-parser/get-request-data-from-openapi.test.ts
Outdated
Show resolved
Hide resolved
packages/respect-core/src/modules/__tests__/flow-runner/prepare-request.test.ts
Outdated
Show resolved
Hide resolved
packages/respect-core/src/modules/description-parser/get-request-data-from-openapi.ts
Show resolved
Hide resolved
tests/e2e/respect/allow-reserved-query-param/allow-reserved-query-param.test.ts
Outdated
Show resolved
Hide resolved
tests/e2e/respect/x-allow-reserved-query-param/x-allow-reserved-query-param.test.ts
Outdated
Show resolved
Hide resolved
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
3 participants
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.
What/Why/How?
What: Support for leaving RFC 3986 reserved characters unencoded in query parameter values when running Respect tests.
allowReservedfrom the operation’s query parameters is respected.x-operation), thex-allowReservedextension can be used on a parameter, sinceallowReservedis not part of the Arazzo spec.Why: Matches Portal Replay behavior: with
allowReserved: true/x-allowReserved: true, reserved characters in query values (e.g.: / ? # [ ] @ ! $ & ' ( ) * + , ; =) stay unencoded so URL-like values (e.g. callback URLs) work as intended.How:
allowReservedfrom operation parameters inget-request-data-from-openapiand pass it through onParameterWithIn.x-allowReservedextension (core type + arazzo schema); inresolveParameters, mapx-allowReservedto internalallowReserved.encodeURIValue(value, allowReserved)inbuildQueryStringfor query values instead of encoding reserved chars everywhere;api-fetcherpasses the flag through from parameters.Reference
resolves https://github.com/Redocly/redocly/issues/21326
docs Redocly/website#269
Testing
Screenshots (optional)
Check yourself
Security