Merge pull request #453 from openedx/zafzal/ENT-8716-b

fix: Change Assignment_UUIDs data type in public API
openedx · Apr 30, 2024 · 31185ee · 31185ee
2 parents 841b6f2 + 6f6c270
commit 31185ee
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 6 deletions.
diff --git a/api-compact.yaml b/api-compact.yaml
@@ -56,6 +56,17 @@ auth_header: &auth_header
   required: true
   type: "string"
 
+definitions:
+  LearnerContentAssignmentActionRequest:
+    type: "object"
+    properties:
+      assignment_uuids:
+        type: "array"
+        description: "List of assignment uuids"
+        items:
+          type: "string"
+          description: "assignment uuid"
+
 endpoints:
   v1:
     # api/v1/assignment-configurations/{assignment_configuration_uuid}/admin/assignments/cancel/
@@ -70,14 +81,14 @@ endpoints:
         parameters:
           - *auth_header
           - *assignment_configuration_uuid
-          - name: "assignment_uuids"
+          - name: "LearnerContentAssignmentActionRequest"
             in: "body"
-            description: "Single or multiple assignment_uuids in the array."
+            description: "Single or multiple assignment_uuids in the array"
             required: true
             schema:
               type: "array"
               items:
-                type: "string"
+                $ref: "#/definitions/LearnerContentAssignmentActionRequest"
         responses: *learner_content_assignment_cancel_responses
         x-amazon-apigateway-integration:
           responses: *apigateway_responses

diff --git a/api.yaml b/api.yaml
@@ -43,6 +43,16 @@ auth_header:
   in: header
   required: true
   type: string
+definitions:
+  LearnerContentAssignmentActionRequest:
+    type: object
+    properties:
+      assignment_uuids:
+        type: array
+        description: List of assignment uuids
+        items:
+          type: string
+          description: assignment uuid
 endpoints:
   v1:
     learnerContentAssignmentCancelRequest:
@@ -62,14 +72,14 @@ endpoints:
             in: path
             required: true
             type: string
-          - name: assignment_uuids
+          - name: LearnerContentAssignmentActionRequest
             in: body
-            description: Single or multiple assignment_uuids in the array.
+            description: Single or multiple assignment_uuids in the array
             required: true
             schema:
               type: array
               items:
-                type: string
+                $ref: "#/definitions/LearnerContentAssignmentActionRequest"
         responses:
           "200":
             description: OK