1WAIVERDB(7) WaiverDB WAIVERDB(7)
2
6 waiverdb - WaiverDB REST API
7 WavierDB offers a HTTP REST API.
9
11 GET /api/v1.0/about
12 Returns the current running version and the method used for
13 authentication.
14 Sample response:
16 HTTP/1.0 200 OK
18 Content-Length: 55
19 Content-Type: application/json
20 Date: Tue, 31 Oct 2017 04:29:19 GMT
21 Server: Werkzeug/0.11.10 Python/2.7.13
22 {
24 "auth_method": "OIDC",
25 "version": "0.3.1"
26 }
27 Status Codes
29 · 200 OK – Currently running waiverdb software version
31 and authentication are returned.
32 GET /api/v1.0/config
34 Returns the current configuration (PERMISSION_MAPPING and SUPE‐
35 RUSERS).
36 Sample response:
38 HTTP/1.0 200 OK
40 Content-Length: 55
41 Content-Type: application/json
42 Date: Tue, 31 Oct 2017 04:29:19 GMT
43 Server: Werkzeug/0.11.10 Python/2.7.13
44 {
46 "permission_mapping": {
47 "^kernel-qe": {
48 "groups": ["devel", "qa"],
49 "users": []
50 }
51 },
52 "superusers": ["alice", "bob"]
53 }
54 Status Codes
56 · 200 OK – Configuration is returned.
58 GET /api/v1.0/waivers/
60 Get waiver records.
61 Sample request:
63 GET /api/v1.0/waivers/ HTTP/1.1
65 Host: localhost:5004
66 User-Agent: curl/7.51.0
67 Accept: application/json
68 Sample response:
70 HTTP/1.1 200 OK
72 Content-Type: application/json
73 Content-Length: 184
74 Server: Werkzeug/0.12.1 Python/2.7.13
75 Date: Thu, 16 Mar 2017 13:53:14 GMT
76 {
78 "data": [],
79 "first": "http://localhost:5004/api/v1.0/waivers/?page=1",
80 "last": "http://localhost:5004/api/v1.0/waivers/?page=0",
81 "next": null,
82 "prev": null
83 }
84 Query Parameters
86 · page (int) – The page to get.
88 · limit (int) – Limit the number of items returned.
90 · subject_type (string) – Only include waivers for the
92 given subject type.
93 · subject_identifier (string) – Only include waivers for
95 the given subject identifier.
96 · testcase (string) – Only include waivers for the given
98 test case name.
99 · scenario (string) – Only include waivers for the given
101 scenario name.
102 · product_version (string) – Only include waivers for the
104 given product version.
105 · username (string) – Only include waivers which were
107 submitted by the given user.
108 · proxied_by (string) – Only include waivers which were
110 proxied on behalf of someone else by the given user.
111 · since (string) – An ISO 8601 formatted datetime (e.g.
113 2017-03-16T13:40:05+00:00) to filter results by.
114 Optionally provide a second ISO 8601 datetime separated
115 by a comma to retrieve a range (e.g.
116 2017-03-16T13:40:05+00:00, 2017-03-16T13:40:15+00:00)
117 · include_obsolete (boolean) – If true, obsolete waivers
119 will be included.
120 Status Codes
122 · 200 OK – If the query was valid and no problems were
124 encountered. Note that the response may still contain
125 0 waivers.
126 · 400 Bad Request – The request was malformed and could
128 not be processed.
129 POST /api/v1.0/waivers/
131 Create a new waiver or multiple waivers.
132 To create multiple waivers, pass list of dict instead. Response
134 also contains list on success.
135 Sample request:
137 POST /api/v1.0/waivers/ HTTP/1.1
139 Host: localhost:5004
140 Accept-Encoding: gzip, deflate
141 Accept: application/json
142 Connection: keep-alive
143 User-Agent: HTTPie/0.9.4
144 Content-Type: application/json
145 Content-Length: 91
146 {
148 "subject_type": "compose",
149 "subject_identifier": "Fedora-9000-19700101.n.18",
150 "testcase": "compose.install_no_user",
151 "waived": false,
152 "product_version": "Parrot",
153 "comment": "This is fine"
154 }
155 Sample response:
157 HTTP/1.0 201 CREATED
159 Content-Length: 228
160 Content-Type: application/json
161 Date: Thu, 16 Mar 2017 17:42:04 GMT
162 Server: Werkzeug/0.12.1 Python/2.7.13
163 {
165 "comment": "This is fine",
166 "id": 15,
167 "product_version": "Parrot",
168 "subject_type": "compose",
169 "subject_identifier": "Fedora-9000-19700101.n.18",
170 "testcase": "compose.install_no_user",
171 "scenario": null,
172 "timestamp": "2017-03-16T17:42:04.209638",
173 "username": "jcline",
174 "waived": false,
175 "proxied_by": null
176 }
177 JSON Parameters
179 · subject_type (string) – The type of thing which this
181 waiver is for.
182 · subject_identifier (string) – The identifier of the
184 thing this waiver is for. The semantics of this identi‐
185 fier depend on the “subject_type”. For example, Koji
186 builds are identified by their NVR.
187 · testcase (string) – The result testcase for the waiver.
189 · scenario (string) – The result scenario for the waiver.
191 · waived (boolean) – Whether or not the result is waived.
193 · product_version (string) – The product version string.
195 · comment (string) – A comment explaining the waiver.
197 · username (string) – Username on whose behalf the caller
199 is proxying.
200 Status Codes
202 · 201 Created – The waiver was successfully created.
204 POST /api/v1.0/waivers/+by-subjects-and-testcases
206 Deprecated. Use POST /api/v1.0/waivers/+filtered instead.
207 Instead of making a deprecated request like this:
209 POST /api/v1.0/waivers/+by-subjects-and-testcases HTTP/1.1
211 Content-Type: application/json
212 {
214 "results": [
215 {
216 "subject": {"productmd.compose.id": "Fedora-9000-19700101.n.18"},
217 "testcase": "compose.install_no_user"
218 },
219 {
220 "subject": {"item": "gzip-1.9-1.fc28", "type": "koji_build"},
221 "testcase": "dist.rpmlint"
222 }
223 ]
224 }
225 make the following equivalent request:
227 POST /api/v1.0/waivers/+filtered HTTP/1.1
229 Content-Type: application/json
230 {
232 "filters": [
233 {
234 "subject_type": "compose",
235 "subject_identifier": "Fedora-9000-19700101.n.18",
236 "testcase": "compose.install_no_user"
237 },
238 {
239 "subject_type": "koji_build",
240 "subject_identifier": "gzip-1.9-1.fc28",
241 "testcase": "dist.rpmlint"
242 }
243 ]
244 }
245 POST /api/v1.0/waivers/+filtered
247 Get waiver records, filtered by some criteria.
248 This API behaves the same way as GET /api/v1.0/waivers/, but it
250 allows for longer or more complex filter criteria that cannot be
251 expressed in the query string.
252 Note that the response is not paginated (that is, all waivers
254 are returned in the ‘data’ key, even if there is a large number
255 of them).
256 Sample request:
258 POST /api/v1.0/waivers/+filtered HTTP/1.1
260 Accept: application/json
261 Content-Type: application/json
262 {
264 "filters": [
265 {
266 "subject_type": "compose",
267 "subject_identifier": "Fedora-9000-19700101.n.18",
268 "testcase": "compose.install_no_user"
269 },
270 {
271 "subject_type": "koji_build",
272 "subject_identifier": "gzip-1.9-1.fc28",
273 "testcase": "dist.rpmlint"
274 }
275 ]
276 }
277 Sample response:
279 HTTP/1.1 200 OK
281 Content-Type: application/json
282 {
284 "data": [
285 {
286 "id": 15,
287 "comment": "The tests broke",
288 "product_version": "fedora-27",
289 "subject_type": "compose",
290 "subject_identifier": "Fedora-9000-19700101.n.18",
291 "testcase": "compose.install_no_user",
292 "scenario": null,
293 "timestamp": "2017-03-16T17:42:04.209638",
294 "username": "jcline",
295 "waived": true,
296 "proxied_by": null
297 }
298 ]
299 }
300 JSON Parameters
302 · filters (list) – List of filter dicts. If the list con‐
304 tains multiple filter dicts, they are combined with
305 logical OR. Within each filter dict, the criteria are
306 combined with logical AND. Keys within the filter dict
307 are the same as the filtering parameters accepted by
308 GET /api/v1.0/waivers/.
309 · include_obsolete (boolean) – If true, obsolete waivers
311 will be included.
312 Status Codes
314 · 200 OK – Returns matching waivers, if any.
316 · 400 Bad Request – The request was malformed (invalid
318 filter critera).
319 GET /api/v1.0/waivers/(int: waiver_id)
321 Get a single waiver by waiver ID.
322 Parameters
324 · waiver_id (int) – The waiver’s database ID.
326 Status Codes
328 · 200 OK – The waiver was found and returned.
330 · 404 Not Found – No waiver exists with that ID.
332 GET /healthcheck
334 Request handler for performing an application-level health
335 check. This is not part of the published API, it is intended for
336 use by OpenShift or other monitoring tools.
337 Returns a 200 response if the application is alive and able to
339 serve requests.
340
342 Red Hat, Inc. and others
343
345 2021, Red Hat, Inc. and others
3461.2 Jan 12, 2021 WAIVERDB(7)