Suites
Create a suite
Creates a suite and its first version from a definition. The definition is validated in full and stored canonically; its SHA-256 identifies the version. The slug is unique within the project. Needs rig.write.
post/v1/suites
Request
- Base URL: https://api.ironfang.com/rig
- URL: https://api.ironfang.com/rig/v1/suites
- Auth: one of:
- HTTP bearer
- HTTP bearer
Request body
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"
}
}
},
"name": "Signup flow",
"slug": "signup"
}Response
Suite created with version 1
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.