Skip to content

Commit

Permalink
✨ [#214] added digitaal adres expand in redoc
Browse files Browse the repository at this point in the history
  • Loading branch information
bart-maykin committed Aug 14, 2024
1 parent 3ec3d3f commit 43e7ef7
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
from django_filters.rest_framework import FilterSet

from openklant.components.klantinteracties.api.serializers.digitaal_adres import (
DigitaalAdresSerializer,
)
from openklant.components.utils.filters import ExpandFilter


class DigitaalAdresExpandFilterSet(FilterSet):
expand = ExpandFilter(serializer_class=DigitaalAdresSerializer)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
from rest_framework import viewsets
from rest_framework.pagination import PageNumberPagination

from openklant.components.klantinteracties.api.filterset.digitaal_adres import (
DigitaalAdresExpandFilterSet,
)
from openklant.components.klantinteracties.api.serializers.digitaal_adres import (
DigitaalAdresSerializer,
)
Expand Down Expand Up @@ -53,3 +56,10 @@ class DigitaalAdresViewSet(ExpandMixin, viewsets.ModelViewSet):
pagination_class = PageNumberPagination
authentication_classes = (TokenAuthentication,)
permission_classes = (TokenPermissions,)

@property
def filterset_class(self):
"""
support expand in the detail endpoint
"""
return DigitaalAdresExpandFilterSet
30 changes: 30 additions & 0 deletions src/openklant/components/klantinteracties/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1065,6 +1065,21 @@ paths:
description: Alle digitale adressen opvragen.
summary: Alle digitale adressen opvragen.
parameters:
- in: query
name: expand
schema:
type: array
items:
type: string
enum:
- verstrektDoorBetrokkene
- verstrektDoorBetrokkene.hadKlantcontact
- verstrektDoorBetrokkene.hadKlantcontact.leiddeTotInterneTaken
description: |+
Sluit de gespecifieerde gerelateerde resources in in het antwoord.
explode: false
style: form
- name: page
required: false
in: query
Expand Down Expand Up @@ -1109,6 +1124,21 @@ paths:
description: Een specifiek digitaal adres opvragen.
summary: Een specifiek digitaal adres opvragen.
parameters:
- in: query
name: expand
schema:
type: array
items:
type: string
enum:
- verstrektDoorBetrokkene
- verstrektDoorBetrokkene.hadKlantcontact
- verstrektDoorBetrokkene.hadKlantcontact.leiddeTotInterneTaken
description: |+
Sluit de gespecifieerde gerelateerde resources in in het antwoord.
explode: false
style: form
- in: path
name: uuid
schema:
Expand Down

0 comments on commit 43e7ef7

Please sign in to comment.