How to Update Requests

Prerequisites

1. Install and run the agent

2. Configure the proxy

3. Record requests

4. Set credentials

Why Update Requests?

At some point in time, API providers will change the contract of a request. For example, maybe a component in the request or its response needs to be updated. When this happens we need to update the request on Stoobly's side as well. This is done in one of two ways:

1. Manually editing the request

2. Replay and overwriting the request

Updating Requests

Before updating a request, it is recommended to create a snapshot

There are three strategies to update a request:

Editing

Editing from the UIEditing with Snapshots

Replaying

Replaying from the UIReplaying from the CLI

Contract-Driven Updating

Updating with Open API

Reverting Changes

In case you update a request with unintended consequences, you can reset it to the last snapshot state. For more information see our documentation on the snapshots feature:

Snapshots

Command

stoobly-agent request reset

Options

$ stoobly-agent request reset --help

Usage: stoobly-agent request reset [OPTIONS] REQUEST_KEY

  Reset a request to its snapshot state

Options:
  --force     Toggles whether resources are hard deleted.
  -h, --help  Show this message and exit.