Create Bruno Collection
create_collectionCreates a Bruno API collection at a chosen path and registers it in the workspace so it appears in list_collections and the Bruno app.
Instructions
Create a new Bruno API testing collection with configuration. outputPath is the PARENT directory and name is appended to it: outputPath "/work/apis" with name "Billing" creates the collection at /work/apis/Billing. Do not put the collection name in outputPath as well. The new collection is also added to the workspace registry, because list_collections reads that registry and not the disk: a collection that is not listed there is invisible to it and to the Bruno app. The result says whether it was registered and, if not, why.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| format | No | yaml | |
| ignore | No | ||
| baseUrl | No | ||
| outputPath | Yes | Absolute path of the PARENT directory to create the collection directory in. name is appended to it, so outputPath "/work/apis" with name "Billing" creates /work/apis/Billing. Passing "/work/apis/Billing" here would create /work/apis/Billing/Billing. | |
| description | No | ||
| workspacePath | No | Absolute path of the workspace.yml to register the new collection in. Defaults to the same one list_collections reads: BRUNO_WORKSPACE_PATH, or the Bruno app's workspace for this platform. | |
| registerInWorkspace | No | Set false to create the collection without touching any workspace file. It will not appear in list_collections until something else registers it. |