Merge pull request #345 from OperationCode/fix-search-details

Ensure the search pagination details are included in response

Author: mike-lloyd03

app/api/routes/resource_retrieval.py

@@ -104,14 +104,14 @@ def get_resources():
         resource_list = [
             resource.serialize for resource in paginated_resources.items
         ]
-        pagination_details = resource_paginator.pagination_details(paginated_resources)
+        details = resource_paginator.details(paginated_resources)
     except Exception as e:
         logger.exception(e)
         return utils.standardize_response(status_code=500)
 
     return utils.standardize_response(payload=dict(
         data=resource_list,
-        **pagination_details),
+        **details),
         datatype="resources")
 
 

app/api/routes/search.py

@@ -71,14 +71,14 @@ def search_results():
 
     results = [utils.format_resource_search(result) for result in search_result['hits']]
 
-    pagination_details = {
-        "pagination_details": {
+    details = {
+        "details": {
             "page": search_result['page'],
             "number_of_pages": search_result['nbPages'],
             "records_per_page": search_result['hitsPerPage'],
             "total_count": search_result['nbHits'],
         }
     }
     return utils.standardize_response(
-        payload=dict(data=results, **pagination_details),
+        payload=dict(data=results, **details),
         datatype="resources")

app/utils.py

@@ -48,7 +48,7 @@ def paginated_data(self, query):
         setattr(data, "per_page", self.page_size)
         return data
 
-    def pagination_details(self, paginated_data):
+    def details(self, paginated_data):
         return {
             "details": {
                 "page": paginated_data.page,

tests/unit/test_routes/test_searching.py

@@ -28,6 +28,10 @@ def test_search(
     assert (result.status_code == 200)
     assert (
         result.json['resources'][0]['url'] == resource.json['resources'][0].get('url'))
+    assert (isinstance(result.json['page'], int))
+    assert (isinstance(result.json['number_of_pages'], int))
+    assert (isinstance(result.json['records_per_page'], int))
+    assert (isinstance(result.json['total_count'], int))
 
     # Update the resource and test that search results reflect changes
     updated_term = random_string()
@@ -41,6 +45,10 @@ def test_search(
     assert (resource.status_code == 200)
     assert (result.status_code == 200)
     assert (result.json['resources'][0]['url'] == resource.json['resource'].get('url'))
+    assert (isinstance(result.json['page'], int))
+    assert (isinstance(result.json['number_of_pages'], int))
+    assert (isinstance(result.json['records_per_page'], int))
+    assert (isinstance(result.json['total_count'], int))
 
 
 def test_search_paid_filter(module_client,