v1

latestOpenAPI 3.1.0AGPL 3.02026-07-14339.4 KB

request

Pass input parameters and request a plan of tests to be run.

Pass details about a test plan and request for it to be run. The api will validate all input parameters and return a status code, as well as a url to track the status of the job, if accepted.

post/request

Query parameters

test_artifact_urlstring uri

URL to artifact to be tested. Can be a deb, snap, or nothing if you just want to run tests against the testbed. Artifact types supported are:

debs
snaps

tests_repostring

Url to git repository containing tests and test plans.

tests_repo_branchstring

Branch of test_repo to use.

tests_plansTestPlanPath[] required

List of paths to plan.yaml files detailing test plans.

[
  "tests/firefox-example/plans/extended.yaml"
]

testbedstring required

Url to image to be used as testbed. Has to be either .iso or .img format. Can also be a shortform, e.g. ubuntu:questing:daily, which'll expand to an appropriate url for official Ubuntu images.

debugboolean

Enable debug artifacts.

priorityinteger

Priority of test request. Jobs with higher priority get processed before jobs with lower priority. Requesters have assigned maximum priority levels. A request with a priority level higher than the requesters assigned maximum priority level are demoted to said level.

Response

JSON returned after successful test request

uuidstring

UUID to identify a job.

job_urlstring uri

URL to track the status of a job.

Example response

{
  "job_url": "https://guts.ubuntu.com/job/8d898296-e373-4947-8435-bf75316943f4"
}