[API] Filter refactor

src/backend/InvenTree/InvenTree/api_version.py

@@ -1,11 +1,14 @@
 """InvenTree API version information."""
 
 # InvenTree API version
-INVENTREE_API_VERSION = 440
+INVENTREE_API_VERSION = 441
 """Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
 
 INVENTREE_API_TEXT = """
 
+v441 -> 2026-01-16 : https://github.com/inventree/InvenTree/pull/11073
+    - Add OptionalField class for cleaner handling of optional fields in serializers
+
 v440 -> 2026-01-15 : https://github.com/inventree/InvenTree/pull/10796
     - Adds confirm and confirm_text to all settings
 

src/backend/InvenTree/InvenTree/metadata.py

@@ -364,6 +364,15 @@ def get_field_info(self, field):
 
         We take the regular DRF metadata and add our own unique flavor
         """
+        from InvenTree.serializers import OptionalField
+
+        if isinstance(field, OptionalField) or issubclass(
+            field.__class__, OptionalField
+        ):
+            # Rehydrate the OptionalField for proper introspection
+            rehydrated_field = field.serializer_class(**(field.serializer_kwargs or {}))
+            return self.get_field_info(rehydrated_field)
+
         # Try to add the child property to the dependent field to be used by the super call
         if self.label_lookup[field] == 'dependent field':
             field.get_child(raise_exception=True)

src/backend/InvenTree/InvenTree/mixins.py

@@ -6,7 +6,6 @@
 from rest_framework.response import Response
 
 import data_exporter.mixins
-import data_exporter.serializers
 import importer.mixins
 from InvenTree.fields import InvenTreeNotesField, OutputConfiguration
 from InvenTree.helpers import (
@@ -223,20 +222,6 @@ def __init_subclass__(cls, **kwargs):
         if getattr(cls, 'output_options', None) is not None:
             schema_for_view_output_options(cls)
 
-    def __init__(self) -> None:
-        """Initialize the mixin. Check that the serializer is compatible."""
-        super().__init__()
-
-        # Check that the serializer was defined
-        if (
-            hasattr(self, 'serializer_class')
-            and isinstance(self.serializer_class, type)
-            and (not issubclass(self.serializer_class, FilterableSerializerMixin))
-        ):
-            raise Exception(
-                'INVE-I2: `OutputOptionsMixin` can only be used with serializers that contain the `FilterableSerializerMixin` mixin'
-            )
-
     def get_serializer(self, *args, **kwargs):
         """Return serializer instance with output options applied."""
         request = getattr(self, 'request', None)
@@ -250,20 +235,7 @@ def get_serializer(self, *args, **kwargs):
         context['request'] = request
         kwargs['context'] = context
 
-        serializer = super().get_serializer(*args, **kwargs)
-
-        # Check if the serializer actually can be filtered - makes not much sense to use this mixin without that prerequisite
-        if isinstance(
-            serializer, data_exporter.serializers.DataExportOptionsSerializer
-        ):
-            # Skip in this instance, special case for determining export options
-            pass
-        elif not isinstance(serializer, FilterableSerializerMixin):
-            raise Exception(
-                'INVE-I2: `OutputOptionsMixin` can only be used with serializers that contain the `FilterableSerializerMixin` mixin'
-            )
-
-        return serializer
+        return super().get_serializer(*args, **kwargs)
 
     def get_queryset(self):
         """Return the queryset with output options applied.