[#4267] Add catalogus endpoint, allow to filter against catalogus in the IOT endoint

Author: Viicos

docker/open-zaak/fixtures/open_zaak_fixtures.json

@@ -21,7 +21,7 @@
     "model": "catalogi.catalogus",
     "pk": 1,
     "fields": {
-        "_etag": "f324f0578ac42cf6f2a7f68df8819d29",
+        "_etag": "3b954569daa5871216ebb13dbf11eb9e",
         "naam": "Test catalog",
         "uuid": "bd58635c-793e-446d-a7e0-460d7b04829d",
         "domein": "TEST",
@@ -64,9 +64,9 @@
     "model": "catalogi.informatieobjecttype",
     "pk": 1,
     "fields": {
-        "_etag": "89c597c58e42b804148e6867c3480ed1",
+        "_etag": "bfa6b74c27efa9845576bf1d54281820",
         "datum_begin_geldigheid": "2024-03-19",
-        "datum_einde_geldigheid": null,
+        "datum_einde_geldigheid": "2024-07-10",
         "concept": false,
         "uuid": "7a474713-0833-402a-8441-e467c08ac55b",
         "omschrijving": "PDF Informatieobjecttype",
@@ -108,7 +108,7 @@
     "fields": {
         "_etag": "cf350f1b55d7eb0ccd17cceb88c1c6c8",
         "datum_begin_geldigheid": "2024-03-19",
-        "datum_einde_geldigheid": null,
+        "datum_einde_geldigheid": "2024-07-10",
         "concept": false,
         "uuid": "531f6c1a-97f7-478c-85f0-67d2f23661c7",
         "omschrijving": "Attachment Informatieobjecttype",
@@ -123,6 +123,27 @@
         "catalogus": 1
     }
 },
+{
+    "model": "catalogi.informatieobjecttype",
+    "pk": 4,
+    "fields": {
+        "_etag": "35fb6a08e82a1195076f698c3ac1725c",
+        "datum_begin_geldigheid": "2024-07-11",
+        "datum_einde_geldigheid": null,
+        "concept": false,
+        "uuid": "29b63e5c-3835-4f68-8fad-f2aea9ae6b71",
+        "omschrijving": "PDF Informatieobjecttype",
+        "informatieobjectcategorie": "Test category",
+        "trefwoord": "[]",
+        "vertrouwelijkheidaanduiding": "openbaar",
+        "omschrijving_generiek_informatieobjecttype": "",
+        "omschrijving_generiek_definitie": "",
+        "omschrijving_generiek_herkomst": "",
+        "omschrijving_generiek_hierarchie": "",
+        "omschrijving_generiek_opmerking": "",
+        "catalogus": 1
+    }
+},
 {
     "model": "catalogi.zaaktypeinformatieobjecttype",
     "pk": 1,

src/openforms/contrib/zgw/clients/catalogi.py

@@ -31,8 +31,17 @@ def get_all_catalogi(self) -> list[dict]:
         all_data = pagination_helper(self, data)
         return list(all_data)
 
-    def get_all_informatieobjecttypen(self) -> list[dict]:
-        response = self.get("informatieobjecttypen")
+    def get_all_informatieobjecttypen(
+        self, *, catalogus: str | None = None
+    ) -> list[dict]:
+        """List all informatieobjecttypen.
+
+        :arg catalogus: the catalogus URL the informatieobjecttypen should belong to.
+        """
+        params = {}
+        if catalogus is not None:
+            params["catalogus"] = catalogus
+        response = self.get("informatieobjecttypen", params=params)
         response.raise_for_status()
         data = response.json()
         all_data = pagination_helper(self, data)

src/openforms/registrations/api/filters.py

@@ -14,7 +14,7 @@
 from ..registry import register
 
 
-class ListInformatieObjectTypenQueryParamsSerializer(serializers.Serializer):
+class APIGroupQueryParamsSerializer(serializers.Serializer):
     zgw_api_group = PrimaryKeyRelatedAsChoicesField(
         queryset=ZGWApiGroupConfig.objects.all(),
         help_text=_(
@@ -77,3 +77,34 @@ def get_ztc_client(self) -> CatalogiClient | None:
             ]
             if service := objects_api_group.catalogi_service:
                 return build_client(service, client_factory=CatalogiClient)
+
+
+class ListInformatieObjectTypenQueryParamsSerializer(APIGroupQueryParamsSerializer):
+    catalogus_domein = serializers.CharField(
+        label=_("catalogus domein"),
+        help_text=_(
+            "Filter informatieobjecttypen against this catalogus domein."
+            "If provided, the RSIN should also be present."
+        ),
+        required=False,
+    )
+
+    catalogus_rsin = serializers.CharField(
+        label=_("catalogus RSIN"),
+        help_text=_(
+            "Filter informatieobjecttypen against this catalogus RSIN."
+            "If provided, the RSIN should also be present."
+        ),
+        required=False,
+    )
+
+    def validate(self, attrs: dict[str, Any]) -> dict[str, Any]:
+        attrs = super().validate(attrs)
+        if ("catalogus_domein" in attrs) ^ ("catalogus_rsin" in attrs):
+            raise serializers.ValidationError(
+                _(
+                    "'catalogus_domein' and 'catalogus_rsin' should be provided together."
+                )
+            )
+
+        return attrs

src/openforms/registrations/api/serializers.py

@@ -50,7 +50,7 @@ class Meta:
 class CatalogusDomainSerializer(APIModelSerializer):
     class Meta:
         model = Catalogus
-        fields = ("domein",)
+        fields = ("domein", "rsin")
 
 
 class InformatieObjectTypeChoiceSerializer(serializers.Serializer):

src/openforms/registrations/api/urls.py

@@ -1,6 +1,11 @@
 from django.urls import include, path
 
-from .views import AllAttributesListView, InformatieObjectTypenListView, PluginListView
+from .views import (
+    AllAttributesListView,
+    CatalogusListView,
+    InformatieObjectTypenListView,
+    PluginListView,
+)
 
 urlpatterns = [
     path("plugins", PluginListView.as_view(), name="registrations-plugin-list"),
@@ -9,6 +14,11 @@
         AllAttributesListView.as_view(),
         name="registrations-attribute-list",
     ),
+    path(
+        "catalogus",
+        CatalogusListView.as_view(),
+        name="catalogus-list",
+    ),
     path(
         "informatieobjecttypen",
         InformatieObjectTypenListView.as_view(),

src/openforms/registrations/api/views.py

@@ -10,8 +10,12 @@
 
 from ..constants import RegistrationAttribute
 from ..registry import register
-from .filters import ListInformatieObjectTypenQueryParamsSerializer
+from .filters import (
+    APIGroupQueryParamsSerializer,
+    ListInformatieObjectTypenQueryParamsSerializer,
+)
 from .serializers import (
+    CatalogusDomainSerializer,
     ChoiceWrapper,
     InformatieObjectTypeChoiceSerializer,
     RegistrationAttributeSerializer,
@@ -56,6 +60,35 @@ def get_objects(self):
         return [ChoiceWrapper(choice) for choice in choices]
 
 
+@extend_schema_view(
+    get=extend_schema(
+        summary=_("List available Catalogus"),
+        parameters=[APIGroupQueryParamsSerializer],
+    ),
+)
+class CatalogusListView(ListMixin, APIView):
+    """
+    List the available Catalogus based on the provided API group.
+    """
+
+    authentication_classes = (authentication.SessionAuthentication,)
+    permission_classes = (permissions.IsAdminUser,)
+    serializer_class = CatalogusDomainSerializer
+
+    def get_objects(self):
+        filter_serializer = APIGroupQueryParamsSerializer(
+            data=self.request.query_params
+        )
+        filter_serializer.is_valid(raise_exception=True)
+
+        client = filter_serializer.get_ztc_client()
+        if not client:
+            return []
+
+        catalogus_data = client.get_all_catalogi()
+        return factory(Catalogus, catalogus_data)
+
+
 @extend_schema_view(
     get=extend_schema(
         summary=_("List available InformatieObjectTypen"),
@@ -65,6 +98,10 @@ def get_objects(self):
 class InformatieObjectTypenListView(ListMixin, APIView):
     """
     List the available InformatieObjectTypen based on the configured registration backend and ZGW APIs services.
+
+    Each InformatieObjectType is uniquely identified by its 'omschrijving', 'catalogus',
+    and beginning and end date. If multiple same InformatieObjectTypen exist for different dates,
+    only one entry is returned.
     """
 
     authentication_classes = (authentication.SessionAuthentication,)
@@ -86,13 +123,48 @@ def get_objects(self):
             catalogus["url"]: catalogus for catalogus in catalogus_data
         }
 
-        iotypen_data = client.get_all_informatieobjecttypen()
-        iotypen = [
-            {
-                "informatieobjecttype": factory(InformatieObjectType, iotype),
-                "catalogus": factory(Catalogus, catalogus_mapping[iotype["catalogus"]]),
-            }
-            for iotype in iotypen_data
-        ]
+        if "catalogus_domein" in filter_serializer.validated_data:
+            domein = filter_serializer.validated_data["catalogus_domein"]
+            # `catalogus_rsin` is guaranteed to be present if `catalogus_domein` is:
+            rsin = filter_serializer.validated_data["catalogus_rsin"]
+
+            matching_catalogus: str | None = next(
+                (
+                    catalogus["url"]
+                    for catalogus in catalogus_data
+                    if catalogus["domein"] == domein and catalogus["rsin"] == rsin
+                ),
+                None,
+            )
+
+            if matching_catalogus is None:
+                return []
+
+            iotypen_data = client.get_all_informatieobjecttypen(
+                catalogus=matching_catalogus
+            )
+        else:
+            iotypen_data = client.get_all_informatieobjecttypen()
+
+        iotypen = []
+
+        for iotype in iotypen_data:
+            # fmt: off
+            exists = any(
+                existing_iotype["informatieobjecttype"].omschrijving == iotype["omschrijving"]
+                and existing_iotype["informatieobjecttype"].catalogus == iotype["catalogus"]
+                for existing_iotype in iotypen
+            )
+            # fmt: on
+
+            if not exists:
+                iotypen.append(
+                    {
+                        "informatieobjecttype": factory(InformatieObjectType, iotype),
+                        "catalogus": factory(
+                            Catalogus, catalogus_mapping[iotype["catalogus"]]
+                        ),
+                    }
+                )
 
         return iotypen

src/openforms/registrations/tests/files/vcr_cassettes/CatalogusAPIEndpointTests/CatalogusAPIEndpointTests.test_list_catalogus.yaml

@@ -0,0 +1,44 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate, br
+      Authorization:
+      - Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0ZXN0X2NsaWVudF9pZCIsImlhdCI6MTcyMDQ2MDQwNCwiY2xpZW50X2lkIjoidGVzdF9jbGllbnRfaWQiLCJ1c2VyX2lkIjoiIiwidXNlcl9yZXByZXNlbnRhdGlvbiI6IiJ9.gLx2nHgFUz7fAr9NSbLbT25FqSp97siXMARqdkbcaeU
+      Connection:
+      - keep-alive
+      User-Agent:
+      - python-requests/2.32.2
+    method: GET
+    uri: http://localhost:8003/catalogi/api/v1/catalogussen
+  response:
+    body:
+      string: '{"count":1,"next":null,"previous":null,"results":[{"url":"http://localhost:8003/catalogi/api/v1/catalogussen/bd58635c-793e-446d-a7e0-460d7b04829d","domein":"TEST","rsin":"000000000","contactpersoonBeheerNaam":"Test
+        name","contactpersoonBeheerTelefoonnummer":"","contactpersoonBeheerEmailadres":"","zaaktypen":["http://localhost:8003/catalogi/api/v1/zaaktypen/1f41885e-23fc-4462-bbc8-80be4ae484dc","http://localhost:8003/catalogi/api/v1/zaaktypen/119dbe23-cbf2-4759-80e5-29bb28b3d95f"],"besluittypen":[],"informatieobjecttypen":["http://localhost:8003/catalogi/api/v1/informatieobjecttypen/7a474713-0833-402a-8441-e467c08ac55b","http://localhost:8003/catalogi/api/v1/informatieobjecttypen/b2d83b94-9b9b-4e80-a82f-73ff993c62f3","http://localhost:8003/catalogi/api/v1/informatieobjecttypen/531f6c1a-97f7-478c-85f0-67d2f23661c7"],"naam":"Test
+        catalog","versie":"","begindatumVersie":null}]}'
+    headers:
+      API-version:
+      - 1.3.1
+      Allow:
+      - GET, POST, HEAD, OPTIONS
+      Content-Length:
+      - '886'
+      Content-Type:
+      - application/json
+      Cross-Origin-Opener-Policy:
+      - same-origin
+      Referrer-Policy:
+      - same-origin
+      Vary:
+      - Accept, origin
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+    status:
+      code: 200
+      message: OK
+version: 1