remove id requirement from program enrollment listing view (#2862)

Author: gumaerc

courses/views/v1/__init__.py

@@ -475,21 +475,21 @@ def partial_update(self, request, *args, **kwargs):  # noqa: ARG002
             raise NotImplementedError
 
 
-@extend_schema(
-    responses={200: UserProgramEnrollmentDetailSerializer},
-    parameters=[
-        OpenApiParameter(
-            name="id",
-            type=OpenApiTypes.INT,
-            location=OpenApiParameter.PATH,
-            description="Program enrollment ID",
-            required=True,
-        )
-    ],
-)
 class UserProgramEnrollmentsViewSet(viewsets.ViewSet):
     permission_classes = [IsAuthenticated]
 
+    id_parameter = OpenApiParameter(
+        name="id",
+        type=OpenApiTypes.INT,
+        location=OpenApiParameter.PATH,
+        description="Program enrollment ID",
+        required=True,
+    )
+
+    @extend_schema(
+        responses={200: UserProgramEnrollmentDetailSerializer},
+        parameters=[],
+    )
     def list(self, request):
         """
         Returns a unified set of program and course enrollments for the current
@@ -528,6 +528,25 @@ def list(self, request):
             UserProgramEnrollmentDetailSerializer(program_list, many=True).data
         )
 
+    @extend_schema(
+        responses={200: UserProgramEnrollmentDetailSerializer},
+        parameters=[id_parameter],
+    )
+    def retrieve(self, request, pk=None):
+        """
+        Retrieve a specific program enrollment.
+        """
+        program = Program.objects.get(pk=pk)
+        enrollment = ProgramEnrollment.objects.get(user=request.user, program=program)
+        serializer = UserProgramEnrollmentDetailSerializer(
+            enrollment, context={"request": request}
+        )
+        return Response(serializer.data)
+
+    @extend_schema(
+        responses={200: UserProgramEnrollmentDetailSerializer},
+        parameters=[id_parameter],
+    )
     def destroy(self, request, pk=None):
         """
         Unenroll the user from this program. This is simpler than the corresponding

openapi/specs/v0.yaml

@@ -702,6 +702,21 @@ paths:
       description: |-
         Returns a unified set of program and course enrollments for the current
         user.
+      tags:
+      - program_enrollments
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserProgramEnrollmentDetail'
+          description: ''
+  /api/v1/program_enrollments/{id}/:
+    get:
+      operationId: program_enrollments_retrieve
+      description: Retrieve a specific program enrollment.
       parameters:
       - in: path
         name: id
@@ -716,11 +731,8 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/UserProgramEnrollmentDetail'
+                $ref: '#/components/schemas/UserProgramEnrollmentDetail'
           description: ''
-  /api/v1/program_enrollments/{id}/:
     delete:
       operationId: program_enrollments_destroy
       description: |-

openapi/specs/v1.yaml

@@ -702,6 +702,21 @@ paths:
       description: |-
         Returns a unified set of program and course enrollments for the current
         user.
+      tags:
+      - program_enrollments
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserProgramEnrollmentDetail'
+          description: ''
+  /api/v1/program_enrollments/{id}/:
+    get:
+      operationId: program_enrollments_retrieve
+      description: Retrieve a specific program enrollment.
       parameters:
       - in: path
         name: id
@@ -716,11 +731,8 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/UserProgramEnrollmentDetail'
+                $ref: '#/components/schemas/UserProgramEnrollmentDetail'
           description: ''
-  /api/v1/program_enrollments/{id}/:
     delete:
       operationId: program_enrollments_destroy
       description: |-

openapi/specs/v2.yaml

@@ -702,6 +702,21 @@ paths:
       description: |-
         Returns a unified set of program and course enrollments for the current
         user.
+      tags:
+      - program_enrollments
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserProgramEnrollmentDetail'
+          description: ''
+  /api/v1/program_enrollments/{id}/:
+    get:
+      operationId: program_enrollments_retrieve
+      description: Retrieve a specific program enrollment.
       parameters:
       - in: path
         name: id
@@ -716,11 +731,8 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/UserProgramEnrollmentDetail'
+                $ref: '#/components/schemas/UserProgramEnrollmentDetail'
           description: ''
-  /api/v1/program_enrollments/{id}/:
     delete:
       operationId: program_enrollments_destroy
       description: |-