boot¶
The boot trigger resource is used by a boot lab
to retrieve build
information on what can be boot tested.
The data returned by this resources has the same format described in the build schema.
By default, this resource returns the same results as the build
one. The
results can be tailored for the requesting lab by comparing what other boot
labs have already tested. To achieve this, use the compared
parameter in
the query string.
Note
This resource can also be accessed using the plural form boots
.
Note
This resource can only be accessed by a lab token.
GET¶
-
GET
/trigger/boot
¶ Get the available builds.
Request Headers: - Authorization – The token necessary to authorize the request.
- Accept-Encoding – Accept the
gzip
coding.
Response Headers: - Content-Type – Will be
application/json; charset=UTF-8
.
Query Parameters: - limit (int) – Number of results to return. Default 0 (all results).
- skip (int) – Number of results to skip. Default 0 (none).
- sort (string) – Field to sort the results on. Can be repeated multiple times.
- sort_order (int) – The sort order of the results: -1 (descending), 1
(ascending). This will be applied only to the first
sort
parameter passed. Default -1. - date_range (int) – Number of days to consider, starting from today (more info). By default consider all results.
- field (string) – The field that should be returned in the response. Can be repeated multiple times.
- nfield (string) – The field that should not be returned in the response. Can be repeated multiple times.
- _id (string) – The internal ID of the defconfig report.
- created_on (string) – The creation date: accepted formats are
YYYY-MM-DD
andYYYYMMDD
. - compared (int) – If the search results should be compared against already available boot reports.
- job (string) – The name of a job.
- job_id (string) – The ID of a job.
- kernel (string) – The name of a kernel.
- defconfig_full (string) – The full name of a defconfig (with config fragments).
- defconfig (string) – The name of a defconfig.
- arch (string) – The architecture on which the defconfig has been built.
- status (string) – The status of the defconfig report.
- git_branch (string) – The name of the git branch.
- git_commit (string) – The git commit SHA.
- git_describe (string) – The git describe value.
- time_range (string) – Minutes of data to consider, in UTC time (more info). Minimum value is 10 minutes, maximum is 60 * 24.
Status Codes: - 200 OK – Results found.
- 403 Forbidden – Not authorized to perform the operation.
- 404 Not Found – The provided resource has not been found.
- 500 Internal Server Error – Internal database error.
Example Requests
GET /trigger/boot HTTP/1.1 Host: api.kernelci.org Accept: */* Authorization: token
GET /trigger/boot?job=next&date_range=1 HTTP/1.1 Host: api.kernelci.org Accept: */* Authorization: token
GET /trigger/boot?job=next&kernel=next-20140905&compared=1 HTTP/1.1 Host: api.kernelci.org Accept: */* Authorization: token
Examples Responses
HTTP/1.1 200 OK Vary: Accept-Encoding Date: Mon, 08 Sep 2014 14:16:52 GMT Content-Type: application/json; charset=UTF-8 { "code": 200, "result": [ { "status": "PASS", "kernel": "next-20140905", "job_id": "123456789012345678901", "job": "next", "defconfig": "omap2plus_defconfig", "_id": "12345678901234567890", "arch": "arm", } ] }
Note
Results shown here do not include the full JSON response.
POST¶
Caution
Not implemented. Will return a status code
of 501
.
DELETE¶
Caution
Not implemented. Will return a status code
of 501
.
PUT¶
Caution
Not implemented. Will return a status code
of 501
.