From 4fb09ad7ca3fb371b9e5d95fee0583c37c747d26 Mon Sep 17 00:00:00 2001 From: Karl Hobley Date: Thu, 8 Oct 2015 21:50:42 +0100 Subject: [PATCH] feat(api/2): Renamed results list to "results" --- wagtail/api/v2/pagination.py | 2 +- wagtail/api/v2/tests/test_documents.py | 20 +++++++++--------- wagtail/api/v2/tests/test_images.py | 20 +++++++++--------- wagtail/api/v2/tests/test_pages.py | 28 +++++++++++++------------- 4 files changed, 35 insertions(+), 35 deletions(-) diff --git a/wagtail/api/v2/pagination.py b/wagtail/api/v2/pagination.py index 68e726b66f..3d990bfd9e 100644 --- a/wagtail/api/v2/pagination.py +++ b/wagtail/api/v2/pagination.py @@ -38,6 +38,6 @@ class WagtailPagination(BasePagination): def get_paginated_response(self, data): data = OrderedDict([ ('total_count', self.total_count), - (self.view.name, data), + ('results', data), ]) return Response(data) diff --git a/wagtail/api/v2/tests/test_documents.py b/wagtail/api/v2/tests/test_documents.py index 3c7381f4f2..531f8ef082 100644 --- a/wagtail/api/v2/tests/test_documents.py +++ b/wagtail/api/v2/tests/test_documents.py @@ -17,7 +17,7 @@ class TestDocumentListing(TestCase): return self.client.get(reverse('wagtailapi_v2:documents:listing'), params) def get_document_id_list(self, content): - return [page['id'] for page in content['documents']] + return [document['id'] for document in content['results']] # BASIC TESTS @@ -36,12 +36,12 @@ class TestDocumentListing(TestCase): self.assertIsInstance(content['total_count'], int) self.assertEqual(content['total_count'], Document.objects.count()) - # Check that the documents section is there - self.assertIn('documents', content) - self.assertIsInstance(content['documents'], list) + # Check that the results section is there + self.assertIn('results', content) + self.assertIsInstance(content['results'], list) # Check that each document has a meta section with type and detail_url attributes - for document in content['documents']: + for document in content['results']: self.assertIn('meta', document) self.assertIsInstance(document['meta'], dict) self.assertEqual(set(document['meta'].keys()), {'type', 'detail_url', 'download_url'}) @@ -62,21 +62,21 @@ class TestDocumentListing(TestCase): response = self.get_response() content = json.loads(response.content.decode('UTF-8')) - for document in content['documents']: + for document in content['results']: self.assertEqual(set(document.keys()), {'id', 'meta', 'title'}) def test_extra_fields(self): response = self.get_response(fields='title,tags') content = json.loads(response.content.decode('UTF-8')) - for document in content['documents']: + for document in content['results']: self.assertEqual(set(document.keys()), {'id', 'meta', 'title', 'tags'}) def test_extra_fields_tags(self): response = self.get_response(fields='tags') content = json.loads(response.content.decode('UTF-8')) - for document in content['documents']: + for document in content['results']: self.assertIsInstance(document['tags'], list) def test_extra_fields_which_are_not_in_api_fields_gives_error(self): @@ -182,7 +182,7 @@ class TestDocumentListing(TestCase): response = self.get_response(limit=2) content = json.loads(response.content.decode('UTF-8')) - self.assertEqual(len(content['documents']), 2) + self.assertEqual(len(content['results']), 2) def test_limit_total_count(self): response = self.get_response(limit=2) @@ -220,7 +220,7 @@ class TestDocumentListing(TestCase): response = self.get_response() content = json.loads(response.content.decode('UTF-8')) - self.assertEqual(len(content['documents']), 2) + self.assertEqual(len(content['results']), 2) # OFFSET diff --git a/wagtail/api/v2/tests/test_images.py b/wagtail/api/v2/tests/test_images.py index dbd4d3f454..5d19bc73ab 100644 --- a/wagtail/api/v2/tests/test_images.py +++ b/wagtail/api/v2/tests/test_images.py @@ -17,7 +17,7 @@ class TestImageListing(TestCase): return self.client.get(reverse('wagtailapi_v2:images:listing'), params) def get_image_id_list(self, content): - return [page['id'] for page in content['images']] + return [image['id'] for image in content['results']] # BASIC TESTS @@ -36,12 +36,12 @@ class TestImageListing(TestCase): self.assertIsInstance(content['total_count'], int) self.assertEqual(content['total_count'], get_image_model().objects.count()) - # Check that the images section is there - self.assertIn('images', content) - self.assertIsInstance(content['images'], list) + # Check that the results section is there + self.assertIn('results', content) + self.assertIsInstance(content['results'], list) # Check that each image has a meta section with type and detail_url attributes - for image in content['images']: + for image in content['results']: self.assertIn('meta', image) self.assertIsInstance(image['meta'], dict) self.assertEqual(set(image['meta'].keys()), {'type', 'detail_url'}) @@ -59,21 +59,21 @@ class TestImageListing(TestCase): response = self.get_response() content = json.loads(response.content.decode('UTF-8')) - for image in content['images']: + for image in content['results']: self.assertEqual(set(image.keys()), {'id', 'meta', 'title'}) def test_extra_fields(self): response = self.get_response(fields='title,width,height') content = json.loads(response.content.decode('UTF-8')) - for image in content['images']: + for image in content['results']: self.assertEqual(set(image.keys()), {'id', 'meta', 'title', 'width', 'height'}) def test_extra_fields_tags(self): response = self.get_response(fields='tags') content = json.loads(response.content.decode('UTF-8')) - for image in content['images']: + for image in content['results']: self.assertEqual(set(image.keys()), {'id', 'meta', 'tags'}) self.assertIsInstance(image['tags'], list) @@ -180,7 +180,7 @@ class TestImageListing(TestCase): response = self.get_response(limit=2) content = json.loads(response.content.decode('UTF-8')) - self.assertEqual(len(content['images']), 2) + self.assertEqual(len(content['results']), 2) def test_limit_total_count(self): response = self.get_response(limit=2) @@ -218,7 +218,7 @@ class TestImageListing(TestCase): response = self.get_response() content = json.loads(response.content.decode('UTF-8')) - self.assertEqual(len(content['images']), 2) + self.assertEqual(len(content['results']), 2) # OFFSET diff --git a/wagtail/api/v2/tests/test_pages.py b/wagtail/api/v2/tests/test_pages.py index 44cdd09e9a..bb4ca1fab9 100644 --- a/wagtail/api/v2/tests/test_pages.py +++ b/wagtail/api/v2/tests/test_pages.py @@ -26,7 +26,7 @@ class TestPageListing(TestCase): return self.client.get(reverse('wagtailapi_v2:pages:listing'), params) def get_page_id_list(self, content): - return [page['id'] for page in content['pages']] + return [page['id'] for page in content['results']] # BASIC TESTS @@ -45,12 +45,12 @@ class TestPageListing(TestCase): self.assertIsInstance(content['total_count'], int) self.assertEqual(content['total_count'], get_total_page_count()) - # Check that the pages section is there - self.assertIn('pages', content) - self.assertIsInstance(content['pages'], list) + # Check that the results section is there + self.assertIn('results', content) + self.assertIsInstance(content['results'], list) # Check that each page has a meta section with type, detail_url and html_url attributes - for page in content['pages']: + for page in content['results']: self.assertIn('meta', page) self.assertIsInstance(page['meta'], dict) self.assertEqual(set(page['meta'].keys()), {'type', 'detail_url', 'html_url'}) @@ -85,7 +85,7 @@ class TestPageListing(TestCase): response = self.get_response(type='demosite.BlogEntryPage') content = json.loads(response.content.decode('UTF-8')) - for page in content['pages']: + for page in content['results']: self.assertEqual(page['meta']['type'], 'demosite.BlogEntryPage') def test_type_filter_total_count(self): @@ -115,21 +115,21 @@ class TestPageListing(TestCase): response = self.get_response(type='demosite.BlogEntryPage') content = json.loads(response.content.decode('UTF-8')) - for page in content['pages']: + for page in content['results']: self.assertEqual(set(page.keys()), {'id', 'meta', 'title'}) def test_extra_fields(self): response = self.get_response(type='demosite.BlogEntryPage', fields='title,date,feed_image') content = json.loads(response.content.decode('UTF-8')) - for page in content['pages']: + for page in content['results']: self.assertEqual(set(page.keys()), {'id', 'meta', 'title', 'date', 'feed_image'}) def test_extra_fields_child_relation(self): response = self.get_response(type='demosite.BlogEntryPage', fields='title,related_links') content = json.loads(response.content.decode('UTF-8')) - for page in content['pages']: + for page in content['results']: self.assertEqual(set(page.keys()), {'id', 'meta', 'title', 'related_links'}) self.assertIsInstance(page['related_links'], list) @@ -137,7 +137,7 @@ class TestPageListing(TestCase): response = self.get_response(type='demosite.BlogEntryPage', fields='title,date,feed_image') content = json.loads(response.content.decode('UTF-8')) - for page in content['pages']: + for page in content['results']: feed_image = page['feed_image'] if feed_image is not None: @@ -153,7 +153,7 @@ class TestPageListing(TestCase): response = self.get_response(type='demosite.BlogEntryPage', fields='tags') content = json.loads(response.content.decode('UTF-8')) - for page in content['pages']: + for page in content['results']: self.assertEqual(set(page.keys()), {'id', 'meta', 'tags'}) self.assertIsInstance(page['tags'], list) @@ -173,7 +173,7 @@ class TestPageListing(TestCase): 'feed_image', 'related_links', ] - self.assertEqual(list(content['pages'][0].keys()), field_order) + self.assertEqual(list(content['results'][0].keys()), field_order) def test_extra_fields_without_type_gives_error(self): response = self.get_response(fields='title,related_links') @@ -417,7 +417,7 @@ class TestPageListing(TestCase): response = self.get_response(limit=2) content = json.loads(response.content.decode('UTF-8')) - self.assertEqual(len(content['pages']), 2) + self.assertEqual(len(content['results']), 2) def test_limit_total_count(self): response = self.get_response(limit=2) @@ -455,7 +455,7 @@ class TestPageListing(TestCase): response = self.get_response() content = json.loads(response.content.decode('UTF-8')) - self.assertEqual(len(content['pages']), 2) + self.assertEqual(len(content['results']), 2) # OFFSET