Skip to content

Fill gaps from assistant conversations: fix bru.runRequest() docs - #154

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/b17edd9d
Open

Fill gaps from assistant conversations: fix bru.runRequest() docs#154
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/b17edd9d

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Correct the documented response shape and path parameter for bru.runRequest() in the Request Chaining pages so users can chain requests without needing the assistant to fill in gaps.

Changes

  • Response fields corrected to match runtime: parsed body lives on response.data (not body), and the timing/size fields are duration, size, and url (not responseTime).
  • Added a callout that flags the response.data vs res.body difference between bru.runRequest() results and post-response res.
  • Rewrote the path parameter description with concrete examples for root-level ("Login") and nested ("auth/Login") requests, resolved from the collection root.
  • Applied the same fixes in testing/script/request-chaining.mdx, v2/testing/script/request-chaining.mdx, and v3/testing/script/request-chaining.mdx.

Context

Assistant conversations showed repeated confusion about bru.runRequest() — users tried response.body (per the docs) and got undefined, and asked how to derive the "absolute path". Verified against packages/bruno-electron/src/ipc/network/index.js and packages/bruno-js/src/runtime/scripted-entries.js in usebruno/bruno, which resolve a relative pathname from the collection root and return { status, statusText, headers, data, duration, size, url, ... }.

@mintlify

mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
bruno-docs-main 🟢 Ready View Preview Aug 3, 2026, 5:13 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants