Fixes #10540 — Vertical bar character | not escaped in cURL (CMD) request snippet body by Divyanshu-Mishra9620 · Pull Request #10596 · swagger-api/swagger-ui

Divyanshu-Mishra9620 · 2025-10-08T13:16:29Z

Problem

When generating cURL (CMD) request snippets, the vertical bar character | in the request body was not escaped. In Windows CMD, this causes the string after | to be interpreted as a command, resulting in errors.

Solution

Updated the CMD snippet generator to escape | as ^| in the request body.
Enabled request snippets in the dev environment for easier testing.

Testing

Verified that the generated cURL (CMD) snippet now escapes | as ^|.
Confirmed that pasting the snippet in Windows CMD no longer causes command parsing errors.

Before

After the change=> .replace(/|/g, "^|")

…ippet body for Windows CMD compatibility

…er-pipe-not-escaped-curl-cmd-snippet

Divyanshu-Mishra9620 · 2025-10-08T16:31:29Z

@MichakrawSB Please can you review this pr

glowcloud · 2025-10-09T07:37:05Z

Hi @Divyanshu-Mishra9620,

Thanks for this fix! The fix itself seems fine to me, but could you please remove changes unrelated to the issue? Also, could you provide a test for your fix? It should be located under test/unit/core/plugins/request-snippets/fn.js.

…dd unit test. Remove unrelated changes.

…scaped-curl-cmd-snippet' of https://github.com/Divyanshu-Mishra9620/swagger-ui into fix-swagger-api#10540-Vertical-bar-character-pipe-not-escaped-curl-cmd-snippet

…er-pipe-not-escaped-curl-cmd-snippet

Divyanshu-Mishra9620 · 2025-10-09T15:53:26Z

Hi @Divyanshu-Mishra9620,

Thanks for this fix! The fix itself seems fine to me, but could you please remove changes unrelated to the issue? Also, could you provide a test for your fix? It should be located under test/unit/core/plugins/request-snippets/fn.js.

Title: Fix: Escape vertical bar (|) in cURL (CMD) request snippet body (#10540)

Description:

Escapes the vertical bar character | in cURL (CMD) request snippets with a caret ^ for Windows CMD compatibility.
Adds a unit test for escapeCMD in fn.js to verify the fix.

Removes unrelated changes and unnecessary files from the PR.

These .LICENSE.txt files in the dist folder are automatically generated by Webpack when building the project.

Testing:

All tests pass, including the new unit test for CMD snippet escaping.

glowcloud

Thanks for the tests! I left a few comments requesting some changes.

As for the changes to files in the dist folder - they are updated only during the release process, as can be seen in the commit history here.

dev-helpers/dev-helper-initializer.js

src/core/plugins/request-snippets/fn.js

test/unit/core/plugins/request-snippets/fn.test.js

Co-authored-by: Oliwia Rogala <oliwia.rogala97@gmail.com>

Removed test case for escaping vertical bar in bash.

Divyanshu-Mishra9620 · 2025-10-11T12:54:58Z

Thanks for the tests! I left a few comments requesting some changes.

As for the changes to files in the dist folder - they are updated only during the release process, as can be seen in the commit history here.

Hey @glowcloud made the changes as suggested.

glowcloud

Hi @Divyanshu-Mishra9620,

I requested some last changes:

I tested the PR locally and the linting did not pass for the test file. Our style guide prefers using double quotes when possible and avoids semicolons - I left comments related to that.
As mentioned before, we do not accept changes to any files in dist folder through PRs. Please remove any changes done there.

glowcloud · 2025-10-13T06:24:00Z

test/unit/core/plugins/request-snippets/fn.test.js

+
+describe("escapeCMD", () => {
+  it("escapes vertical bar | with caret ^ for CMD", () => {
+    const input = 'foo|bar';


Suggested change

const input = 'foo|bar';

const input = "foo|bar"

glowcloud · 2025-10-13T06:24:08Z

test/unit/core/plugins/request-snippets/fn.test.js

+describe("escapeCMD", () => {
+  it("escapes vertical bar | with caret ^ for CMD", () => {
+    const input = 'foo|bar';
+    const output = escapeCMD(input);


Suggested change

const output = escapeCMD(input);

const output = escapeCMD(input)

glowcloud · 2025-10-13T06:24:23Z

test/unit/core/plugins/request-snippets/fn.test.js

+  it("escapes vertical bar | with caret ^ for CMD", () => {
+    const input = 'foo|bar';
+    const output = escapeCMD(input);
+    expect(output).toContain('^|');


Suggested change

expect(output).toContain('^|');

expect(output).toContain("^|")

glowcloud · 2025-10-13T06:24:35Z

test/unit/core/plugins/request-snippets/fn.test.js

+    const input = 'foo|bar';
+    const output = escapeCMD(input);
+    expect(output).toContain('^|');
+  });


Suggested change

});

})

glowcloud · 2025-10-13T06:24:51Z

test/unit/core/plugins/request-snippets/fn.test.js

+  });
+
+  it("escapes other CMD special characters", () => {
+    expect(escapeCMD('foo^bar')).toContain('^^');


Suggested change

expect(escapeCMD('foo^bar')).toContain('^^');

expect(escapeCMD("foo^bar")).toContain("^^")

glowcloud · 2025-10-13T06:25:01Z

test/unit/core/plugins/request-snippets/fn.test.js

+
+  it("escapes other CMD special characters", () => {
+    expect(escapeCMD('foo^bar')).toContain('^^');
+    expect(escapeCMD('foo"bar')).toContain('""');


Suggested change

expect(escapeCMD('foo"bar')).toContain('""');

expect(escapeCMD('foo"bar')).toContain('""')

glowcloud · 2025-10-13T06:25:07Z

test/unit/core/plugins/request-snippets/fn.test.js

+  it("escapes other CMD special characters", () => {
+    expect(escapeCMD('foo^bar')).toContain('^^');
+    expect(escapeCMD('foo"bar')).toContain('""');
+  });


Suggested change

});

})

glowcloud · 2025-10-13T06:25:13Z

test/unit/core/plugins/request-snippets/fn.test.js

+    expect(escapeCMD('foo^bar')).toContain('^^');
+    expect(escapeCMD('foo"bar')).toContain('""');
+  });
+});


Suggested change

});

})

- Add vertical bar (|) escaping in escapeCMD function - Update test to use double quotes and no semicolons per project style guide - Revert dev-helper-initializer.js to previous commented state Fixes swagger-api#10540

- Remove all changes to dist/ folder as they are not accepted in PRs - Remove unrelated changes to source files not part of the bug fix - Keep only the vertical bar escaping fix and its test

Divyanshu-Mishra9620 · 2025-10-14T09:42:38Z

@glowcloud Hey i have fixed, if the issue still exist i will work on that.

lukaszzazulak · 2025-10-18T09:13:19Z

src/core/components/responses.jsx

    const regionId = createHtmlReadyId(`${method}${path}_responses`)
    const controlId = `${regionId}_select`

-    return (!nonExtensionResponses || !nonExtensionResponses.size) ? null : (


what was the reason of removing this code ? is this related to the vertical bar character problem ?

lukaszzazulak · 2025-10-18T09:31:32Z

@glowcloud Hey i have fixed, if the issue still exist i will work on that.

@Divyanshu-Mishra9620 It look like there are still changes unrelated to the bug, have a look at my comment for example.

…) and revert unrelated changes

Divyanshu-Mishra9620 · 2025-10-18T18:06:26Z

This PR fixes issue #10540 by ensuring the vertical bar (|) character is properly escaped in CMD request snippets.

In an earlier commit, I mistakenly changed unrelated logic in the Responses component (removing the nonExtensionResponses filter). This was not related to the vertical bar bug and was an oversight. I have now reverted those changes, and this PR only contains the intended bug fix and its related test.

…er-pipe-not-escaped-curl-cmd-snippet

Divyanshu-Mishra9620 and others added 2 commits October 8, 2025 18:31

Fix swagger-api#10540: Escape vertical bar | in cURL (CMD) request sn…

1cc3f61

…ippet body for Windows CMD compatibility

Merge branch 'master' into fix-swagger-api#10540-Vertical-bar-charact…

5c4a6ff

…er-pipe-not-escaped-curl-cmd-snippet

Divyanshu-Mishra9620 and others added 3 commits October 9, 2025 21:06

Fix: Escape vertical bar (|) in cURL (CMD) request snippet body and a…

cd5a5f4

…dd unit test. Remove unrelated changes.

Merge branch 'fix-swagger-api#10540-Vertical-bar-character-pipe-not-e…

7817108

…scaped-curl-cmd-snippet' of https://github.com/Divyanshu-Mishra9620/swagger-ui into fix-swagger-api#10540-Vertical-bar-character-pipe-not-escaped-curl-cmd-snippet

Merge branch 'master' into fix-swagger-api#10540-Vertical-bar-charact…

de1eb15

…er-pipe-not-escaped-curl-cmd-snippet

glowcloud reviewed Oct 10, 2025

View reviewed changes

dev-helpers/dev-helper-initializer.js Outdated Show resolved Hide resolved

src/core/plugins/request-snippets/fn.js Outdated Show resolved Hide resolved

test/unit/core/plugins/request-snippets/fn.test.js Outdated Show resolved Hide resolved

Divyanshu-Mishra9620 and others added 4 commits October 11, 2025 18:11

Update dev-helpers/dev-helper-initializer.js

52824ee

Co-authored-by: Oliwia Rogala <oliwia.rogala97@gmail.com>

Export escapeCMD function from fn.js

957a524

Remove test for vertical bar escaping in bash

7a3f6a3

Removed test case for escaping vertical bar in bash.

Enable request snippets in Swagger UI configuration

a007477

glowcloud reviewed Oct 13, 2025

View reviewed changes

Divyanshu-Mishra9620 added 4 commits October 14, 2025 14:44

Fix vertical bar escaping in CMD and apply code style compliance

3be6f2f

- Add vertical bar (|) escaping in escapeCMD function - Update test to use double quotes and no semicolons per project style guide - Revert dev-helper-initializer.js to previous commented state Fixes swagger-api#10540

Resolve merge conflicts and maintain style compliance

26ac9c9

Remove dist files and unrelated changes per maintainer feedback

8061728

- Remove all changes to dist/ folder as they are not accepted in PRs - Remove unrelated changes to source files not part of the bug fix - Keep only the vertical bar escaping fix and its test

Remove dist LICENSE.txt files that shouldn't be in repository

fabb391

lukaszzazulak reviewed Oct 18, 2025

View reviewed changes

fix: escape vertical bar (|) in CMD request snippets (swagger-api#10540…

189ed8d

…) and revert unrelated changes

Merge branch 'master' into fix-swagger-api#10540-Vertical-bar-charact…

4c7faf5

…er-pipe-not-escaped-curl-cmd-snippet

MichakrawSB assigned Divyanshu-Mishra9620 Nov 15, 2025

	const output = escapeCMD(input);
	const output = escapeCMD(input)

	expect(output).toContain('^\|');
	expect(output).toContain("^\|")

	expect(escapeCMD('foo^bar')).toContain('^^');
	expect(escapeCMD("foo^bar")).toContain("^^")

	expect(escapeCMD('foo"bar')).toContain('""');
	expect(escapeCMD('foo"bar')).toContain('""')

Conversation

Divyanshu-Mishra9620 commented Oct 8, 2025

Problem

Solution

Testing

Before

After the change=> .replace(/|/g, "^|")

Uh oh!

Divyanshu-Mishra9620 commented Oct 8, 2025

Uh oh!

glowcloud commented Oct 9, 2025

Uh oh!

Divyanshu-Mishra9620 commented Oct 9, 2025

Title: Fix: Escape vertical bar (|) in cURL (CMD) request snippet body (#10540)

Description:

Removes unrelated changes and unnecessary files from the PR.

Testing:

Uh oh!

glowcloud left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Divyanshu-Mishra9620 commented Oct 11, 2025

Uh oh!

glowcloud left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Divyanshu-Mishra9620 commented Oct 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukaszzazulak commented Oct 18, 2025

Uh oh!

Divyanshu-Mishra9620 commented Oct 18, 2025

This PR fixes issue #10540 by ensuring the vertical bar (|) character is properly escaped in CMD request snippets.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants