Merge pull request #58 from metaforx/fix/nav-node-type-mismatch

fix: OpenAPI schema for nested navigation

Author: metaforx

djangocms_rest/serializers/menus.py

@@ -30,6 +30,7 @@ def get_children(self, obj: NavigationNode) -> list[dict]:
     def to_representation(self, obj: NavigationNode) -> dict:
         """Customize the base representation of the NavigationNode."""
         return {
+            "namespace": getattr(obj, "namespace", None),
             "title": obj.title,
             "url": get_absolute_frontend_url(self.request, obj.url),
             "api_endpoint": get_absolute_frontend_url(

djangocms_rest/views.py

@@ -55,11 +55,12 @@
                 location="query",
                 description="Set to true to preview unpublished content (admin access required)",
                 required=False,
-            )
+            ),
         ]
     )
 
-except ImportError: # pragma: no cover
+except ImportError:  # pragma: no cover
+
     class OpenApiTypes:
         BOOL = "boolean"
         INT = "integer"
@@ -76,6 +77,7 @@ def __init__(self, *args, **kwargs):
     def extend_schema(*_args, **_kwargs):  # pragma: no cover
         def _decorator(obj: T) -> T:
             return obj
+
         return _decorator
 
     def extend_placeholder_schema(func: Callable[P, T]) -> Callable[P, T]:
@@ -268,13 +270,32 @@ def get(self, request: Request) -> Response:
         return Response(definitions)
 
 
+try:
+    from drf_spectacular.utils import extend_schema, OpenApiResponse
+
+    def method_schema_decorator(method):
+        """
+        Decorator for adding OpenAPI schema to a method.
+        Needed to force the schema to use many=True for NavigationNodeSerializer.
+        """
+        return extend_schema(
+            responses=OpenApiResponse(response=NavigationNodeSerializer(many=True))
+        )(method)
+
+except ImportError:  # pragma: no cover
+
+    def method_schema_decorator(method):  # pragma: no cover
+        return method  # pragma: no cover
+
+
 class MenuView(BaseAPIView):
     permission_classes = [IsAllowedPublicLanguage]
     serializer_class = NavigationNodeSerializer
 
     tag = ShowMenu
     return_key = "children"
 
+    @method_schema_decorator
     def get(
         self,
         request: Request,