refactor(apps) add schemas for accounts views and debug all issues in drf spectacular console

Author: tyronejosee

apps/orders/viewsets.py

@@ -50,6 +50,9 @@ class OrderViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
     # filterset_class = OrderFilter
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return Order.objects.none()
+
         user = self.request.user
         if self.action == "list":
             return Order.objects.get_list_by_user(user)
@@ -388,6 +391,9 @@ class OrderItemViewSet(ModelViewSet):
     # filterset_class = OrderItemFilter
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return OrderItem.objects.none()
+        # ! TODO: Add managers and optimize queries
         return OrderItem.objects.filter(
             order_id=self.kwargs["order_pk"]
         ).select_related("order_id", "food_id")

apps/promotions/viewsets.py

@@ -38,6 +38,8 @@ class PromotionViewSet(ListCacheMixin, LogicalDeleteMixin, ModelViewSet):
     filterset_class = PromotionFilter
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return Promotion.objects.none()
         return Promotion.objects.get_active()
 
     def get_serializer_class(self):

apps/restaurants/schemas.py

@@ -1,6 +1,10 @@
 """Schemas for Restaurants App."""
 
-from drf_spectacular.utils import extend_schema, OpenApiResponse
+from drf_spectacular.utils import (
+    extend_schema,
+    OpenApiResponse,
+    OpenApiParameter,
+)
 
 from apps.reviews.serializers import ReviewReadSerializer, ReviewWriteSerializer
 from apps.orders.serializers import OrderReadSerializer
@@ -288,6 +292,14 @@
     "list": extend_schema(
         summary="Get Several Restaurant Reviews",
         description="Get a list of all available restaurant reviews.",
+        parameters=[
+            OpenApiParameter(
+                name="restaurant_pk",
+                description="The UUID of the restaurant",
+                required=True,
+                type=str,  # ! TODO: Fix type of path parameter restaurant_pk (UUID or SRT)
+            ),
+        ],
         responses={
             200: OpenApiResponse(
                 response=ReviewReadSerializer(many=True),

apps/restaurants/viewsets.py

@@ -147,6 +147,9 @@ class CategoryViewSet(ModelViewSet):
     search_fields = ["name"]
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return Category.objects.none()
+        # ! TODO: Add managers and optimize queries
         if self.action == "list":
             return Category.objects.filter(
                 restaurant_id=self.kwargs["restaurant_pk"], is_available=True
@@ -227,6 +230,9 @@ class FoodViewSet(ModelViewSet):
     # Filterset_class = FoodFilter
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return Food.objects.none()
+        # ! TODO: Add managers and optimize queries
         if self.action == "list":
             return Food.objects.filter(restaurant_id=self.kwargs["restaurant_pk"]).only(
                 "id",
@@ -318,6 +324,9 @@ class RestaurantReviewViewSet(ModelViewSet):
     # Filterset_class = ReviewFilter
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return Review.objects.none()
+        # ! TODO: Add managers and optimize queries
         return (
             Review.objects.filter(
                 object_id=self.kwargs["restaurant_pk"],

apps/users/schemas.py

@@ -1,11 +1,14 @@
 """Schemas for Users App."""
 
-from drf_spectacular.utils import extend_schema, OpenApiResponse
+from drf_spectacular.utils import extend_schema, OpenApiResponse, OpenApiParameter
 
+from apps.orders.serializers import OrderReadSerializer, OrderReportReadSerializer
+from apps.reviews.serializers import ReviewReadSerializer
 from .serializers import (
     UserReadSerializer,
     UserWriteSerializer,
     UserMinimalSerializer,
+    UserHistorySerializer,
 )
 
 
@@ -245,3 +248,79 @@
         tags=["socials"],
     ),
 }
+
+
+user_review_schemas = {
+    "get": extend_schema(
+        summary="Get Reviews of Authenticated User",
+        description="This endpoint returns a list of reviews created by the authenticated user, only for `IsClient` users.",
+        responses={
+            200: OpenApiResponse(
+                response=ReviewReadSerializer(many=True),
+                description="OK (List of reviews successfully retrieved)",
+            ),
+            404: OpenApiResponse(
+                description="Not Found (Reviews not found)",
+            ),
+        },
+        tags=["accounts"],
+    ),
+}
+
+user_order_schemas = {
+    "get": extend_schema(
+        summary="Get Orders of Authenticated User",
+        description="This endpoint returns a list of orders created by the authenticated user, only for `IsClient` users.",
+        responses={
+            200: OpenApiResponse(
+                response=OrderReadSerializer(many=True),
+                description="OK (List of orders successfully retrieved)",
+            ),
+            404: OpenApiResponse(
+                description="Not Found (Orders not found)",
+            ),
+        },
+        tags=["accounts"],
+    ),
+}
+
+
+user_order_report_schemas = {
+    "get": extend_schema(
+        summary="Get Order Reports of Authenticated User",
+        description="This endpoint returns a list of order reports created by the authenticated user, only for `IsClient` users.",
+        responses={
+            200: OpenApiResponse(
+                response=OrderReportReadSerializer(many=True),
+                description="OK (List of orders reports successfully retrieved)",
+            ),
+            404: OpenApiResponse(
+                description="Not Found (Orders reports not found)",
+            ),
+        },
+        tags=["accounts"],
+    ),
+}
+
+
+user_history_schemas = {
+    "get": extend_schema(
+        summary="Get User History",
+        description="This endpoint returns a history of actions performed by a specific user, identified by user ID, only for `IsAdministrator` users.",
+        parameters=[
+            OpenApiParameter(
+                "id", description="ID of the user", required=True, type=int
+            ),
+        ],
+        responses={
+            200: OpenApiResponse(
+                response=UserHistorySerializer(many=True),
+                description="OK (List of user history successfully retrieved)",
+            ),
+            404: OpenApiResponse(
+                description="Not Found (User not found)",
+            ),
+        },
+        tags=["accounts"],
+    ),
+}

apps/users/views.py

@@ -24,6 +24,10 @@
     token_refresh_schemas,
     token_verify_schemas,
     provider_auth_schemas,
+    user_review_schemas,
+    user_order_schemas,
+    user_order_report_schemas,
+    user_history_schemas,
 )
 
 
@@ -75,6 +79,7 @@ class ProviderAuthExtensionView(ProviderAuthView):
     pass
 
 
+@extend_schema_view(**user_review_schemas)
 class UserReviewsView(ListAPIView):
     """
     View to list all reviews of a user.
@@ -88,9 +93,12 @@ class UserReviewsView(ListAPIView):
     # filterset_class = ReviewFilter
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return Review.objects.none()
         return Review.objects.filter(user_id=self.request.user)
 
 
+@extend_schema_view(**user_order_schemas)
 class UserOrdersView(ListAPIView):
     """
     View to list all orders of a user.
@@ -104,9 +112,12 @@ class UserOrdersView(ListAPIView):
     # filterset_class = OrderFilter
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return Order.objects.none()
         return Order.objects.filter(user_id=self.request.user)
 
 
+@extend_schema_view(**user_order_report_schemas)
 class UserOrderReportsView(ListAPIView):
     """
     View to list all order reports of a user.
@@ -119,9 +130,12 @@ class UserOrderReportsView(ListAPIView):
     serializer_class = OrderReportReadSerializer
 
     def get_queryset(self):
+        if getattr(self, "swagger_fake_view", False):
+            return OrderReport.objects.none()
         return OrderReport.objects.get_by_user(self.request.user)
 
 
+@extend_schema_view(**user_history_schemas)
 class UserHistoryView(APIView):
     """
     View to list all history of a user.

config/settings/base.py

@@ -300,6 +300,10 @@
             "name": "users",
             "description": "Operations related to users",
         },
+        {
+            "name": "accounts",
+            "description": "Operations related to accounts",
+        },
         {
             "name": "positions",
             "description": "Operations related to positions",