Merge pull request #221 from jleckie/task-develop/SA-22780

Document rubrics array on Assessment API, deprecate rubric [SA-22780]

Author: stevechan

openapi/components/schemas/assessment-item.yaml

@@ -94,7 +94,15 @@ properties:
       The due date of the assessment as a RFC3339 string. This can be null for assessments in a course.
     example: 2022-01-30T21:00:00.000Z
   rubric:
-    $ref: ./assessment-rubric.yaml
+    allOf:
+      - $ref: ./assessment-rubric.yaml
+      - deprecated: true
+        description: |
+          A single Assessment Rubric item.
+          (Deprecated: use `rubrics`. This carries only the first rubric and will be removed
+          after a 6-month migration window.)
+  rubrics:
+    $ref: ./assessment-rubrics.yaml
   project:
     type: object
     nullable: true

openapi/components/schemas/assessment-participation-item.yaml

@@ -63,7 +63,15 @@ properties:
         example: 36
         description: The mark in numeric form.
       rubric:
-        $ref: ./assessment-rubric-feedback.yaml
+        allOf:
+          - $ref: ./assessment-rubric-feedback.yaml
+          - deprecated: true
+            description: |
+              A single marked Assessment Rubric item.
+              (Deprecated: use `rubrics`. This carries only the first rubric and will be removed
+              after a 6-month migration window.)
+      rubrics:
+        $ref: ./assessment-rubrics-feedback.yaml
       instructor:
         allOf:
           - $ref: ./assessment-user.yaml

openapi/components/schemas/assessment-rubrics-feedback.yaml

@@ -0,0 +1,18 @@
+title: A set of marked Assessment Rubrics
+description: The marked rubrics for a feedback item. Empty when the feedback has no rubric marks.
+readOnly: true
+type: array
+items:
+  type: object
+  properties:
+    id:
+      type: integer
+      example: 1
+      description: The rubric instance ID.
+    title:
+      type: string
+      nullable: true
+      example: Written
+      description: The title of this rubric.
+    capabilities:
+      $ref: ./assessment-rubric-feedback.yaml#/properties/capabilities

openapi/components/schemas/assessment-rubrics.yaml

@@ -0,0 +1,23 @@
+title: A set of Assessment Rubrics
+description: The rubrics attached to an assessment. Empty when the assessment has no rubrics.
+readOnly: true
+type: array
+items:
+  type: object
+  properties:
+    id:
+      type: integer
+      example: 1
+      description: The rubric instance ID.
+    title:
+      type: string
+      nullable: true
+      example: Written
+      description: The title of this rubric.
+    weight:
+      type: number
+      nullable: true
+      example: 60
+      description: How much this rubric contributes to the assessment's overall mark.
+    capabilities:
+      $ref: ./assessment-rubric.yaml#/properties/capabilities