Collections

A collection groups requests. It can hold folders, and folders can hold more folders. Each level can have its own variables, authorization and scripts. These settings apply to every request below that level.

Each collection is one JSON file in the workspace.

Request types

A request is HTTP, gRPC or WebSocket. You choose the type when you create the request. You cannot change it later.

In the tree:

• An HTTP request shows its method: GET, POST, PUT, PATCH, DEL, HEAD or OPT.
• The other types show gRPC or WS.

Guides for each type:

• HTTP: HTTP requests
• gRPC: gRPC
• WebSocket: WebSocket

Create

Organise

• Rename: press F2 on a row, or use the context menu Rename. You can also use the name field at the top of a collection or folder tab. Rename a request from its builder tab.
• Duplicate: context menu Duplicate makes a deep copy with fresh ids. The copy is named <name> Copy. Duplicating a collection also copies its assets.
• Copy, cut, paste: use Cmd/Ctrl+C, Cmd/Ctrl+X, Cmd/Ctrl+V, or the context menu.
  • A pasted item gets a unique name under its new parent: Name, Name Copy, Name Copy 2, and so on.
  • Paste on a collection or folder pastes inside it.
  • Paste on a request pastes into that request's collection.
• Move: drag rows in the sidebar.
  • Drop on a folder to nest the item. Drop between rows to reorder.
  • Cmd/Ctrl-drag copies instead of moving.
  • A drop into an item's own subtree is refused.
  • A multi-selection (Cmd/Ctrl-click, Shift-click) moves together.
• Delete: use context menu Delete or the Delete key. Collections and folders ask you to type delete. Requests and environments go straight to the trash.
• Undo: Cmd/Ctrl+Z undoes the last rename or move. Cmd/Ctrl+Shift+Z redoes it. Deleting is not undone this way.
• Other context-menu items: Run (collection or folder), Export collection, and for requests Add example, Copy as cURL and Open in new tab.

Collection and folder tabs

Open a collection or folder to get a detail tab. A dot next to a tab name means the tab has content. Changes autosave shortly after you stop typing.

The tab header has:

• An editable name.
• A ... menu: New request, New folder (collections only), Duplicate, Export and Delete.
• A Run button. It opens the collection runner for this collection or folder.

Inheritance

Variables, auth and scripts resolve from the outside in:

• Variables: a folder variable overrides a collection variable of the same name. The innermost folder wins. See the precedence table.
• Auth: a request set to Inherit uses the closest folder above it that sets its own auth. If no folder sets auth, it uses the collection's. No Auth stops the search.
• Scripts: run in this order:
  1. The collection script.
  2. Folder scripts, from the outermost to the innermost folder.
  3. The request's own script.

Assets

The Assets tab manages files stored in <workspace>/assets/<collection id>/. Scripts read them (pg.assets, require, fs). Request bodies embed them with shortcodes.

• Import files… and Import folder… copy files in. A folder keeps its structure.
• The search field filters the list. Columns are Path, Size and Modified.
• Each row has Rename, delete (asks Delete or Cancel) and Copy shortcode. Copy shortcode copies {{% base64(file('<path>')) %}} to the clipboard.
• Limits:
  • Depth: 16.
  • Files: 10,000.
  • File size: 100 MiB per file.
  • Import size: 2 GiB per import.
  • Paths: up to 1,024 bytes, and 255 bytes per component.
• Every path is checked to stay inside the collection's folder. Neither .. nor symbolic links can reach outside.
• A replaced or deleted asset keeps one <name>.bak. It is never listed.
• Importing a Bruno folder copies its other files here with their relative paths. See Import and export.