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
|
.. _collection_defconfig:
defconfig
---------
More info about the defconfig schema can be found :ref:`here <schema_defconfig>`.
.. note::
This resource can also be accessed using the plural form ``defconfigs``.
GET
***
.. http:get:: /defconfig/(string:defconfig_id)
Get all the available defconfigs built or a single one if ``defconfig_id`` is provided.
:param defconfig_id: The ID of the defconfig to retrieve.
:type defconfig_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 defconfig report.
:query string created_on: The creation date: accepted formats are ``YYYY-MM-DD`` and ``YYYYMMDD``.
:query string job: The name of a job.
:query string job_id: The ID of a job.
:query string kernel: The name of a kernel.
:query string defconfig_full: The full name of a defconfig (with config fragments).
:query string defconfig: The name of a defconfig.
:query string name: The name of the defconfig report.
:query string arch: The architecture on which the defconfig has been built.
:query string status: The status of the defconfig report.
:query int warnings: The number of warnings in the defconfig built.
:query int errors: The number of errors in the defconfig built.
:query string git_branch: The name of the git branch.
:query string git_commit: The git commit SHA.
:query string git_describe: The git describe value.
: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 /defconfig/ HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
.. sourcecode:: http
GET /defconfig/next-next-20140905-arm-omap2plus_defconfig HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
.. sourcecode:: http
GET /defconfig?job=next&kernel=next-20140905&field=status&field=arch&nfield=_id HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
**Examples Responses**
.. sourcecode:: http
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",
"dirname": "arm-omap2plus_defconfig",
"job_id": "next-next-20140905",
"job": "next",
"defconfig": "omap2plus_defconfig",
"errors": null,
"_id": "next-next-20140905-arm-omap2plus_defconfig",
"arch": "arm",
}
]
}
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 08 Sep 2014 14:20:52 GMT
Content-Type: application/json; charset=UTF-8
{
"code": 200,
"count": 132,
"limit": 0,
"result": [
{
"status": "PASS",
"arch": "arm"
},
{
"status": "PASS",
"arch": "arm"
},
{
"status": "PASS",
"arch": "x86"
},
{
"status": "PASS",
"arch": "arm64"
}
]
}
.. note::
Results shown here do not include the full JSON response.
POST
****
.. caution::
Not implemented. Will return a :ref:`status code <http_status_code>`
of ``501``.
DELETE
******
.. http:delete:: /defconfig/(string:defconfig_id)
Delete the job identified by ``defconfig_id``.
:param defconfig_id: The ID of the defconfig to retrieve. Usually in the form of: ``job``-``kernel``-``defconfig``.
:type defconfig_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 400: JSON data not valid.
:status 403: Not authorized to perform the operation.
:status 404: The provided resource has not been found.
:status 422: No real JSON data provided.
:status 500: Internal database error.
**Example Requests**
.. sourcecode:: http
DELETE /defconfig/next-next-20140905-arm-omap2plus_defconfig HTTP/1.1
Host: api.kernelci.org
Accept: */*
Content-Type: application/json
Authorization: token
More Info
*********
* :ref:`Defconfig schema <schema_defconfig>`
* :ref:`API results <intro_schema_results>`
* :ref:`Schema time and date <intro_schema_time_date>`
|
