Collections

A collection is a set of saved requests, grouped into folders and kept in zyvra.collections.yaml so you can commit it. The Collections page shows what each one holds; API Client has the same collections in a sidebar next to the request you are editing.

The Collections page

Choose a collection and you see:

• how it is doing: the result of its last run, what it shares with every request, and its variables;
• Run history as one closable line. Open it to see the runs, or leave it folded;
• Folders on the left, with how many requests each holds, and Requests on the right. With many folders the list gets a search box and scrolls inside its own panel, and nested folders can be folded. The requests have a search box and are shown 25 to a page.

Choose a folder to see only its requests, or All requests to see them all.

Shared settings

A collection or a folder can set auth, headers and scripts that every request inside it uses. A request set to Inherit takes the nearest ones, and anything it sets itself wins. The request’s Auth tab says where its auth comes from.

Moving things around

• Move to… (in the ⋯ menu of a request or folder, in the sidebar, the requests table and the folders list) moves it into another folder, or to the top of the collection. A folder cannot be moved into itself or into a folder inside it.
• Move up and Move down (in the sidebar) change the order of requests, or of folders, within a folder. A run goes through requests in this order.

Running

Run a whole collection, one folder or one request from the dashboard’s Test Runner, or in CI with zyvra run 'Collection name' (see Commands). Each request’s Tests tab holds its assertions and test script.