Tests API
List tests
curl -H "Authorization: Bearer $TOKEN" \
-X GET "https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests"
[
{
"id": "01867216-8478-7fde-a55a-0300f88bb49b",
"url": "https://api.buildkite.com/v2/analytics/organizations/my_great_org/suites/my_suite_name/tests/01867216-8478-7fde-a55a-0300f88bb49b",
"web_url": "https://buildkite.com/organizations/my_great_org/analytics/suites/my_suite_name/tests/01867216-8478-7fde-a55a-0300f88bb49b",
"scope": "User#email",
"name": "is correctly formatted",
"location": "./spec/models/user_spec.rb:42",
"file_name": "./spec/models/user_spec.rb",
}
]
Optional query string parameters:
label
|
Filters the results by test label.
Example: |
---|
Required scope: read_suites
Success response: 200 OK
Get a test
curl -H "Authorization: Bearer $TOKEN" \
-X GET "https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites/{suite.slug}/tests/{test.id}"
{
"id": "01867216-8478-7fde-a55a-0300f88bb49b",
"url": "https://api.buildkite.com/v2/analytics/organizations/my_great_org/suites/my_suite_name/tests/01867216-8478-7fde-a55a-0300f88bb49b",
"web_url": "https://buildkite.com/organizations/my_great_org/analytics/suites/my_suite_name/tests/01867216-8478-7fde-a55a-0300f88bb49b",
"scope": "User#email",
"name": "is correctly formatted",
"location": "./spec/models/user_spec.rb:42",
"file_name": "./spec/models/user_spec.rb",
}
Required scope: read_suites
Success response: 200 OK
Add/remove labels from a test
curl -H "Authorization: Bearer $TOKEN" \
-X PATCH "https://api.buildkite.com/v2/organizations/{org.slug}/teams/{team.uuid}/suites/{suite.uuid}/tests/{test.id}/labels" \
-H "Content-Type: application/json" \
-d '{
"operator": "add",
"labels": ["flaky", "slow"]
}'
{
"file_name": "./spec/features/cool_spec.rb",
"id": "ccd837ee-d484-8864-a6ee-29cfae965bd8",
"labels": [
"flaky", "slow"
],
"location": "./spec/features/cool_spec.rb:232",
"name": "one plus one",
"scope": "A fancy feature",
"url": "https://api.buildkite.com/v2/analytics/organizations/acme-inc/suites/acme-suite/tests/ccd837ee-d484-8864-a6ee-29cfae965bd8",
"web_url": "https://buildkite.com/organizations/acme-inc/analytics/suites/acme-suite/tests/ccd837ee-d484-8864-a6ee-29cfae965bd8"
}
Required request body properties:
operator |
The operation that will be apply to labels."add" or "remove" . |
---|---|
labels |
The labels that will be added or removed. Example: ["flaky"] . |
Required scope: write_suites
Success response: 200 OK