🎨 [#209] combined detail and normal filterset classes for digitaal ad…

…res api endpoint
maykinmedia · Aug 15, 2024 · a5d58db · a5d58db
1 parent 482729c
commit a5d58db
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 4 deletions.
diff --git a/src/openklant/components/klantinteracties/api/filterset/digitaal_adres.py b/src/openklant/components/klantinteracties/api/filterset/digitaal_adres.py
@@ -11,7 +11,7 @@
 from openklant.components.utils.filters import ExpandFilter
 
 
-class DigitaalAdresExpandFilterSet(FilterSet):
+class DigitaalAdresDetailFilterSet(FilterSet):
     expand = ExpandFilter(serializer_class=DigitaalAdresSerializer)
 
 

diff --git a/src/openklant/components/klantinteracties/api/viewsets/digitaal_adres.py b/src/openklant/components/klantinteracties/api/viewsets/digitaal_adres.py
@@ -3,7 +3,7 @@
 from rest_framework.pagination import PageNumberPagination
 
 from openklant.components.klantinteracties.api.filterset.digitaal_adres import (
-    DigitaalAdresExpandFilterSet,
+    DigitaalAdresDetailFilterSet,
     DigitaalAdresFilterSet,
 )
 from openklant.components.klantinteracties.api.serializers.digitaal_adres import (
@@ -55,7 +55,6 @@ class DigitaalAdresViewSet(ExpandMixin, viewsets.ModelViewSet):
     serializer_class = DigitaalAdresSerializer
     lookup_field = "uuid"
     pagination_class = PageNumberPagination
-    filterset_class = DigitaalAdresFilterSet
     authentication_classes = (TokenAuthentication,)
     permission_classes = (TokenPermissions,)
 
@@ -64,4 +63,6 @@ def filterset_class(self):
         """
         support expand in the detail endpoint
         """
-        return DigitaalAdresExpandFilterSet
+        if self.detail:
+            return DigitaalAdresDetailFilterSet
+        return DigitaalAdresFilterSet
diff --git a/src/openklant/components/klantinteracties/openapi.yaml b/src/openklant/components/klantinteracties/openapi.yaml
@@ -1065,6 +1065,18 @@ paths:
       description: Alle digitale adressen opvragen.
       summary: Alle digitale adressen opvragen.
       parameters:
+      - in: query
+        name: adres
+        schema:
+          type: string
+        description: Zoek digitaal adres(sen) object(en) op basis van adres dat exact
+          gelijk moet zijn aan deze waarde.
+      - in: query
+        name: adres__icontains
+        schema:
+          type: string
+        description: Zoek digitaal adres(sen) object(en) op basis van adres die de
+          opgegeven waarden bevat.
       - in: query
         name: expand
         schema:
@@ -1080,12 +1092,66 @@ paths:
 
         explode: false
         style: form
+      - in: query
+        name: omschrijving
+        schema:
+          type: string
+        description: Zoek digitaal adres(sen) object(en) op basis van omschijving
+          die de opgegeven waarden bevat.
       - name: page
         required: false
         in: query
         description: Een pagina binnen de gepagineerde set resultaten.
         schema:
           type: integer
+      - in: query
+        name: soortDigitaalAdres
+        schema:
+          type: string
+        description: Zoek digitaal adres(sen) object(en) op basis van het soort digitaal
+          adres dat exact gelijk moet zijn aan deze waarde.
+      - in: query
+        name: verstrektDoorBetrokkene__rol
+        schema:
+          type: string
+          enum:
+          - klant
+          - vertegenwoordiger
+        description: Zoek digitaal adres(sen) object(en) op basis van de betrokkene
+          rol.
+      - in: query
+        name: verstrektDoorBetrokkene__url
+        schema:
+          type: string
+        description: Zoek digitaal adres(sen) object(en) op basis van de betrokkene
+          url.
+      - in: query
+        name: verstrektDoorBetrokkene__uuid
+        schema:
+          type: string
+          format: uuid
+        description: Zoek digitaal adres(sen) object(en) op basis van de betrokkene
+          uuid.
+      - in: query
+        name: verstrektDoorPartij__soortPartij
+        schema:
+          type: string
+          enum:
+          - contactpersoon
+          - organisatie
+          - persoon
+        description: Zoek digitaal adres(sen) object(en) op basis van de partij soort.
+      - in: query
+        name: verstrektDoorPartij__url
+        schema:
+          type: string
+        description: Zoek digitaal adres(sen) object(en) op basis van de partij url.
+      - in: query
+        name: verstrektDoorPartij__uuid
+        schema:
+          type: string
+          format: uuid
+        description: Zoek digitaal adres(sen) object(en) op basis van de partij uuid.
       tags:
       - digitale adressen
       security: