🐛 Fix enum introspection on search serializer schema

Search introspection from query parameters didn't take choices/enums
into account, which is now fixed.

Author: sergei-maertens

vng_api_common/inspectors/query.py

@@ -30,6 +30,7 @@ def get_filter_parameters(self, filter_backend):
             for parameter in fields:
                 filter_field = filter_class.base_filters[parameter.name]
                 model_field = get_target_field(queryset.model, parameter.name)
+                parameter._filter_field = filter_field
 
                 help_text = filter_field.extra.get(
                     "help_text", model_field.help_text if model_field else ""

vng_api_common/inspectors/view.py

@@ -15,7 +15,11 @@
 from ..geo import GeoMixin
 from ..permissions import BaseAuthRequired, get_required_scopes
 from ..search import is_search_view
-from ..serializers import FoutSerializer, ValidatieFoutSerializer
+from ..serializers import (
+    FoutSerializer,
+    ValidatieFoutSerializer,
+    add_choice_values_help_text,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -232,10 +236,23 @@ def get_request_serializer(self):
             )
 
         filters = {}
-        for filter_field in filter_fields:
-            FieldClass = TYPE_TO_FIELDMAPPING[filter_field.type]
-            filters[filter_field.name] = FieldClass(
-                help_text=filter_field.description, required=filter_field.required
+        for parameter in filter_fields:
+            help_text = parameter.description
+            # we can't get the verbose_label back from the enum, so the inspector
+            # in vng_api_common.inspectors.fields leaves a filter field reference behind
+            _filter_field = getattr(parameter, "_filter_field", None)
+            choices = getattr(_filter_field, "extra", {}).get("choices", [])
+            if choices:
+                FieldClass = serializers.ChoiceField
+                extra = {"choices": choices}
+                value_display_mapping = add_choice_values_help_text(choices)
+                help_text += f"\n\n{value_display_mapping}"
+            else:
+                FieldClass = TYPE_TO_FIELDMAPPING[parameter.type]
+                extra = {}
+
+            filters[parameter.name] = FieldClass(
+                help_text=help_text, required=parameter.required, **extra
             )
 
         SearchSerializer = type(Base.__name__, (Base,), filters)

vng_api_common/serializers.py

@@ -1,5 +1,6 @@
 import datetime
 from collections import OrderedDict
+from typing import Tuple, Union
 
 from django.db import transaction
 
@@ -78,10 +79,12 @@ class ValidatieFoutSerializer(FoutSerializer):
     invalid_params = FieldValidationErrorSerializer(many=True)
 
 
-def add_choice_values_help_text(choices: DjangoChoices) -> str:
+def add_choice_values_help_text(choices: Union[DjangoChoices, Tuple[str, str]]) -> str:
     items = []
 
-    for key, value in choices.choices:
+    _choices = choices.choices if issubclass(choices, DjangoChoices) else choices
+
+    for key, value in _choices:
         description = getattr(choices.get_choice(key), "description", None)
         if description:
             item = f"* `{key}` - ({value}) {description}"