Batching: Rename items_count to total_items

docs/source/_json/batching.json

@@ -12,7 +12,6 @@ content-type: application/json
     "last": "http://localhost:55001/plone/folder/@search?b_size=5&sort_on=path&b_start=5", 
     "next": "http://localhost:55001/plone/folder/@search?b_size=5&sort_on=path&b_start=5"
   }, 
-  "items_count": 8, 
   "member": [
     {
       "@id": "http://localhost:55001/plone/folder", 
@@ -44,5 +43,6 @@ content-type: application/json
       "description": "", 
       "title": "Document 4"
     }
-  ]
+  ], 
+  "total_items": 8
 }

docs/source/_json/collection.json

@@ -26,7 +26,6 @@ content-type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "item_count": 30, 
-  "items_count": 3, 
   "language": "", 
   "limit": 1000, 
   "member": [
@@ -69,5 +68,6 @@ content-type: application/json
   "sort_reversed": null, 
   "subjects": [], 
   "text": null, 
-  "title": "My Collection"
+  "title": "My Collection", 
+  "total_items": 3
 }

docs/source/_json/folder.json

@@ -24,7 +24,6 @@ content-type: application/json
   "effective": null, 
   "exclude_from_nav": false, 
   "expires": null, 
-  "items_count": 2, 
   "language": "", 
   "member": [
     {
@@ -51,5 +50,6 @@ content-type: application/json
   "relatedItems": [], 
   "rights": "", 
   "subjects": [], 
-  "title": "My Folder"
+  "title": "My Folder", 
+  "total_items": 2
 }

docs/source/_json/search.json

@@ -11,7 +11,6 @@ content-type: application/json
     "first": "http://localhost:55001/plone/@search?sort_on=path&b_start=0", 
     "last": "http://localhost:55001/plone/@search?sort_on=path&b_start=0"
   }, 
-  "items_count": 2, 
   "member": [
     {
       "@id": "http://localhost:55001/plone/front-page", 
@@ -25,5 +24,6 @@ content-type: application/json
       "description": "", 
       "title": "Test Folder"
     }
-  ]
+  ], 
+  "total_items": 2
 }

docs/source/_json/siteroot.json

@@ -12,20 +12,20 @@ content-type: application/json
     "first": "http://localhost:55001/plone?b_start=0", 
     "last": "http://localhost:55001/plone?b_start=0"
   }, 
-  "items_count": 2, 
   "member": [
-    {
-      "@id": "http://localhost:55001/plone/robot-test-folder", 
-      "@type": "Folder", 
-      "description": "", 
-      "title": "Test Folder"
-    }, 
     {
       "@id": "http://localhost:55001/plone/front-page", 
       "@type": "Document", 
       "description": "Congratulations! You have successfully installed Plone.", 
       "title": "Welcome to Plone"
+    }, 
+    {
+      "@id": "http://localhost:55001/plone/robot-test-folder", 
+      "@type": "Folder", 
+      "description": "", 
+      "title": "Test Folder"
     }
   ], 
-  "parent": {}
+  "parent": {}, 
+  "total_items": 2
 }

docs/source/batching.rst

@@ -14,7 +14,7 @@ Representations of collection-like resources are batched / paginated:
         "prev": "http://.../plone/folder/search?b_size=10&b_start=10",
         "next": "http://.../plone/folder/search?b_size=10&b_start=30"
       },
-      "items_count": 175,
+      "total_items": 175,
       "member": [
         "..."
       ]
@@ -31,7 +31,7 @@ Attribute        Description
                  batching parameters
 ``member``       Current batch of items / members of the collection-like
                  resource
-``items_count``  Total number of items
+``total_items``  Total number of items
 ``batching``     Batching related navigation links (see below)
 ================ ===========================================================
 

src/plone/restapi/batching.py

@@ -24,7 +24,7 @@ def __iter__(self):
         return iter(self.batch)
 
     @property
-    def items_count(self):
+    def total_items(self):
         """Return the number of total items in underlying sequence.
         """
         return self.batch.sequence_length

src/plone/restapi/search/handler.py

@@ -47,7 +47,7 @@ def search(self, query=None):
 
         results = {}
         results['@id'] = batch.canonical_url
-        results['items_count'] = batch.items_count
+        results['total_items'] = batch.total_items
         results['batching'] = batch.links
 
         results['member'] = []

src/plone/restapi/serializer/atcontent.py

@@ -72,7 +72,7 @@ def __call__(self):
 
         result = folder_metadata
         result['@id'] = batch.canonical_url
-        result['items_count'] = batch.items_count
+        result['total_items'] = batch.total_items
         result['batching'] = batch.links
 
         result['member'] = [

src/plone/restapi/serializer/collection.py

@@ -21,7 +21,7 @@ def __call__(self):
 
         results = collection_metadata
         results['@id'] = batch.canonical_url
-        results['items_count'] = batch.items_count
+        results['total_items'] = batch.total_items
         results['batching'] = batch.links
 
         results['member'] = [

src/plone/restapi/serializer/dxcontent.py

@@ -102,7 +102,7 @@ def __call__(self):
 
         result = folder_metadata
         result['@id'] = batch.canonical_url
-        result['items_count'] = batch.items_count
+        result['total_items'] = batch.total_items
         result['batching'] = batch.links
 
         result['member'] = [

src/plone/restapi/serializer/site.py

@@ -38,7 +38,7 @@ def __call__(self):
             'parent': {},
         }
 
-        result['items_count'] = batch.items_count
+        result['total_items'] = batch.total_items
         result['batching'] = batch.links
 
         result['member'] = [

src/plone/restapi/tests/test_batching.py

@@ -101,8 +101,8 @@ def test_total_item_count_is_correct(self):
         # Fetch the second page of the batch
         response = self.api_session.get('/folder/@search?b_start=2&b_size=2')
 
-        # Total count of items should be in items_count
-        self.assertEqual(6, response.json()['items_count'])
+        # Total count of items should be in total_items
+        self.assertEqual(6, response.json()['total_items'])
 
 
 class TestBatchingCollections(TestBatchingDXBase):
@@ -168,8 +168,8 @@ def test_total_item_count_is_correct(self):
         # Fetch the second page of the batch
         response = self.api_session.get('/collection?b_start=2&b_size=2')
 
-        # Total count of items should be in items_count
-        self.assertEqual(6, response.json()['items_count'])
+        # Total count of items should be in total_items
+        self.assertEqual(6, response.json()['total_items'])
 
 
 class TestBatchingDXFolders(TestBatchingDXBase):
@@ -226,8 +226,8 @@ def test_total_item_count_is_correct(self):
         # Fetch the second page of the batch
         response = self.api_session.get('/folder?b_start=2&b_size=2')
 
-        # Total count of items should be in items_count
-        self.assertEqual(5, response.json()['items_count'])
+        # Total count of items should be in total_items
+        self.assertEqual(5, response.json()['total_items'])
 
 
 class TestBatchingSiteRoot(TestBatchingDXBase):
@@ -280,8 +280,8 @@ def test_total_item_count_is_correct(self):
         # Fetch the second page of the batch
         response = self.api_session.get('/?b_start=2&b_size=2')
 
-        # Total count of items should be in items_count
-        self.assertEqual(5, response.json()['items_count'])
+        # Total count of items should be in total_items
+        self.assertEqual(5, response.json()['total_items'])
 
 
 class TestBatchingArchetypes(unittest.TestCase):
@@ -356,8 +356,8 @@ def test_total_item_count_is_correct(self):
         # Fetch the second page of the batch
         response = self.api_session.get('/folder?b_start=2&b_size=2')
 
-        # Total count of items should be in items_count
-        self.assertEqual(5, response.json()['items_count'])
+        # Total count of items should be in total_items
+        self.assertEqual(5, response.json()['total_items'])
 
 
 class TestHypermediaBatch(unittest.TestCase):
@@ -368,13 +368,13 @@ def setUp(self):
         self.portal = self.layer['portal']
         self.request = self.portal.REQUEST
 
-    def test_items_count(self):
+    def test_total_items(self):
         items = range(1, 26)
         self.request.form['b_size'] = 10
         batch = HypermediaBatch(self.portal, self.request, items)
-        # items_count should be total number of items in the sequence
+        # total_items should be total number of items in the sequence
         self.assertEqual(
-            25, batch.items_count)
+            25, batch.total_items)
 
     def test_default_batch_size(self):
         items = range(1, 27)

src/plone/restapi/tests/test_search.py

@@ -83,9 +83,9 @@ def test_overall_response_format(self):
 
         results = response.json()
         self.assertEqual(
-            results[u'items_count'],
+            results[u'total_items'],
             len(results[u'member']),
-            'items_count property should match actual item count.'
+            'total_items property should match actual item count.'
         )
 
     def test_search_on_context_constrains_query_by_path(self):