Merge pull request #236 from maykinmedia/feature/dynamic-pagination

Feature/dynamic pagination

requirements/base.txt

@@ -56,7 +56,7 @@ click-plugins==1.1.1
     # via celery
 click-repl==0.3.0
     # via celery
-commonground-api-common==1.13.2
+commonground-api-common==1.13.3
     # via open-api-framework
 coreapi==2.3.3
     # via commonground-api-common

requirements/ci.txt

@@ -112,7 +112,7 @@ click-repl==0.3.0
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   celery
-commonground-api-common==1.13.2
+commonground-api-common==1.13.3
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt

requirements/dev.txt

@@ -129,7 +129,7 @@ click-repl==0.3.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   celery
-commonground-api-common==1.13.2
+commonground-api-common==1.13.3
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt

src/openklant/components/contactgegevens/api/tests/test_apis.py

@@ -199,6 +199,19 @@ def test_update_partial_persoon(self):
         )
         self.assertEqual(data["land"], "5001")
 
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("contactgegevens:persoon-list")
+        PersoonFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")
+
 
 class OrganisatiesTests(APITestCase):
     def test_create_organisatie(self):
@@ -365,3 +378,16 @@ def test_update_partial_organisatie(self):
             },
         )
         self.assertEqual(data["land"], "5001")
+
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("contactgegevens:organisatie-list")
+        OrganisatieFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")

src/openklant/components/contactgegevens/api/viewset.py

@@ -1,6 +1,6 @@
 from drf_spectacular.utils import extend_schema, extend_schema_view
 from rest_framework import viewsets
-from rest_framework.pagination import PageNumberPagination
+from vng_api_common.pagination import DynamicPageSizePagination
 
 from openklant.components.contactgegevens.api.serializers import (
     OrganisatieSerializer,
@@ -44,7 +44,7 @@ class OrganisatieViewSet(viewsets.ModelViewSet):
     queryset = Organisatie.objects.order_by("-pk")
     serializer_class = OrganisatieSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
 
@@ -82,6 +82,6 @@ class PersoonViewSet(viewsets.ModelViewSet):
     queryset = Persoon.objects.order_by("-pk")
     serializer_class = PersoonSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)

src/openklant/components/contactgegevens/openapi.yaml

@@ -24,6 +24,12 @@ paths:
         description: Een pagina binnen de gepagineerde set resultaten.
         schema:
           type: integer
+      - name: pageSize
+        required: false
+        in: query
+        description: Het aantal resultaten terug te geven per pagina.
+        schema:
+          type: integer
       tags:
       - organisaties
       security:
@@ -168,6 +174,12 @@ paths:
         description: Een pagina binnen de gepagineerde set resultaten.
         schema:
           type: integer
+      - name: pageSize
+        required: false
+        in: query
+        description: Het aantal resultaten terug te geven per pagina.
+        schema:
+          type: integer
       tags:
       - personen
       security:

src/openklant/components/klantinteracties/api/tests/test_actoren.py

@@ -22,6 +22,19 @@ def test_list_actor(self):
         data = response.json()
         self.assertEqual(len(data["results"]), 2)
 
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("klantinteracties:actor-list")
+        ActorFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")
+
     def test_read_actor(self):
         actor = ActorFactory.create()
         detail_url = reverse(

src/openklant/components/klantinteracties/api/tests/test_digitaal_adres.py

@@ -25,6 +25,19 @@ def test_list_digitaal_adres(self):
         data = response.json()
         self.assertEqual(len(data["results"]), 2)
 
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("klantinteracties:digitaaladres-list")
+        DigitaalAdresFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")
+
     def test_read_digitaal_adres(self):
         digitaal_adres = DigitaalAdresFactory.create()
         detail_url = reverse(

src/openklant/components/klantinteracties/api/tests/test_internetaken.py

@@ -27,6 +27,19 @@ def test_list_internetaak(self):
         data = response.json()
         self.assertEqual(len(data["results"]), 2)
 
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("klantinteracties:internetaak-list")
+        InterneTaakFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")
+
     def test_read_internetaak(self):
         internetaak = InterneTaakFactory.create()
         detail_url = reverse(

src/openklant/components/klantinteracties/api/tests/test_klantcontacten.py

@@ -34,6 +34,19 @@ def test_list_klantcontact(self):
             self.assertEqual(data["results"][0]["hadBetrokkenActoren"], [])
             self.assertEqual(data["results"][1]["hadBetrokkenActoren"], [])
 
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("klantinteracties:klantcontact-list")
+        KlantcontactFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")
+
     def test_read_klantcontact(self):
         actor = ActorFactory.create(
             naam="Phil",

src/openklant/components/klantinteracties/api/tests/test_partijen.py

@@ -54,6 +54,19 @@ def test_list_partij(self):
                 ],
             )
 
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("klantinteracties:partij-list")
+        PartijFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")
+
     def test_read_partij(self):
         partij = PartijFactory.create()
         detail_url = reverse(

src/openklant/components/klantinteracties/api/tests/test_rekeningnummers.py

@@ -22,6 +22,19 @@ def test_list_rekeningnummer(self):
         data = response.json()
         self.assertEqual(len(data["results"]), 2)
 
+    def test_list_pagination_pagesize_param(self):
+        list_url = reverse("klantinteracties:rekeningnummer-list")
+        RekeningnummerFactory.create_batch(10)
+
+        response = self.client.get(list_url, {"pageSize": 5})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+        self.assertEqual(data["count"], 10)
+        self.assertEqual(len(data["results"]), 5)
+        self.assertEqual(data["next"], f"http://testserver{list_url}?page=2&pageSize=5")
+
     def test_read_rekeningnummer(self):
         rekeningnummer = RekeningnummerFactory.create()
         detail_url = reverse(

src/openklant/components/klantinteracties/api/viewsets/actoren.py

@@ -1,6 +1,6 @@
 from drf_spectacular.utils import extend_schema, extend_schema_view
 from rest_framework import viewsets
-from rest_framework.pagination import PageNumberPagination
+from vng_api_common.pagination import DynamicPageSizePagination
 
 from openklant.components.klantinteracties.api.filterset.actoren import ActorenFilterSet
 from openklant.components.klantinteracties.api.serializers.actoren import (
@@ -48,7 +48,7 @@ class ActorViewSet(viewsets.ModelViewSet):
     )
     serializer_class = ActorSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filterset_class = ActorenFilterSet
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)

src/openklant/components/klantinteracties/api/viewsets/digitaal_adres.py

@@ -1,6 +1,6 @@
 from drf_spectacular.utils import extend_schema, extend_schema_view
 from rest_framework import viewsets
-from rest_framework.pagination import PageNumberPagination
+from vng_api_common.pagination import DynamicPageSizePagination
 
 from openklant.components.klantinteracties.api.filterset.digitaal_adres import (
     DigitaalAdresDetailFilterSet,
@@ -54,7 +54,7 @@ class DigitaalAdresViewSet(ExpandMixin, viewsets.ModelViewSet):
     )
     serializer_class = DigitaalAdresSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
 

src/openklant/components/klantinteracties/api/viewsets/internetaken.py

@@ -1,6 +1,6 @@
 from drf_spectacular.utils import extend_schema, extend_schema_view
 from rest_framework import viewsets
-from rest_framework.pagination import PageNumberPagination
+from vng_api_common.pagination import DynamicPageSizePagination
 
 from openklant.components.klantinteracties.api.filterset.internetaken import (
     InternetaakFilterSet,
@@ -50,7 +50,7 @@ class InterneTaakViewSet(viewsets.ModelViewSet):
     )
     serializer_class = InterneTaakSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filterset_class = InternetaakFilterSet
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)

src/openklant/components/klantinteracties/api/viewsets/klantcontacten.py

@@ -1,7 +1,7 @@
 from django_filters.rest_framework import DjangoFilterBackend
 from drf_spectacular.utils import extend_schema, extend_schema_view
 from rest_framework import viewsets
-from rest_framework.pagination import PageNumberPagination
+from vng_api_common.pagination import DynamicPageSizePagination
 
 from openklant.components.klantinteracties.api.filterset.klantcontacten import (
     ActorKlantcontactFilterSet,
@@ -68,7 +68,7 @@ class KlantcontactViewSet(ExpandMixin, viewsets.ModelViewSet):
     )
     serializer_class = KlantcontactSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
 
@@ -127,7 +127,7 @@ class BetrokkeneViewSet(viewsets.ModelViewSet):
     )
     serializer_class = BetrokkeneSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filterset_class = BetrokkeneFilterSet
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
@@ -167,7 +167,7 @@ class OnderwerpobjectViewSet(viewsets.ModelViewSet):
     )
     serializer_class = OnderwerpobjectSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filter_backends = [DjangoFilterBackend]
     filterset_fields = [
         "onderwerpobjectidentificator_object_id",
@@ -210,7 +210,7 @@ class BijlageViewSet(viewsets.ModelViewSet):
     queryset = Bijlage.objects.order_by("-pk").select_related("klantcontact")
     serializer_class = BijlageSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filter_backends = [DjangoFilterBackend]
     filterset_fields = [
         "bijlageidentificator_object_id",
@@ -258,7 +258,7 @@ class ActorKlantcontactViewSet(viewsets.ModelViewSet):
     )
     serializer_class = ActorKlantcontactSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filterset_class = ActorKlantcontactFilterSet
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)

src/openklant/components/klantinteracties/api/viewsets/partijen.py

@@ -1,7 +1,7 @@
 from django_filters.rest_framework import DjangoFilterBackend
 from drf_spectacular.utils import extend_schema, extend_schema_view
 from rest_framework import viewsets
-from rest_framework.pagination import PageNumberPagination
+from vng_api_common.pagination import DynamicPageSizePagination
 
 from openklant.components.klantinteracties.api.filterset.partijen import (
     CategorieRelatieFilterSet,
@@ -72,7 +72,7 @@ class PartijViewSet(ExpandMixin, viewsets.ModelViewSet):
     )
     serializer_class = PartijSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
 
@@ -122,7 +122,7 @@ class VertegenwoordigdenViewSet(viewsets.ModelViewSet):
     )
     serializer_class = VertegenwoordigdenSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filterset_class = VertegenwoordigdenFilterSet
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
@@ -165,7 +165,7 @@ class CategorieRelatieViewSet(viewsets.ModelViewSet):
     serializer_class = CategorieRelatieSerializer
     lookup_field = "uuid"
     filterset_class = CategorieRelatieFilterSet
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
 
@@ -203,7 +203,7 @@ class CategorieViewSet(viewsets.ModelViewSet):
     queryset = Categorie.objects.order_by("-pk")
     serializer_class = CategorieSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
 
@@ -241,7 +241,7 @@ class PartijIdentificatorViewSet(viewsets.ModelViewSet):
     queryset = PartijIdentificator.objects.order_by("-pk").select_related("partij")
     serializer_class = PartijIdentificatorSerializer
     lookup_field = "uuid"
-    pagination_class = PageNumberPagination
+    pagination_class = DynamicPageSizePagination
     filter_backends = [DjangoFilterBackend]
     filterset_fields = [
         "andere_partij_identificator",