Merge pull request #138 from tallzeebaa/hotfix-master/SA-15357

Fixed mistakes related to Assessments [SA-15357] (master)

Author: armatronic

openapi/components/schemas/assessment-item.yaml

@@ -33,12 +33,13 @@ properties:
         description: Class Codes associated with the folder.
         oneOf:
           - type: string
+            nullable: true
           - type: array
             items:
               type: string
       yearLevel:
         description: |
-          A year level which the folder is associated with.
+          Year levels which the folder is associated with.
         type: array
         nullable: true
         items:
@@ -49,6 +50,11 @@ properties:
             name:
               type: string
               description: The name of the year level.
+  subjectCode:
+    type: string
+    nullable: true
+    description: |
+      The Course Subject Code
   commonAssessment:
     type: boolean
     nullable: true
@@ -80,14 +86,16 @@ properties:
       Not applicable to assessmentTypes 'lessonPlan' and 'task' (so value will be null in those cases).
   dueDate:
     type: string
+    nullable: true
     format: date-time
     description: |
-      The due date of the assessment as a RFC3339 string.
+      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
   project:
     type: object
+    nullable: true
     properties:
       id:
         type: integer

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

@@ -5,7 +5,7 @@ type: object
 properties:
   learner:
     allOf:
-      - $ref: ./userAuthor.yaml
+      - $ref: ./assessment-user.yaml
       - description: |
           The user who is participating in the assessment: usually a student.
   response:
@@ -28,7 +28,7 @@ properties:
           $ref: ./file.yaml
       submitter:
         allOf:
-          - $ref: ./userAuthor.yaml
+          - $ref: ./assessment-user.yaml
           - description: |
               The user who submitted the due response.
               
@@ -58,14 +58,15 @@ properties:
         example: A
         description: A human readable mark.
       normalisedMark:
-        type: integer
+        type: number
+        format: float
         example: 36
         description: The mark in numeric form.
       rubric:
         $ref: ./assessment-rubric-feedback.yaml
       instructor:
         allOf:
-          - $ref: ./userAuthor.yaml
+          - $ref: ./assessment-user.yaml
           - description: |
               The user who gave the feedback to the learner: usually a teacher.
   comment:
@@ -101,7 +102,7 @@ properties:
           An Assessment Rubric item. (Deprecated: moved to the `feedback` object.)
   instructor:
     allOf:
-      - $ref: ./userAuthor.yaml
+      - $ref: ./assessment-user.yaml
       - deprecated: true
         description: |
           The user who gave the feedback to the learner: usually a teacher.

openapi/components/schemas/assessment-user.yaml

@@ -0,0 +1,38 @@
+title: User
+type: object
+properties:
+
+  id:
+    $ref: ./id.yaml
+
+  title:
+    type: string
+    nullable: true
+    description: The user's title (Mr., Ms., etc.).
+    example: Ms
+
+  firstName:
+    type: string
+    nullable: false
+    description: |
+      The user's first name.
+
+      Schoolbox doesn't distinguish between a person's actual first name
+      and any other names, and in any case is not the definitive source of
+      naming information; therefore in practice this will usually be the
+      user's given name.
+    example: Rebecca
+
+  preferredName:
+    type: string
+    nullable: true
+    description: The user's preferred name.
+  
+  lastName:
+    type: string
+    nullable: true
+    description: The user's surname.
+    example: White
+
+  externalId:
+    $ref: ./externalId.yaml

openapi/components/schemas/dueWorkFeedbackItem.yaml

@@ -10,7 +10,8 @@ properties:
     description: The mark in its original form.  For example this could be a letter grade or a percentage or a rubric.
     example: 'A'
   normalisedMark:
-    type: integer
+    type: number
+    format: float
     example: 85
     description: The mark in numeric form
   comment: