Open api (#2549)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Chris Chudzicki <[email protected]>

Author: 3 people

.secrets.baseline

@@ -193,7 +193,7 @@
         "filename": "main/settings.py",
         "hashed_secret": "09edaaba587f94f60fbb5cee2234507bcb883cc2",
         "is_verified": false,
-        "line_number": 954
+        "line_number": 959
       }
     ],
     "pants": [
@@ -236,9 +236,9 @@
         "filename": "users/serializers.py",
         "hashed_secret": "ab90d9d736f9e0909b62d0922e0482e4b827449f",
         "is_verified": false,
-        "line_number": 238
+        "line_number": 243
       }
     ]
   },
-  "generated_at": "2025-01-22T20:35:24Z"
+  "generated_at": "2025-03-04T17:10:08Z"
 }

authentication/serializers.py

@@ -4,6 +4,7 @@
 
 from django.contrib.auth import get_user_model
 from django.http import HttpResponseRedirect
+from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
 from social_core.backends.email import EmailAuth
 from social_core.exceptions import AuthException, InvalidEmail
@@ -52,6 +53,7 @@ class SocialAuthSerializer(serializers.Serializer):
     redirect_url = serializers.CharField(read_only=True, default=None)
     extra_data = serializers.SerializerMethodField()
 
+    @extend_schema_field(serializers.DictField())
     def get_extra_data(self, instance):
         """Serialize extra_data"""
         if instance.user is not None:

authentication/views.py

@@ -7,8 +7,10 @@
 from django.contrib.auth import get_user_model
 from django.contrib.auth.views import LogoutView
 from django.shortcuts import render, reverse
+from drf_spectacular.utils import extend_schema
 from rest_framework import status
 from rest_framework.decorators import api_view, permission_classes, renderer_classes
+from rest_framework.generics import GenericAPIView
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
@@ -81,6 +83,10 @@ def get_serializer_cls(self):
         return LoginPasswordSerializer
 
 
+@extend_schema(
+    request=RegisterEmailSerializer,
+    responses={200: RegisterEmailSerializer},
+)
 class RegisterEmailView(SocialAuthAPIView):
     """Email register view"""
 
@@ -105,14 +111,42 @@ def post(self, request):
         return super().post(request)
 
 
-class RegisterConfirmView(SocialAuthAPIView):
+class RegisterConfirmView(SocialAuthAPIView, GenericAPIView):
     """Email registration confirmation view"""
 
+    serializer_class = RegisterConfirmSerializer
+    permission_classes = []
+    authentication_classes = []
+
     def get_serializer_cls(self):
-        """Return the serializer cls"""
+        """Return the serializer class"""
         return RegisterConfirmSerializer
 
+    def post(self, request):
+        """
+        Handle POST requests to confirm email registration
+        """
+        if bool(request.session.get("hijack_history")):
+            return Response(status=status.HTTP_403_FORBIDDEN)
+
+        serializer_cls = self.get_serializer_cls()
+        strategy = load_drf_strategy(request)
+        backend = load_backend(strategy, EmailAuth.name, None)
+        serializer = serializer_cls(
+            data=request.data,
+            context={"request": request, "strategy": strategy, "backend": backend},
+        )
+
+        if serializer.is_valid():
+            serializer.save()
+            return Response(serializer.data)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
 
+@extend_schema(
+    request=RegisterDetailsSerializer,
+    responses={200: RegisterDetailsSerializer},
+)
 class RegisterDetailsView(SocialAuthAPIView):
     """Email registration details view"""
 
@@ -135,6 +169,10 @@ def post(self, request):
         return resp
 
 
+@extend_schema(
+    request=RegisterExtraDetailsSerializer,
+    responses={200: RegisterExtraDetailsSerializer},
+)
 class RegisterExtraDetailsView(SocialAuthAPIView):
     """Email registration extra details view"""
 

cms/serializers.py

@@ -1,7 +1,10 @@
 """CMS app serializers"""
 
+from __future__ import annotations
+
 import bleach
 from django.templatetags.static import static
+from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
 
 from cms import models
@@ -19,6 +22,7 @@ class BaseCoursePageSerializer(serializers.ModelSerializer):
     effort = serializers.SerializerMethodField()
     length = serializers.SerializerMethodField()
 
+    @extend_schema_field(str)
     def get_feature_image_src(self, instance):
         """Serializes the source of the feature_image"""
         feature_img_src = None
@@ -27,19 +31,22 @@ def get_feature_image_src(self, instance):
 
         return feature_img_src or static(DEFAULT_COURSE_IMG_PATH)
 
+    @extend_schema_field(serializers.URLField)
     def get_page_url(self, instance):
         return instance.get_url()
 
+    @extend_schema_field(str)
     def get_description(self, instance):
         return bleach.clean(instance.description, tags=[], strip=True)
 
-    def get_effort(self, instance):
+    def get_effort(self, instance) -> str | None:
         return (
             bleach.clean(instance.effort, tags=[], strip=True)
             if instance.effort
             else None
         )
 
+    @extend_schema_field(str)
     def get_length(self, instance):
         return (
             bleach.clean(instance.length, tags=[], strip=True)
@@ -66,6 +73,7 @@ class CoursePageSerializer(BaseCoursePageSerializer):
     instructors = serializers.SerializerMethodField()
     current_price = serializers.SerializerMethodField()
 
+    @extend_schema_field(serializers.URLField)
     def get_financial_assistance_form_url(self, instance):
         """
         Returns URL of the Financial Assistance Form.
@@ -116,14 +124,16 @@ def get_financial_assistance_form_url(self, instance):
             else ""
         )
 
-    def get_current_price(self, instance):
+    @extend_schema_field(int)
+    def get_current_price(self, instance) -> int | None:
         relevant_product = (
             instance.product.active_products.filter().order_by("-price").first()
             if instance.product.active_products
             else None
         )
         return relevant_product.price if relevant_product else None
 
+    @extend_schema_field(list)
     def get_instructors(self, instance):
         members = [
             member.linked_instructor_page
@@ -160,6 +170,7 @@ class ProgramPageSerializer(serializers.ModelSerializer):
     price = serializers.SerializerMethodField()
     financial_assistance_form_url = serializers.SerializerMethodField()
 
+    @extend_schema_field(str)
     def get_feature_image_src(self, instance):
         """Serializes the source of the feature_image"""
         feature_img_src = None
@@ -168,12 +179,15 @@ def get_feature_image_src(self, instance):
 
         return feature_img_src or static(DEFAULT_COURSE_IMG_PATH)
 
+    @extend_schema_field(serializers.URLField)
     def get_page_url(self, instance):
         return instance.get_url()
 
+    @extend_schema_field(str)
     def get_price(self, instance):
         return instance.price[0].value["text"] if len(instance.price) > 0 else None
 
+    @extend_schema_field(serializers.URLField)
     def get_financial_assistance_form_url(self, instance):
         """
         Returns URL of the Financial Assistance Form.
@@ -235,6 +249,7 @@ class InstructorPageSerializer(serializers.ModelSerializer):
 
     feature_image_src = serializers.SerializerMethodField()
 
+    @extend_schema_field(str)
     def get_feature_image_src(self, instance):
         """Serializes the source of the feature_image"""
         feature_img_src = None

courses/models.py

@@ -386,7 +386,7 @@ def courses(self):
         return heap
 
     @cached_property
-    def required_courses(self):
+    def required_courses(self) -> list:
         """
         Returns just the courses under the "Required Courses" node.
         """
@@ -407,7 +407,7 @@ def required_title(self):
         )
 
     @cached_property
-    def elective_courses(self):
+    def elective_courses(self) -> list:
         """
         Returns just the courses under the "Required Courses" node.
         """
@@ -917,7 +917,7 @@ def get_courseware_object_readable_id(self):
         return self.course_run.courseware_id
 
     @property
-    def link(self):
+    def link(self) -> str:
         """
         Get the link at which this certificate will be served
         Format: /certificate/<uuid>/
@@ -1003,7 +1003,7 @@ def get_courseware_object_readable_id(self):
         return self.program.readable_id
 
     @property
-    def link(self):
+    def link(self) -> str:
         """
         Get the link at which this certificate will be served
         Format: /certificate/program/<uuid>/
@@ -1309,7 +1309,7 @@ def to_dict(self):
         return serialize_model_object(self)
 
     @property
-    def grade_percent(self):
+    def grade_percent(self) -> Decimal:
         """Returns the grade field value as a number out of 100 (or None if the value is None)"""
         return (
             Decimal(self.grade * 100).quantize(exp=Decimal(1), rounding=ROUND_HALF_EVEN)

courses/serializers/v1/base.py

@@ -1,3 +1,8 @@
+from __future__ import annotations
+
+from typing import Optional
+
+from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
 
 from cms.serializers import CoursePageSerializer
@@ -37,10 +42,31 @@ class BaseCourseRunSerializer(serializers.ModelSerializer):
     """Minimal CourseRun model serializer"""
 
     is_archived = serializers.SerializerMethodField()
+    is_upgradable = serializers.SerializerMethodField()
+    is_enrollable = serializers.SerializerMethodField()
+    course_number = serializers.SerializerMethodField()
+    courseware_url = serializers.SerializerMethodField()
+
+    def get_courseware_url(self, instance) -> Optional[str]:
+        """Get the courseware URL"""
+        return instance.courseware_url
 
-    def get_is_archived(self, instance):
+    def get_is_upgradable(self, instance) -> bool:
+        """Check if the course run is upgradable"""
+        return instance.is_upgradable
+
+    def get_is_enrollable(self, instance) -> bool:
+        """Check if the course run is enrollable"""
+        return instance.is_enrollable
+
+    def get_is_archived(self, instance) -> bool:
+        """Check if the course run is archived"""
         return instance.is_enrollable and instance.is_past
 
+    def get_course_number(self, instance) -> str:
+        """Get the course number"""
+        return instance.course_number
+
     class Meta:
         model = models.CourseRun
         fields = [
@@ -79,6 +105,14 @@ class Meta:
         fields = ["title", "readable_id", "id", "type"]
 
 
+class CourseRunCertificateSerializer(serializers.ModelSerializer):
+    """CourseRunCertificate model serializer"""
+
+    class Meta:
+        model = models.CourseRunCertificate
+        fields = ["uuid", "link"]
+
+
 class BaseCourseRunEnrollmentSerializer(serializers.ModelSerializer):
     certificate = serializers.SerializerMethodField(read_only=True)
     enrollment_mode = serializers.ChoiceField(
@@ -87,6 +121,7 @@ class BaseCourseRunEnrollmentSerializer(serializers.ModelSerializer):
     approved_flexible_price_exists = serializers.SerializerMethodField()
     grades = serializers.SerializerMethodField(read_only=True)
 
+    @extend_schema_field(CourseRunCertificateSerializer(allow_null=True))
     def get_certificate(self, enrollment):
         """
         Resolve a certificate for this enrollment if it exists
@@ -119,6 +154,7 @@ def get_certificate(self, enrollment):
         except models.CourseRunCertificate.DoesNotExist:
             return None
 
+    @extend_schema_field(bool)
     def get_approved_flexible_price_exists(self, instance):
         instance_run = instance[0].run if isinstance(instance, list) else instance.run
         instance_user = (
@@ -129,6 +165,7 @@ def get_approved_flexible_price_exists(self, instance):
         )
         return flexible_price_exists  # noqa: RET504
 
+    @extend_schema_field(list[dict])
     def get_grades(self, instance):
         instance_run = instance[0].run if isinstance(instance, list) else instance.run
         instance_user = (
@@ -155,6 +192,7 @@ class Meta:
         ]
 
 
+@extend_schema_field(ProductFlexibilePriceSerializer)
 class ProductRelatedField(serializers.RelatedField):
     """serializer for the Product generic field"""
 
@@ -165,14 +203,6 @@ def to_representation(self, instance):
         return serializer.data
 
 
-class CourseRunCertificateSerializer(serializers.ModelSerializer):
-    """CourseRunCertificate model serializer"""
-
-    class Meta:
-        model = models.CourseRunCertificate
-        fields = ["uuid", "link"]
-
-
 class CourseRunGradeSerializer(serializers.ModelSerializer):
     """CourseRunGrade serializer"""