Add parameter to profile Swagger docs

Author: AllenAnthes

src/core/views.py

@@ -6,6 +6,8 @@
 from django.contrib.auth.models import User
 from django.utils.decorators import method_decorator
 from django.views.decorators.debug import sensitive_post_parameters
+from drf_yasg.openapi import IN_QUERY, TYPE_STRING, Parameter
+from drf_yasg.utils import swagger_auto_schema
 from rest_auth.registration.views import RegisterView as BaseRegisterView
 from rest_auth.registration.views import SocialConnectView, SocialLoginView
 from rest_framework.generics import RetrieveUpdateAPIView
@@ -23,6 +25,14 @@
     sensitive_post_parameters("password"), name="dispatch"
 )
 
+email_param = Parameter(
+    "email",
+    IN_QUERY,
+    "Email belonging to the Profile's User instance",
+    required=True,
+    type=TYPE_STRING,
+)
+
 
 class UpdateProfile(RetrieveUpdateAPIView):
     """
@@ -45,6 +55,10 @@ def get_object(self):
 
 
 class AdminUpdateProfile(RetrieveUpdateAPIView):
+    """
+    Read or update user profiles
+    """
+
     serializer_class = ProfileSerializer
     queryset = Profile.objects.all()
     permission_classes = (HasGroupPermission,)
@@ -63,6 +77,18 @@ def get_object(self):
 
         return None
 
+    @swagger_auto_schema(manual_parameters=[email_param])
+    def get(self, request, *args, **kwargs):
+        return super().get(request, *args, **kwargs)
+
+    @swagger_auto_schema(manual_parameters=[email_param])
+    def patch(self, request, *args, **kwargs):
+        return super().get(request, *args, **kwargs)
+
+    @swagger_auto_schema(manual_parameters=[email_param])
+    def put(self, request, *args, **kwargs):
+        return super().get(request, *args, **kwargs)
+
 
 class UserView(RetrieveUpdateAPIView):
     queryset = User.objects.all()