Merge pull request #237 from PROCOLLAB-github/feature/swagger-doc-fix

swagger doc fix, convert to correct with generics functions view

Author: LolAnthony

chats/urls.py

@@ -16,26 +16,26 @@
 
 urlpatterns = [
     path("directs/", DirectChatList.as_view(), name="direct-chat-list"),
-    path("directs/<slug:pk>/", DirectChatDetail.as_view(), name="direct-chat-detail"),
+    path("directs/<slug:id>/", DirectChatDetail.as_view(), name="direct-chat-detail"),
     path(
-        "directs/<slug:pk>/messages/",
+        "directs/<slug:id>/messages/",
         DirectChatMessageList.as_view(),
         name="direct-chat-messages",
     ),
     path(
-        "directs/<slug:pk>/files/",
+        "directs/<slug:id>/files/",
         DirectChatFileList.as_view(),
         name="direct-chat-files",
     ),
     path("projects/", ProjectChatList.as_view(), name="project-chat-list"),
     path("projects/<int:pk>/", ProjectChatDetail.as_view(), name="project-chat-detail"),
     path(
-        "projects/<int:pk>/messages/",
+        "projects/<int:id>/messages/",
         ProjectChatMessageList.as_view(),
         name="project-chat-messages",
     ),
     path(
-        "projects/<int:pk>/files/",
+        "projects/<int:id>/files/",
         ProjectChatFileList.as_view(),
         name="project-chat-files",
     ),

chats/views.py

@@ -86,13 +86,13 @@ class DirectChatDetail(RetrieveAPIView):
 
     def get(self, request, *args, **kwargs) -> Response:
         try:
-            assert "_" in self.kwargs["pk"], "pk must contain underscore"
+            assert "_" in self.kwargs["id"], "processed id must contain underscore"
 
-            user1_id, user2_id = map(int, self.kwargs["pk"].split("_"))
+            user1_id, user2_id = map(int, self.kwargs["id"].split("_"))
 
             assert (
                 request.user.id == user1_id or request.user.id == user2_id
-            ), "current user id is not present in pk"
+            ), "current user id is not present in raw id"
 
             user1 = User.objects.get(pk=user1_id)
             user2 = User.objects.get(pk=user2_id)
@@ -117,7 +117,7 @@ def get(self, request, *args, **kwargs) -> Response:
         except ValueError:
             return Response(
                 status=status.HTTP_400_BAD_REQUEST,
-                data={"detail": "pk must contain two integers separated by underscore"},
+                data={"detail": "processed id must contain two integers separated by underscore"},
             )
         except AssertionError as e:
             return Response(status=status.HTTP_400_BAD_REQUEST, data={"detail": str(e)})
@@ -140,7 +140,7 @@ class DirectChatMessageList(ListCreateAPIView):
 
     def get_queryset(self):
         return (
-            self.request.user.direct_chats.get(id=self.kwargs["pk"])
+            self.request.user.direct_chats.get(id=self.kwargs["id"])
             .messages.filter(is_deleted=False)
             .order_by("-created_at")
             .all()
@@ -155,7 +155,7 @@ class ProjectChatMessageList(ListCreateAPIView):
     def get_queryset(self):
         try:
             return (
-                ProjectChat.objects.get(id=self.kwargs["pk"])
+                ProjectChat.objects.get(id=self.kwargs["id"])
                 .messages.filter(is_deleted=False)
                 .order_by("-created_at")
                 .all()
@@ -177,7 +177,8 @@ class DirectChatFileList(ListCreateAPIView):
     permission_classes = [IsAuthenticated]
 
     def get_queryset(self):
-        messages = self.request.user.direct_chats.get(id=self.kwargs["pk"]).messages.all()
+
+        messages = self.request.user.direct_chats.get(id=self.kwargs["id"]).messages.all()
 
         return get_all_files(messages)
 
@@ -188,7 +189,7 @@ class ProjectChatFileList(ListCreateAPIView):
 
     def get_queryset(self):
         try:
-            messages = ProjectChat.objects.get(id=self.kwargs["pk"]).messages.all()
+            messages = ProjectChat.objects.get(id=self.kwargs["id"]).messages.all()
             return get_all_files(messages)
         except ProjectChat.DoesNotExist:
             return UserFile.objects.none()

events/urls.py

@@ -7,6 +7,6 @@
 urlpatterns = [
     path("", EventsList.as_view()),
     path("<int:pk>/", EventDetail.as_view()),
-    path("<int:pk>/registered/", EventRegisteredUsersList.as_view()),
+    path("<int:id>/registered/", EventRegisteredUsersList.as_view()),
     path("types/", EventTypes.as_view()),
 ]

events/views.py

@@ -34,7 +34,7 @@ class EventRegisteredUsersList(generics.ListAPIView):
     permission_classes = [IsStaffOrReadOnly]
 
     def get_queryset(self):
-        users = Event.objects.get(pk=self.kwargs["pk"]).registered_users.all()
+        users = Event.objects.get(pk=self.kwargs["id"]).registered_users.all()
         return users
 
 

partner_programs/views.py

@@ -5,7 +5,7 @@
 from rest_framework.permissions import AllowAny, IsAuthenticated
 from rest_framework.response import Response
 
-from core.serializers import SetLikedSerializer
+from core.serializers import SetLikedSerializer, SetViewedSerializer
 from core.services import add_view, set_like
 from partner_programs.helpers import date_to_iso
 from partner_programs.models import PartnerProgram, PartnerProgramUserProfile
@@ -28,26 +28,21 @@ class PartnerProgramList(generics.ListCreateAPIView):
     permission_classes = [permissions.IsAuthenticatedOrReadOnly]
     pagination_class = PartnerProgramPagination
 
-    def get(self, request, *args, **kwargs):
-        programs = self.paginate_queryset(self.get_queryset())
-        context = {"user": request.user}
-        serializer = PartnerProgramListSerializer(programs, context=context, many=True)
-        return self.get_paginated_response(serializer.data)
-
 
 class PartnerProgramDetail(generics.RetrieveAPIView):
     queryset = PartnerProgram.objects.all()
     permission_classes = [permissions.IsAuthenticatedOrReadOnly]
+    serializer_class = PartnerProgramForUnregisteredUserSerializer
 
     def get(self, request, *args, **kwargs):
         try:
-            program = PartnerProgram.objects.get(pk=kwargs["pk"])
-            # fixme
+            program = self.get_object()
             is_user_member = program.users.filter(pk=request.user.pk).exists()
-            if is_user_member:
-                serializer_class = PartnerProgramForMemberSerializer
-            else:
-                serializer_class = PartnerProgramForUnregisteredUserSerializer
+            serializer_class = (
+                PartnerProgramForMemberSerializer
+                if is_user_member
+                else PartnerProgramForUnregisteredUserSerializer
+            )
             data = serializer_class(program).data
             data["is_user_member"] = is_user_member
             if request.user.is_authenticated:
@@ -65,6 +60,7 @@ class PartnerProgramCreateUserAndRegister(generics.GenericAPIView):
 
     permission_classes = [AllowAny]
     serializer_class = PartnerProgramNewUserSerializer
+    queryset = PartnerProgram.objects.none()
 
     def post(self, request, *args, **kwargs):
         data = request.data
@@ -73,7 +69,7 @@ def post(self, request, *args, **kwargs):
             return Response(status=status.HTTP_200_OK)
 
         try:
-            program = PartnerProgram.objects.get(pk=kwargs["pk"])
+            program = self.get_object()
         except PartnerProgram.DoesNotExist:
             return Response(status=status.HTTP_404_NOT_FOUND)
 
@@ -133,13 +129,13 @@ class PartnerProgramRegister(generics.GenericAPIView):
     """
     Register user to program and save additional program data
     """
-
+    queryset = PartnerProgram.objects.none()
     permission_classes = [IsAuthenticated]
     serializer_class = PartnerProgramUserSerializer
 
     def post(self, request, *args, **kwargs):
         try:
-            program = PartnerProgram.objects.get(pk=kwargs["pk"])
+            program = self.get_object()
             if program.datetime_registration_ends < timezone.now():
                 return Response(
                     data={"detail": "Registration period has ended."},
@@ -166,26 +162,27 @@ def post(self, request, *args, **kwargs):
 
 
 class PartnerProgramSetViewed(generics.GenericAPIView):
-    # fixme
-    # serializer_class = SetViewedSerializer
+    queryset = PartnerProgram.objects.none()
+    serializer_class = SetViewedSerializer
     permission_classes = [IsAuthenticated]
 
     def post(self, request, *args, **kwargs):
         try:
-            program = PartnerProgram.objects.get(pk=self.kwargs["pk"])
+            program = self.get_object()
             add_view(program, request.user)
             return Response(status=status.HTTP_200_OK)
         except PartnerProgram.DoesNotExist:
             return Response(status=status.HTTP_404_NOT_FOUND)
 
 
 class PartnerProgramSetLiked(generics.CreateAPIView):
+    queryset = PartnerProgram.objects.none()
     serializer_class = SetLikedSerializer
     permission_classes = [IsAuthenticated]
 
     def post(self, request, *args, **kwargs):
         try:
-            program = PartnerProgram.objects.get(pk=self.kwargs["pk"])
+            program = self.get_object()
             set_like(program, request.user, request.data.get("is_liked"))
             return Response(status=status.HTTP_200_OK)
         except PartnerProgram.DoesNotExist:

projects/urls.py

@@ -36,5 +36,5 @@
     path("steps/", ProjectSteps.as_view()),
     path("achievements/", AchievementList.as_view()),
     path("achievements/<int:pk>/", AchievementDetail.as_view()),
-    path("<int:pk>/responses/", ProjectVacancyResponses.as_view()),
+    path("<int:id>/responses/", ProjectVacancyResponses.as_view()),
 ]

projects/views.py

@@ -285,7 +285,7 @@ class ProjectVacancyResponses(generics.GenericAPIView):
     permission_classes = [IsAuthenticated]
 
     def get_queryset(self):
-        return VacancyResponse.objects.filter(vacancy__project_id=self.kwargs["pk"])
+        return VacancyResponse.objects.filter(vacancy__project_id=self.kwargs["id"])
 
     def get(self, request, pk):
         queryset = self.get_queryset()