fix program enrollments v2 api types (#3094)

gumaerc · web-flow · commit 55f002cbdf16 · 2025-11-19T11:25:38.000-05:00
diff --git a/courses/serializers/v1/programs.py b/courses/serializers/v1/programs.py
@@ -220,6 +220,7 @@ class Meta(ProgramSerializer.Meta):
         ]
 
 
+@extend_schema_serializer(component_name="V1ProgramCertificate")
 class ProgramCertificateSerializer(serializers.ModelSerializer):
     """ProgramCertificate model serializer"""
 
diff --git a/courses/serializers/v2/programs.py b/courses/serializers/v2/programs.py
@@ -6,13 +6,19 @@
 from rest_framework import serializers
 
 from cms.serializers import ProgramPageSerializer
-from courses.models import Program, ProgramCollection, ProgramRequirementNodeType
+from courses.models import (
+    Program,
+    ProgramCertificate,
+    ProgramCollection,
+    ProgramRequirementNodeType,
+)
 from courses.serializers.base import (
     BaseProgramRequirementTreeSerializer,
     get_thumbnail_url,
 )
 from courses.serializers.utils import get_unique_topics_from_courses
 from courses.serializers.v1.departments import DepartmentSerializer
+from courses.serializers.v2.courses import CourseRunEnrollmentSerializer
 from main.serializers import StrictFieldsSerializer
 
 logger = logging.getLogger(__name__)
@@ -542,6 +548,14 @@ class Meta:
         ]
 
 
+class ProgramCertificateSerializer(serializers.ModelSerializer):
+    """ProgramCertificate model serializer"""
+
+    class Meta:
+        model = ProgramCertificate
+        fields = ["uuid", "link"]
+
+
 @extend_schema_serializer(component_name="V2UserProgramEnrollmentDetail")
 class UserProgramEnrollmentDetailSerializer(serializers.Serializer):
     """
@@ -552,23 +566,13 @@ class UserProgramEnrollmentDetailSerializer(serializers.Serializer):
     """
 
     program = ProgramSerializer()
-    enrollments = serializers.SerializerMethodField()
+    enrollments = CourseRunEnrollmentSerializer(many=True)
     certificate = serializers.SerializerMethodField(read_only=True)
 
-    @extend_schema_field(serializers.ListField(child=serializers.DictField()))
-    def get_enrollments(self, instance):
-        """Get course run enrollments using v2 serializer."""
-        from courses.serializers.v2.courses import CourseRunEnrollmentSerializer
-
-        enrollments = instance.get("enrollments", [])
-        return CourseRunEnrollmentSerializer(enrollments, many=True).data
-
-    @extend_schema_field(serializers.DictField(allow_null=True))
+    @extend_schema_field(ProgramCertificateSerializer(allow_null=True))
     def get_certificate(self, instance):
         """
         Resolve a certificate for this enrollment if it exists.
         """
-        from courses.serializers.v2.certificates import ProgramCertificateSerializer
-
         certificate = instance.get("certificate")
         return ProgramCertificateSerializer(certificate).data if certificate else None
diff --git a/openapi/specs/v0.yaml b/openapi/specs/v0.yaml
@@ -3839,7 +3839,7 @@ components:
             $ref: '#/components/schemas/CourseRunEnrollment'
         certificate:
           allOf:
-          - $ref: '#/components/schemas/ProgramCertificate'
+          - $ref: '#/components/schemas/V1ProgramCertificate'
           nullable: true
           readOnly: true
       required:
@@ -4248,6 +4248,24 @@ components:
       - req_tree
       - requirements
       - title
+    V1ProgramCertificate:
+      type: object
+      description: ProgramCertificate model serializer
+      properties:
+        uuid:
+          type: string
+          format: uuid
+          readOnly: true
+        link:
+          type: string
+          description: |-
+            Get the link at which this certificate will be served
+            Format: /certificate/program/<uuid>/
+            Example: /certificate/program/93ebd74e-5f88-4b47-bb09-30a6d575328f/
+          readOnly: true
+      required:
+      - link
+      - uuid
     V1ProgramRequirement:
       type: object
       description: Serializer for a ProgramRequirement
@@ -5008,12 +5026,10 @@ components:
         enrollments:
           type: array
           items:
-            type: object
-            additionalProperties: {}
-          readOnly: true
+            $ref: '#/components/schemas/CourseRunEnrollmentRequestV2'
         certificate:
-          type: object
-          additionalProperties: {}
+          allOf:
+          - $ref: '#/components/schemas/ProgramCertificate'
           nullable: true
           readOnly: true
       required:
diff --git a/openapi/specs/v1.yaml b/openapi/specs/v1.yaml
@@ -3839,7 +3839,7 @@ components:
             $ref: '#/components/schemas/CourseRunEnrollment'
         certificate:
           allOf:
-          - $ref: '#/components/schemas/ProgramCertificate'
+          - $ref: '#/components/schemas/V1ProgramCertificate'
           nullable: true
           readOnly: true
       required:
@@ -4248,6 +4248,24 @@ components:
       - req_tree
       - requirements
       - title
+    V1ProgramCertificate:
+      type: object
+      description: ProgramCertificate model serializer
+      properties:
+        uuid:
+          type: string
+          format: uuid
+          readOnly: true
+        link:
+          type: string
+          description: |-
+            Get the link at which this certificate will be served
+            Format: /certificate/program/<uuid>/
+            Example: /certificate/program/93ebd74e-5f88-4b47-bb09-30a6d575328f/
+          readOnly: true
+      required:
+      - link
+      - uuid
     V1ProgramRequirement:
       type: object
       description: Serializer for a ProgramRequirement
@@ -5008,12 +5026,10 @@ components:
         enrollments:
           type: array
           items:
-            type: object
-            additionalProperties: {}
-          readOnly: true
+            $ref: '#/components/schemas/CourseRunEnrollmentRequestV2'
         certificate:
-          type: object
-          additionalProperties: {}
+          allOf:
+          - $ref: '#/components/schemas/ProgramCertificate'
           nullable: true
           readOnly: true
       required:
diff --git a/openapi/specs/v2.yaml b/openapi/specs/v2.yaml
@@ -3839,7 +3839,7 @@ components:
             $ref: '#/components/schemas/CourseRunEnrollment'
         certificate:
           allOf:
-          - $ref: '#/components/schemas/ProgramCertificate'
+          - $ref: '#/components/schemas/V1ProgramCertificate'
           nullable: true
           readOnly: true
       required:
@@ -4248,6 +4248,24 @@ components:
       - req_tree
       - requirements
       - title
+    V1ProgramCertificate:
+      type: object
+      description: ProgramCertificate model serializer
+      properties:
+        uuid:
+          type: string
+          format: uuid
+          readOnly: true
+        link:
+          type: string
+          description: |-
+            Get the link at which this certificate will be served
+            Format: /certificate/program/<uuid>/
+            Example: /certificate/program/93ebd74e-5f88-4b47-bb09-30a6d575328f/
+          readOnly: true
+      required:
+      - link
+      - uuid
     V1ProgramRequirement:
       type: object
       description: Serializer for a ProgramRequirement
@@ -5008,12 +5026,10 @@ components:
         enrollments:
           type: array
           items:
-            type: object
-            additionalProperties: {}
-          readOnly: true
+            $ref: '#/components/schemas/CourseRunEnrollmentRequestV2'
         certificate:
-          type: object
-          additionalProperties: {}
+          allOf:
+          - $ref: '#/components/schemas/ProgramCertificate'
           nullable: true
           readOnly: true
       required:

Original file line number	Diff line number	Diff line change
`@@ -220,6 +220,7 @@ class Meta(ProgramSerializer.Meta):`
`220`	`220`	`]`
`221`	`221`
`222`	`222`
	`223`	`+@extend_schema_serializer(component_name="V1ProgramCertificate")`
`223`	`224`	`class ProgramCertificateSerializer(serializers.ModelSerializer):`
`224`	`225`	`"""ProgramCertificate model serializer"""`
`225`	`226`