From 67ae89ab36c2e3f76513003c0023252529314861 Mon Sep 17 00:00:00 2001 From: Dan Callaghan Date: Jun 02 2017 06:03:27 +0000 Subject: clarify that the API accepts comma-separated result IDs --- diff --git a/tests/test_api_v10.py b/tests/test_api_v10.py index 805b039..c5abb08 100644 --- a/tests/test_api_v10.py +++ b/tests/test_api_v10.py @@ -125,6 +125,18 @@ def test_filtering_waivers_by_result_id(client, session): assert res_data['data'][0]['result_id'] == 123 +def test_filtering_waivers_by_multiple_result_ids(client, session): + create_waiver(session, result_id=123, username='foo-1', product_version='foo-1') + create_waiver(session, result_id=234, username='foo-2', product_version='foo-1') + create_waiver(session, result_id=345, username='foo-2', product_version='foo-1') + r = client.get('/api/v1.0/waivers/?result_id=123,345') + res_data = json.loads(r.get_data(as_text=True)) + assert r.status_code == 200 + assert len(res_data['data']) == 2 + assert res_data['data'][0]['result_id'] == 345 + assert res_data['data'][1]['result_id'] == 123 + + def test_filtering_waivers_by_product_version(client, session): create_waiver(session, result_id=123, username='foo-1', product_version='release-1') create_waiver(session, result_id=124, username='foo-1', product_version='release-2') diff --git a/waiverdb/api_v1.py b/waiverdb/api_v1.py index ce808b8..04a363f 100644 --- a/waiverdb/api_v1.py +++ b/waiverdb/api_v1.py @@ -81,7 +81,8 @@ class WaiversResource(Resource): :query int page: The page to get. :query int limit: Limit the number of items returned. - :query int result_id: Filter the waivers by result ID. + :query int result_id: Filter the waivers by result ID. Accepts one or + more result IDs separated by commas. :query string product_version: Filter the waivers by product version. :query string username: Filter the waivers by username. :query string since: A ISO 8601 formatted datetime (e.g. 2017-03-16T13:40:05+00:00)