Single quotes in content, headers, or parameters produce unexecutable curl and HTTPie snippets - #1058
Open
harrisleesh wants to merge 1 commit into
Open
harrisleesh wants to merge 1 commit into
harrisleesh wants to merge 1 commit into
Conversation
Values were interpolated into single-quoted shell strings without escaping, so content, header values, credentials, cookies, form parameters, multipart part content and file names containing a single quote produced snippets with unterminated quoting that fail when pasted into a shell. Apply the standard POSIX single-quote escape at every single-quoted interpolation site. Fixes spring-projectsgh-1055 Signed-off-by: seonghun lee <harrisleesh@gmail.com>
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
2 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.
Fixes gh-1055
Values were interpolated into single-quoted shell strings without escaping, so a request body such as
{"name": "O'Brien"}produced-d '{"name": "O'Brien"}'— an unterminated quote that fails when the documented command is pasted into a shell. Header values, credentials, cookies, form parameters, multipart part content and file names had the same problem in bothCurlRequestSnippetandHttpieRequestSnippet.The standard POSIX single-quote escape (
'→'\'') is now applied at every single-quoted interpolation site. Added regression tests for body content and header values in both snippet types (8 failing executions onmain, all passing with the fix);spring-restdocs-corechecks pass (899 tests).