fix(request-snippets): escape pipe character in cURL CMD snippets #10695
+1
−0
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
The vertical bar character (|) is a special character in Windows CMD that is used for piping commands. When the request body contains a pipe character, the generated cURL command fails because CMD interprets it as a pipe operator. This fix escapes the pipe character with a caret (^|) in the escapeCMD function, consistent with how other special characters like ^ and newlines are handled. Fixes swagger-api#10540
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR fixes the issue where the vertical bar character (
|) in the request body is not escaped in cURL (CMD) snippets.Problem
As described in #10540, when the request body contains a pipe character, the generated cURL command fails in Windows CMD because it is interpreted as a pipe operator.
Solution
Added
.replace(/\|/g, "^|")to theescapeCMDfunction to escape pipe characters with a caret (^).Related Issue
Fixes #10540