1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
.. _collection_job:
job
---
More info about the job schema can be found :ref:`here <schema_job>`.
.. note::
This resource can also be accessed using the plural form ``jobs``.
GET
***
.. http:get:: /job/(string:job_id)
Get all the available jobs or a single one if ``job_id`` is provided.
:param job_id: The ID of the job to retrieve.
:type job_id: string
:reqheader Authorization: The token necessary to authorize the request.
:reqheader Accept-Encoding: Accept the ``gzip`` coding.
:resheader Content-Type: Will be ``application/json; charset=UTF-8``.
:query int limit: Number of results to return. Default 0 (all results).
:query int skip: Number of results to skip. Default 0 (none).
:query string sort: Field to sort the results on. Can be repeated multiple times.
:query int sort_order: The sort order of the results: -1 (descending), 1
(ascending). This will be applied only to the first ``sort``
parameter passed. Default -1.
:query int date_range: Number of days to consider, starting from today
(:ref:`more info <intro_schema_time_date>`). By default consider all results.
:query string field: The field that should be returned in the response. Can be
repeated multiple times.
:query string nfield: The field that should *not* be returned in the response. Can be repeated multiple times.
:query string _id: The internal ID of the job report.
:query string created_on: The creation date: accepted formats are ``YYYY-MM-DD`` and ``YYYYMMDD``.
:query string job: A job name.
:query string kernel: A kernel name.
:query string name: The name of the job report.
:query string status: The status of the job report.
:status 200: Results found.
:status 403: Not authorized to perform the operation.
:status 404: The provided resource has not been found.
:status 500: Internal database error.
**Example Requests**
.. sourcecode:: http
GET /job/ HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
.. sourcecode:: http
GET /job/next-next-20140731 HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
.. sourcecode:: http
GET /job?date_range=12&job=arm-soc&field=status&field=kernel HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
**Example Responses**
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 11 Aug 2014 15:12:50 GMT
Content-Type: application/json; charset=UTF-8
{
"code": 200,
"count:" 261,
"limit": 0,
"result": [
{
"status": "PASS",
"job": "arm-soc",
"_id": "arm-soc-v3.15-8898-gf79922c",
},
],
}
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 11 Aug 2014 15:23:00 GMT
Content-Type: application/json; charset=UTF-8
{
"code": "200",
"result": [
{
"status": "PASS",
"job": "next",
"_id": "next-next-20140731",
"kernel": "next-20140731"
}
]
}
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 11 Aug 2014 15:23:00 GMT
Content-Type: application/json; charset=UTF-8
{
"code": 200,
"count": 4,
"limit": 0,
"result": [
{
"status": "PASS",
"kernel": "v3.16-rc6-1009-g709032a"
},
{
"status": "PASS",
"kernel": "v3.16-rc6-1014-g716519f"
}
]
}
.. note::
Results shown here do not include the full JSON response.
POST
****
.. http:post:: /job
Create or update a job as defined in the JSON data. The request will be accepted and it will begin to parse the data.
For more info on all the required JSON request fields, see the :ref:`job schema for POST requests <schema_job_post>`.
:reqjson string job: The name of the job.
:reqjson string kernel: The name of the kernel.
:reqjson boolean boot_report: If the boot report should be created and sent. Default to 0 (false).
:reqjson boolean build_report: If the build report should be created and sent. Default to 0 (false).
:reqjson send_to: A string or an array of strings of email addresses where to send the reports.
:reqjson boot_send_to: A string or an array of strings of email addresses where to send only the boot report.
:reqjson build_send_to: A string or an array of strings of email addresses where to send only the build report.
:reqheader Authorization: The token necessary to authorize the request.
:reqheader Content-Type: Content type of the transmitted data, must be ``application/json``.
:reqheader Accept-Encoding: Accept the ``gzip`` coding.
:resheader Content-Type: Will be ``application/json; charset=UTF-8``.
:status 202: The request has been accepted and is going to be created.
:status 400: JSON data not valid.
:status 403: Not authorized to perform the operation.
:status 415: Wrong content type.
:status 422: No real JSON data provided.
.. warning::
Triggering email report through the job resources will be depracated.
**Example Requests**
.. sourcecode:: http
POST /job HTTP/1.1
Host: api.kernelci.org
Content-Type: application/json
Accept: */*
Authorization: token
{
"job": "next",
"kernel": "next-20140801",
"boot_report": 1,
"send_to": ["list@example.net"]
}
DELETE
******
.. http:delete:: /job/(string:job_id)
Delete the job identified by ``job_id``.
:param job_id: The job ID in the form of ``job``-``kernel``.
:type job_id: string
:reqheader Authorization: The token necessary to authorize the request.
:reqheader Accept-Encoding: Accept the ``gzip`` coding.
:resheader Content-Type: Will be ``application/json; charset=UTF-8``.
:status 200: Resource deleted.
:status 403: Not authorized to perform the operation.
:status 404: The provided resource has not been found.
:status 500: Internal database error.
**Example Requests**
.. sourcecode:: http
DELETE /job/next-next-20140612 HTTP/1.1
Host: api.kernelci.org
Accept: */*
Content-Type: application/json
Authorization: token
More Info
*********
* :ref:`Job schema <schema_job>`
* :ref:`API results <intro_schema_results>`
* :ref:`Schema time and date <intro_schema_time_date>`
|
