✨ Add schema

Removes pagination as per the reference openapi spec.

Author: CharString

src/openklant/components/referentielijsten/api/schema.py

@@ -0,0 +1,20 @@
+from django.conf import settings
+
+from drf_yasg import openapi
+
+description = """
+Een API om de referentielijsten in het domein klantinteracties te raadplegen en beheren.
+""".strip()
+
+info = openapi.Info(
+    title="Klantinteracties Referentielijsten",
+    default_version=settings.REFERENTIELIJSTEN_API_VERSION,
+    description=description,
+    contact=openapi.Contact(
+        email="standaarden.ondersteuning@vng.nl",
+        url="https://vng-realisatie.github.io/klantinteracties/",
+    ),
+    license=openapi.License(
+        name="EUPL 1.2", url="https://opensource.org/licenses/EUPL-1.2"
+    ),
+)

src/openklant/components/referentielijsten/api/tests/test_externe_registers.py

@@ -13,8 +13,7 @@ def test_getexterneregisters(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response_data = response.json()
-        self.assertEqual(response_data["count"], 1000)
-        self.assertLess(len(response_data["results"]), 1000)
+        self.assertEqual(len(response_data), 1000)
 
     def test_postregister(self):
         url = reverse("referentielijsten:externregister-list")

src/openklant/components/referentielijsten/api/tests/test_kanalen.py

@@ -13,7 +13,7 @@ def test_getkanalen(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response_data = response.json()
-        self.assertEqual(response_data["count"], 6)
+        self.assertEqual(len(response_data), 6)
 
     def test_postkanaal(self):
         url = reverse("referentielijsten:kanaal-list")

src/openklant/components/referentielijsten/api/tests/test_landen.py

@@ -13,7 +13,7 @@ def test_getlanden(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response_data = response.json()
-        self.assertEqual(response_data["count"], 6)
+        self.assertEqual(len(response_data), 6)
 
     def test_postland(self):
         url = reverse("referentielijsten:land-list")

src/openklant/components/referentielijsten/api/tests/test_soorten_digitaal_adres.py

@@ -13,7 +13,7 @@ def test_getsoortendigitaaladres(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response_data = response.json()
-        self.assertEqual(response_data["count"], 6)
+        self.assertEqual(len(response_data), 6)
 
     def test_postsoortdigitaaladres(self):
         url = reverse("referentielijsten:soortdigitaaladres-list")

src/openklant/components/referentielijsten/api/tests/test_soorten_object.py

@@ -13,7 +13,7 @@ def test_getsoortenobject(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response_data = response.json()
-        self.assertEqual(response_data["count"], 6)
+        self.assertEqual(len(response_data), 6)
 
     def test_postsoortobject(self):
         url = reverse("referentielijsten:soortobject-list")

src/openklant/components/referentielijsten/api/tests/test_soorten_objectid.py

@@ -13,7 +13,7 @@ def test_getsoortenobjectid(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response_data = response.json()
-        self.assertEqual(response_data["count"], 6)
+        self.assertEqual(len(response_data), 6)
 
     def test_postsoortobjectid(self):
         url = reverse("referentielijsten:soortobjectid-list")

src/openklant/components/referentielijsten/api/tests/test_talen.py

@@ -13,7 +13,7 @@ def test_gettalen(self):
         response = self.client.get(url)
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response_data = response.json()
-        self.assertEqual(response_data["count"], 6)
+        self.assertEqual(len(response_data), 6)
 
     def test_posttaal(self):
         url = reverse("referentielijsten:taal-list")

src/openklant/components/referentielijsten/api/urls.py

@@ -1,9 +1,10 @@
 from django.conf import settings
-from django.urls import include, path
+from django.urls import include, path, re_path
 
-from vng_api_common import routers
+from vng_api_common import routers, schema
 
 from . import viewsets
+from .schema import info
 
 app_name = "referentielijsten"
 
@@ -17,13 +18,27 @@
 router.register("talen", viewsets.TaalViewSet)
 
 
+class SchemaView(schema.SchemaView):
+    schema_path = settings.SPEC_URL["referentielijsten"]
+    info = info
+
+
 urlpatterns = [
     path(
-        "v<slug:version>/",
+        "v<version>/",
         include(
             [
-                # TODO API documentation
-                # re_path(r"^schema/openapi(?P<format>\.json|\.yaml)$",
+                # API documentation
+                re_path(
+                    r"^schema/openapi(?P<format>\.json|\.yaml)$",
+                    SchemaView.without_ui(cache_timeout=None),
+                    name="schema-json-referentielijsten",
+                ),
+                path(
+                    "schema/",
+                    SchemaView.with_ui("redoc", cache_timeout=None),
+                    name="schema-redoc-klantinteracties",
+                ),
                 path("", include(router.urls)),
             ]
         ),

src/openklant/components/referentielijsten/api/viewsets/externe_registers.py

@@ -1,12 +1,12 @@
 from rest_framework import viewsets
-from rest_framework.pagination import PageNumberPagination
 
 from ...models import ExternRegister
 from ..serializers import ExternRegisterSerializer
 
 
 class ExternRegisterViewSet(viewsets.ModelViewSet):
+    __doc__ = ExternRegister.__doc__
     lookup_field = "code"
-    pagination_class = PageNumberPagination
+    pagination_class = None
     queryset = ExternRegister.objects.order_by("-pk")
     serializer_class = ExternRegisterSerializer