Skip to content
Plainwright

Update Test Case

PUT
/api/test-cases/{test_case_id}
curl --request PUT \
  --url http://localhost:8080/api/test-cases/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "natural_language": "example", "schedule_cron": "example", "is_active": true, "position": 1, "kind": "example", "config": {}, "retries": 1, "quarantined": true, "trials": 1, "assertions": [ "example" ], "visual_regression": true, "auth_state_id": "example", "source": "example", "source_ref": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
test_case_id
required
Test Case Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
TestCaseUpdate

Omitted fields are left unchanged; retries/auth_state_id/source_ref accept an explicit null.

object
name
Any of:
string
natural_language
Any of:
string
schedule_cron
Any of:
string
is_active
Any of:
boolean
position
Any of:
integer
kind
Any of:
string
config
Any of:
object
retries
Any of:
integer
<= 5
quarantined
Any of:
boolean
trials
Any of:
integer
>= 1 <= 10
assertions
Any of:
Array<string>
<= 20 items
visual_regression
Any of:
boolean
auth_state_id
Any of:
string
source
Any of:
string
source_ref
Any of:
string
Examplegenerated
{
  "name": "example",
  "natural_language": "example",
  "schedule_cron": "example",
  "is_active": true,
  "position": 1,
  "kind": "example",
  "config": {},
  "retries": 1,
  "quarantined": true,
  "trials": 1,
  "assertions": [
    "example"
  ],
  "visual_regression": true,
  "auth_state_id": "example",
  "source": "example",
  "source_ref": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}