Skip to content

docs: document OS-level PAC support and expanded Postman script translations #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document OS-level PAC support and expanded Postman script translations #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion get-started/configure/proxy-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,15 @@

- **Off**: Disables proxy usage.
- **On**: Enables proxy and routes requests through a manually configured proxy.
- **System Proxy**: Uses the system-wide proxy settings.
- **System Proxy**: Uses the system-wide proxy settings, including any OS-level [PAC](https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file) URL configured on macOS, Windows, or Linux.
- **PAC**: Uses a [Proxy Auto-Configuration (PAC)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file) file to determine the proxy for each request.

Select **On** if you want to configure a custom proxy, or **PAC** if your network uses a PAC file for automatic proxy configuration.

<Note>
When **System Proxy** is selected, Bruno also honors any PAC URL configured at the OS level. The detected PAC URL is shown in the preferences panel (or `-` when unset).
</Note>

## 3. Selecting Proxy Protocol

Bruno supports different proxy protocols. Choose one of the following:
Expand All @@ -57,7 +61,7 @@

Fill in the required fields:

- **Hostname**: The proxy server's domain or IP address (e.g., `example.com`).

Check warning on line 64 in get-started/configure/proxy-config.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

get-started/configure/proxy-config.mdx#L64 

Did you really mean 'Hostname'?
- **Port**: The port number for the proxy connection (e.g., `3000`).

## 5. Enabling Authentication (Optional)
Expand Down Expand Up @@ -97,5 +101,5 @@
- **Disabled**: Disables the proxy for this collection.

3. Choose **inherit, enabled, or disabled**.
4. Enter the **Hostname, Port, Protocol, Username, and Password** if needed.

Check warning on line 104 in get-started/configure/proxy-config.mdx

View check run for this annotation

Mintlify / Mintlify Validation (bruno-a6972042) - vale-spellcheck

get-started/configure/proxy-config.mdx#L104 

Did you really mean 'Hostname'?
5. Click **Save** to apply the settings.
20 changes: 20 additions & 0 deletions get-started/import-export-data/script-translator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,26 @@ The translator converts the following Postman `pm.*` APIs to their Bruno equival
| `pm.expect(pm.response.responseTime).to.be.below(N)` | `expect(res.getResponseTime()).to.be.below(N)` |
| `pm.response.to.have.header("name")` | `expect(res.getHeader("name")).to.exist` |
| `pm.expect(x).to.eql(y)` | `expect(x).to.equal(y)` |
| `pm.response.to.be.ok` | `expect(res.getStatus()).to.be.within(200, 299)` |
| `pm.response.to.be.success` | `expect(res.getStatus()).to.be.within(200, 299)` |
| `pm.response.to.be.info` | `expect(res.getStatus()).to.be.within(100, 199)` |
| `pm.response.to.be.redirection` | `expect(res.getStatus()).to.be.within(300, 399)` |
| `pm.response.to.be.clientError` | `expect(res.getStatus()).to.be.within(400, 499)` |
| `pm.response.to.be.serverError` | `expect(res.getStatus()).to.be.within(500, 599)` |
| `pm.response.to.be.error` | `expect(res.getStatus()).to.be.at.least(400)` |
| `pm.response.to.be.accepted` | `expect(res.getStatus()).to.equal(202)` |
| `pm.response.to.be.badRequest` | `expect(res.getStatus()).to.equal(400)` |
| `pm.response.to.be.unauthorized` | `expect(res.getStatus()).to.equal(401)` |
| `pm.response.to.be.forbidden` | `expect(res.getStatus()).to.equal(403)` |
| `pm.response.to.be.notFound` | `expect(res.getStatus()).to.equal(404)` |
| `pm.response.to.be.rateLimited` | `expect(res.getStatus()).to.equal(429)` |
| `pm.response.to.be.withBody` | `expect(res.getBody()).to.not.equal(undefined)` |
| `pm.setNextRequest("name")` | `bru.runner.setNextRequest("name")` |
| `pm.setNextRequest(null)` | `bru.runner.stopExecution()` |

<Info>
Negated forms of the status assertions above are also supported. Both positions of `.not` translate correctly — `pm.response.to.not.be.ok` and `pm.response.to.be.not.ok` both become `expect(res.getStatus()).to.not.be.within(200, 299)`. The same applies to `pm.response.to.not.have.status(...)`, `pm.response.to.not.have.header(...)`, and `pm.response.to.not.have.body(...)`.
</Info>

<Warning>
Any `pm.*` calls not listed above are left unchanged in the translated output. These unsupported calls (such as `pm.sendRequest()`, `pm.cookies`, `pm.variables`, or `pm.iterationData`) will cause runtime errors in Bruno and need to be manually rewritten using the [Bruno scripting API](/testing/script/javascript-reference).
Expand Down
Loading