Merge pull request #435 from maykinmedia/issue/329-history-paginated

🐛 [#329] paginate object_history endpoint
maykinmedia · Aug 21, 2024 · 2bf6063 · 2bf6063
2 parents 41b8731 + 0078b72
commit 2bf6063
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 24 deletions.
diff --git a/src/objects/api/v2/views.py b/src/objects/api/v2/views.py
@@ -117,6 +117,12 @@ def perform_destroy(self, instance):
     def history(self, request, uuid=None):
         """Retrieve all RECORDs of an OBJECT."""
         records = self.get_object().object.records.order_by("id")
+
+        page = self.paginate_queryset(records)
+        if page is not None:
+            serializer = self.get_serializer(page, many=True)
+            return self.get_paginated_response(serializer.data)
+
         serializer = self.get_serializer(records, many=True)
         return Response(serializer.data)
 

diff --git a/src/objects/tests/v2/test_object_api.py b/src/objects/tests/v2/test_object_api.py
@@ -301,30 +301,35 @@ def test_history_object(self, m):
 
         self.assertEqual(
             data,
-            [
-                {
-                    "index": 1,
-                    "typeVersion": record1.version,
-                    "data": record1.data,
-                    "geometry": json.loads(record1.geometry.json),
-                    "startAt": record1.start_at.isoformat(),
-                    "endAt": record2.start_at.isoformat(),
-                    "registrationAt": record1.registration_at.isoformat(),
-                    "correctionFor": None,
-                    "correctedBy": 2,
-                },
-                {
-                    "index": 2,
-                    "typeVersion": record2.version,
-                    "data": record2.data,
-                    "geometry": json.loads(record2.geometry.json),
-                    "startAt": record2.start_at.isoformat(),
-                    "endAt": None,
-                    "registrationAt": date.today().isoformat(),
-                    "correctionFor": 1,
-                    "correctedBy": None,
-                },
-            ],
+            {
+                "count": 2,
+                "next": None,
+                "previous": None,
+                "results": [
+                    {
+                        "index": 1,
+                        "typeVersion": record1.version,
+                        "data": record1.data,
+                        "geometry": json.loads(record1.geometry.json),
+                        "startAt": record1.start_at.isoformat(),
+                        "endAt": record2.start_at.isoformat(),
+                        "registrationAt": record1.registration_at.isoformat(),
+                        "correctionFor": None,
+                        "correctedBy": 2,
+                    },
+                    {
+                        "index": 2,
+                        "typeVersion": record2.version,
+                        "data": record2.data,
+                        "geometry": json.loads(record2.geometry.json),
+                        "startAt": record2.start_at.isoformat(),
+                        "endAt": None,
+                        "registrationAt": date.today().isoformat(),
+                        "correctionFor": 1,
+                        "correctedBy": None,
+                    },
+                ],
+            },
         )
 
     # In the ticket https://github.com/maykinmedia/objects-api/issues/282 we discovered that updating an object \