[API] Adicionado arquivo da api do competifier

Api/Competifier.openapi.yaml

@@ -5,9 +5,11 @@ info:
   version: 0.1.0
 tags:
   - name: competifier
-    description: Competifier operations
+    description: Operations involving the competifier
   - name: assessments
-    description: Operations involving assessments
+    description: Operations involving the assessments
+  - name: phases
+    description: Operations involving the phases
 paths:
   /competifier/messages:
     get:
@@ -98,6 +100,25 @@ paths:
         schema:
           format: int32
           type: integer
+  '/assessments/{assessmentId}/evaluation':
+    get:
+      tags:
+        - assessments
+      summary: Retrives an Assessment evaluation
+      responses:
+        '200':
+          description: Successfully retrieved assessment evaluation
+          content:
+            application/json:
+              schema:
+                type: object
+    parameters:
+      - name: assessmentId
+        in: path
+        required: true
+        schema:
+          format: int32
+          type: integer
   '/assessments/{assessmentId}/submissions':
     get:
       tags:
@@ -223,9 +244,9 @@ paths:
               schema:
                 type: array
                 items:
-                  oneOf:
-                  - $ref: '#/components/schemas/SubjectiveQuestion'
+                  anyOf:
                   - $ref: '#/components/schemas/ObjectiveQuestion'
+                  - $ref: '#/components/schemas/SubjectiveQuestion'
     parameters:
       - name: assessmentId
         in: path
@@ -244,7 +265,7 @@ paths:
           content:
             application/json:
               schema:
-                oneOf:
+                anyOf:
                 - $ref: '#/components/schemas/SubjectiveQuestion'
                 - $ref: '#/components/schemas/ObjectiveQuestion'
     parameters:
@@ -260,6 +281,58 @@ paths:
         schema:
           format: int32
           type: integer
+  '/assessments/{assessmentId}/questions/{questionId}/statement':
+    get:
+      tags:
+        - assessments
+      summary: Retrieves statement from a question
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/QuestionStatement'
+    parameters:
+      - name: assessmentId
+        in: path
+        required: true
+        schema:
+          format: int32
+          type: integer
+      - name: questionId
+        in: path
+        required: true
+        schema:
+          format: int32
+          type: integer
+  '/assessments/{assessmentId}/questions/{questionId}/alternatives':
+    get:
+      tags:
+        - assessments
+      summary: Retrieves alternatives from an objective question
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                   $ref: '#/components/schemas/Alternative'
+    parameters:
+      - name: assessmentId
+        in: path
+        required: true
+        schema:
+          format: int32
+          type: integer
+      - name: questionId
+        in: path
+        required: true
+        schema:
+          format: int32
+          type: integer
   '/assessments/{assessmentId}/drafts':
     get:
       tags:
@@ -415,10 +488,25 @@ paths:
         required: true
         schema:
           type: integer
+  '/phases':
+    get:
+      tags:
+          - phases
+      summary: Retrives all phases
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: object
 components:
   schemas:
     ScheduledEvent:
-      type: object
+      required:
+        - oid
+        - startsAt
+        - endsAt
       properties:
         oid:
           description: The object identification
@@ -432,7 +520,6 @@ components:
           description: The time of the ending of the assessment
           type: string
     Assessment:
-      type: object
       required:
         - status
         - type
@@ -440,7 +527,6 @@ components:
         - resultAvailable
         - answerKeyAvailable
         - locationType
-        - exam
         - schedule
       properties:
         status:
@@ -554,8 +640,6 @@ components:
           0: '#/components/schemas/SubjectiveQuestion'
           1: '#/components/schemas/ObjectiveQuestion'
     SubjectiveQuestion:
-      required:
-        - answerKey
       allOf:
       - $ref: '#/components/schemas/Question'
       - type: object
@@ -564,8 +648,6 @@ components:
             format: string
             type: string
     ObjectiveQuestion:
-      required:
-        - answerKey
       allOf:
       - $ref: '#/components/schemas/Question'
       - type: object
@@ -575,48 +657,58 @@ components:
             items:
               $ref: '#/components/schemas/Alternative'
           answerKey:
-            format: int32
             type: integer
+    ExamCover:
+      required:
+        - content
+        - oid
+      properties:
+        content:
+          type: string
+        oid:
+          type: integer
     Exam:
+      required:
+        - type
+        - title
+        - groups
+        - questions
+        - oid
       properties:
         type:
           description: '{SUBJECTIVE, OBJECTIVE}'
           type: integer
-        label:
-          description: A name to the exam
+        title:
           type: string
         cover:
-          description: An html to be embedded as cover
-          type: string
+          $ref: '#/components/schemas/ExamCover'
         groups:
-          description: The possible QuestionGroup of this Exam
           type: array
           items:
             $ref: '#/components/schemas/QuestionGroup'
         questions:
-          description: All the ExamQuestions of this Exam
           type: array
           items:
-            $ref: '#/components/schemas/Question'
+            oneOf:
+              - $ref: '#/components/schemas/SubjectiveQuestion'
+              - $ref: '#/components/schemas/ObjectiveQuestion'
         oid:
           description: Object identifier
           type: integer
     Alternative:
-      title: Alternative
-      description: Alternative for a *ObjectiveQuestion*
-      type: object
+      required:
+        - order
+        - statement
+        - oid
       properties:
         order:
-          format: int32
           title: order
           description: position of this alternative to it's question
           type: integer
         statement:
-          title: statement
           description: the alternative statement
           type: string
         oid:
-          format: int32
           description: Object identifier
           type: integer
     AssessmentSubmission:
@@ -642,7 +734,7 @@ components:
         - $ref: '#/components/schemas/AssessmentSubmission'
         - type: object
           properties:
-            oloadUri:
+            loadUri:
               type: string
     VirtualAssessmentSubmission:
       allOf:

uml/Competify.mdj

@@ -9942,7 +9942,7 @@
 											"height": 13,
 											"autoResize": false,
 											"underline": false,
-											"text": "+statement",
+											"text": "+content",
 											"horizontalAlignment": 0,
 											"verticalAlignment": 5,
 											"wordWrap": false
@@ -12071,7 +12071,7 @@
 							"_parent": {
 								"$ref": "AAAAAAFjK7inaCwwiDo="
 							},
-							"name": "statement",
+							"name": "content",
 							"visibility": "public",
 							"isStatic": false,
 							"isLeaf": false,