Suites

Revise a suite

Records a new version when the definition changed and answers the current version unchanged when it did not, so sending the same document twice creates one version. Existing runs keep the version they were created from. Needs rig.write.

put/v1/suites/{suiteId}

Request

  • Base URL: https://api.ironfang.com/rig
  • URL: https://api.ironfang.com/rig/v1/suites/{suiteId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

namestring

A new display name; omit to keep the current one.

Example request

{
  "definition": {
    "defaults": {
      "run_ttl": "30m"
    },
    "expectations": [
      {
        "id": "verification_email",
        "match": {
          "subject_contains": "Verify"
        }
      }
    ],
    "resources": {
      "customer_email": {
        "type": "email"
      },
      "shipping_api": {
        "type": "mock_http"
      },
      "stripe_callback": {
        "connector": {
          "route": "stripe"
        },
        "type": "callback"
      }
    }
  }
}

Response

The suite and the version now current

revisedboolean

Whether anything changed.

Example response

{
  "version": {
    "definition": {
      "defaults": {
        "run_ttl": "30m"
      },
      "expectations": [
        {
          "id": "verification_email",
          "match": {
            "subject_contains": "Verify"
          }
        }
      ],
      "resources": {
        "customer_email": {
          "type": "email"
        },
        "shipping_api": {
          "type": "mock_http"
        },
        "stripe_callback": {
          "connector": {
            "route": "stripe"
          },
          "type": "callback"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.