Merge pull request #487 from maykinmedia/fix/427-fix-inconsistent-choices-api

[#427] Fix inconsistent choices api

Author: SilviaAmAm

backend/src/openarchiefbeheer/utils/tests/gherkin.py

@@ -236,7 +236,7 @@ async def handle(route):
                     {
                         "label": "11.1 - Verleend - vernietigen - P1Y",
                         "value": "https://www.example.com",
-                        "detail": {
+                        "extraData": {
                             "bewaartermijn": "P5Y",
                         },
                     }

backend/src/openarchiefbeheer/zaken/api/serializers.py

@@ -61,35 +61,12 @@ class Meta:
 class ChoiceSerializer(serializers.Serializer):
     label = serializers.CharField(help_text=_("The description field of the choice."))
     value = serializers.CharField(help_text=_("The URL of the choice."))
-    extra = serializers.CharField(
+    extra_data = serializers.JSONField(
         help_text=_("Any extra information about this choice."),
         required=False,
     )
 
 
-class ZaaktypeChoiceSerializer(serializers.Serializer):
-    label = serializers.CharField(help_text=_("The description field of the zaaktype."))
-    value = serializers.CharField(help_text=_("The URL field of the zaaktype."))
-    extra = serializers.CharField(
-        help_text=_(
-            "A combination of the identification and the date on which "
-            "the zaaktype will no longer be valid (if present)."
-        ),
-        required=False,
-    )
-
-
-class SelectielijstklasseChoicesSerializer(serializers.Serializer):
-    label = serializers.CharField(
-        help_text=_(
-            "The description field of the resultaat from the selectielijst API."
-        )
-    )
-    value = serializers.CharField(
-        help_text=_("The URL field of the resultaat from the selectielijst API.")
-    )
-
-
 class SelectielijstklasseChoicesQueryParamSerializer(serializers.Serializer):
     zaak = serializers.URLField(
         required=False,

backend/src/openarchiefbeheer/zaken/api/views.py

@@ -25,8 +25,6 @@
 from .serializers import (
     ChoiceSerializer,
     SelectielijstklasseChoicesQueryParamSerializer,
-    SelectielijstklasseChoicesSerializer,
-    ZaaktypeChoiceSerializer,
 )
 
 
@@ -63,7 +61,7 @@ def get_queryset(self):
         ),
         tags=["private"],
         responses={
-            200: ZaaktypeChoiceSerializer(many=True),
+            200: ChoiceSerializer(many=True),
         },
     )
     @method_decorator(cache_page(60 * 15))
@@ -78,7 +76,7 @@ def get(self, request, *args, **kwargs):
         )
         zaaktypen_choices = format_zaaktype_choices(zaaktypen)
 
-        serializer = ZaaktypeChoiceSerializer(data=zaaktypen_choices, many=True)
+        serializer = ChoiceSerializer(data=zaaktypen_choices, many=True)
         serializer.is_valid(raise_exception=True)
         return Response(serializer.data, status=status.HTTP_200_OK)
 
@@ -93,7 +91,7 @@ class SelectielijstklasseChoicesView(APIView):
         ),
         tags=["private"],
         responses={
-            200: SelectielijstklasseChoicesSerializer,
+            200: ChoiceSerializer(many=True),
         },
         parameters=[SelectielijstklasseChoicesQueryParamSerializer],
     )

backend/src/openarchiefbeheer/zaken/tests/test_views.py

@@ -490,21 +490,21 @@ def test_retrieve_choices(self, m):
                 {
                     "value": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
                     "label": "11.1 - Verleend - vernietigen - P1Y",
-                    "detail": {
+                    "extraData": {
                         "bewaartermijn": "P1Y",
                     },
                 },
                 {
                     "value": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
                     "label": "1 - Verleend - vernietigen - P2Y",
-                    "detail": {
+                    "extraData": {
                         "bewaartermijn": "P2Y",
                     },
                 },
                 {
                     "value": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
                     "label": "11.1.2 - Verleend - vernietigen",
-                    "detail": {
+                    "extraData": {
                         "bewaartermijn": None,
                     },
                 },
@@ -575,21 +575,21 @@ def test_retrieve_choices_without_zaak(self, m):
                 {
                     "value": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
                     "label": "11.1 - Verleend - vernietigen - P1Y",
-                    "detail": {
+                    "extraData": {
                         "bewaartermijn": "P1Y",
                     },
                 },
                 {
                     "value": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
                     "label": "1 - Verleend - vernietigen - P2Y",
-                    "detail": {
+                    "extraData": {
                         "bewaartermijn": "P2Y",
                     },
                 },
                 {
                     "value": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
                     "label": "11.1.2 - Verleend - vernietigen",
-                    "detail": {
+                    "extraData": {
                         "bewaartermijn": None,
                     },
                 },

backend/src/openarchiefbeheer/zaken/types.py

@@ -6,4 +6,4 @@
 class DropDownChoice:
     label: str
     value: str
-    extra_data: Optional[int] = None
+    extra_data: Optional[dict] = None

backend/src/openarchiefbeheer/zaken/utils.py

@@ -120,7 +120,7 @@ def format_selectielijstklasse_choice(resultaat: Resultaat) -> DropDownChoice:
     return {
         "label": description,
         "value": resultaat["url"],
-        "detail": {
+        "extra_data": {
             "bewaartermijn": resultaat.get("bewaartermijn"),
         },
     }

frontend/src/pages/destructionlist/detail/pages/DestructionListProcessReviewPage/components/DestructionListProcessZaakReviewModal/DestructionListProcessZaakReviewModal.tsx

@@ -138,9 +138,11 @@ export const DestructionListProcessZaakReviewModal: React.FC<
   const getBewaartermijn = (selectielijstklasse: string) => {
     const selectedChoice = selectieLijstKlasseChoices.find(
       (choice) => choice.value === selectielijstklasse,
-    ) as (Option & { detail?: { bewaartermijn: string | null } }) | undefined;
+    ) as
+      | (Option & { extraData?: { bewaartermijn: string | null } })
+      | undefined;
 
-    return selectedChoice?.detail?.bewaartermijn;
+    return selectedChoice?.extraData?.bewaartermijn;
   };
 
   /**