Adicionando workflow de realização de um exame

Api/Competifier API.yaml

+---
+openapi: 3.0.0
+info:
+  title: Competifier API
+  description: Competifier API
+  version: 0.1.0
+paths:
+  /phases: {}
+  /phases/{phaseId}: {}
+  /phases/{phaseId}/assessments: {}
+  /team: {}
+  /account: {}
+  /claims: {}
+  /messages: {}
+  /team/members/{memberId}: {}
+  /claims/{claimId}: {}
+  /messages/{messageId}: {}
+  /preferences: {}
+  /assessments: {}
+  /assessments/{assessmentId}:
+    get:
+      summary: Retrives an Assessment
+      responses:
+        200:
+          description: Successfully retrieved assessment
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Assessment'
+    parameters:
+    - name: assessmentId
+      in: path
+      required: true
+      schema:
+        format: int32
+        type: integer
+  /submissions: {}
+  /submissions/{submissionId}: {}
+  /assessments/{assessmentId}/submissions:
+    get:
+      summary: Retrives all submissions from an assessment
+      responses:
+        200:
+          description: Successfully retrieved all submissions from an assessment
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/AssessmentSubmission'
+    post:
+      summary: Creates new submission from an assessment
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AssessmentSubmission'
+        required: true
+      responses:
+        200:
+          description: Successfully created the submission
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AssessmentSubmission'
+    parameters:
+    - name: assessmentId
+      in: path
+      required: true
+      schema:
+        format: int32
+        type: integer
+  /assessments/{assessmentId}/submissions/{submissionId}:
+    get:
+      summary: Retrieves a single submission from an assessment
+      responses:
+        200:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AssessmentSubmission'
+    parameters:
+    - name: assessmentId
+      in: path
+      required: true
+      schema:
+        format: int32
+        type: integer
+    - name: submissionId
+      in: path
+      required: true
+      schema:
+        format: int32
+        type: integer
+  /assessments/{assessmentId}/questions:
+    get:
+      summary: Retrives all questions from an assessment
+      responses:
+        200:
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Question'
+    parameters:
+    - name: assessmentId
+      in: path
+      required: true
+      schema:
+        format: int32
+        type: integer
+  /assessments/{assessmentId}/questions/{questionId}:
+    get:
+      summary: Retrieves single question from a given assessment
+      responses:
+        200:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Question'
+    parameters:
+    - name: assessmentId
+      in: path
+      required: true
+      schema:
+        format: int32
+        type: integer
+    - name: questionId
+      in: path
+      required: true
+      schema:
+        format: int32
+        type: integer
+components:
+  schemas:
+    QuestionCategory:
+      title: QuestionCategory
+      description: Category for which the Question belongs
+      type: object
+      properties:
+        label:
+          title: Label
+          description: The label of the category
+          type: string
+        oid:
+          format: int32
+          title: OID
+          description: The object persistence identification
+          type: integer
+          readOnly: true
+    ScheduledEvent:
+      title: ScheduledEvent
+      description: The begining and ending of the assessment
+      type: object
+      properties:
+        oid:
+          format: int32
+          title: OID
+          description: The object identification
+          type: integer
+          readOnly: true
+        startsAt:
+          format: date-time
+          title: startsAt
+          description: The time of the begining of the assessment
+          type: string
+        endsAt:
+          format: date-time
+          title: endsAt
+          description: The time of the ending of the assessment
+          type: string
+    Assessment:
+      title: Assessment
+      description: The assessment
+      type: object
+      properties:
+        status:
+          format: int32
+          description: Enumerator idicading status
+          type: integer
+          readOnly: true
+        type:
+          format: int32
+          description: '{GUIDED, HAND_MADE}'
+          type: integer
+          readOnly: true
+        schedule:
+          $ref: '#/components/schemas/ScheduledEvent'
+          description: The event schedule
+          readOnly: true
+        enforceSequence:
+          title: enforceSequence
+          description: Boolean indicading if the assessment must enforce the exams
+            to be done in it's order
+          type: boolean
+        location:
+          title: location
+          description: Why the fuck is this a string?
+          type: string
+        exam:
+          $ref: '#/components/schemas/Exam'
+          description: The exam itself
+        oid:
+          format: int32
+          description: Object identifier
+          type: integer
+        locationType:
+          format: int32
+          description: '{ONLINE, ON_SITE}'
+          type: integer
+        submitterType:
+          format: int32
+          description: '{ADMIN, ADMIN_OR_COMPETIFIER}'
+          type: integer
+    QuestionGroup:
+      title: QuestionGroup
+      type: object
+      properties:
+        oid:
+          format: int32
+          title: OID
+          type: integer
+          readOnly: true
+        label:
+          title: label
+          type: string
+        weight:
+          format: float
+          title: weight
+          type: number
+    ExamQuestion:
+      title: ExamQuestion
+      type: object
+      properties:
+        group:
+          format: int32
+          title: group
+          description: Group for which this given ExamQuestion belongs in this Exam
+          type: integer
+          readOnly: true
+        order:
+          format: int32
+          title: order
+          description: Position of this ExamQuestion in this Exam
+          type: integer
+        weight:
+          format: float
+          title: weight
+          description: Weight associated with this ExamQuestion
+          type: number
+        question:
+          format: int32
+          title: question oid
+          description: The oid of the question that this ExamQuestion represents
+          type: integer
+          readOnly: true
+        status:
+          format: int32
+          description: '{ACTIVE, CANCELED}'
+          type: integer
+        oid:
+          format: int32
+          description: Object identifier
+          type: integer
+    Exam:
+      title: Exam
+      description: The gathering of multiple *ExamQuestion* with their respective
+        *QuestionGroup*
+      type: object
+      properties:
+        type:
+          format: int32
+          description: '{SUBJECTIVE, OBJECTIVE}'
+          type: integer
+          readOnly: true
+        label:
+          title: label
+          description: A name to the exam
+          type: string
+        cover:
+          title: cover
+          description: An html to be embedded as cover
+          type: string
+        groups:
+          title: groups
+          description: The possible QuestionGroup of this Exam
+          type: array
+          items:
+            $ref: '#/components/schemas/QuestionGroup'
+        questions:
+          title: questions
+          description: All the ExamQuestions of this Exam
+          type: array
+          items:
+            $ref: '#/components/schemas/ExamQuestion'
+        oid:
+          format: int32
+          description: Object identifier
+          type: integer
+    Alternative:
+      title: Alternative
+      description: Alternative for a *ObjectiveQuestion*
+      type: object
+      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
+    Question:
+      title: Question
+      type: object
+      properties:
+        categories:
+          title: categories
+          uniqueItems: true
+          type: array
+          items:
+            $ref: '#/components/schemas/QuestionCategory'
+        type:
+          format: int32
+          type: integer
+          readOnly: true
+        statement:
+          title: statement
+          type: string
+        answerKey:
+          allOf:
+          - title: answerKey
+            description: Answer key for a *Subjective Question*
+            type: string
+          - format: int32
+            title: oid
+            description: OID of the correct alternative in an *Objective Question*
+            type: integer
+        alternatives:
+          title: alternatives
+          uniqueItems: true
+          type: array
+          items:
+            $ref: '#/components/schemas/Alternative'
+        oid:
+          format: int32
+          type: integer
+    AssessmentSubmission:
+      properties:
+        assessment:
+          $ref: '#/components/schemas/Assessment'
+          description: The assessment that this submission refers to
+        status:
+          format: int32
+          description: '{DRAFT, SUBMITTED}'
+          type: integer
+        type:
+          format: int32
+          description: '{GUIDED, HANDMADE}'
+          type: integer
+        lastUpdate:
+          format: date-time
+          description: Last time this submission was modified
+          type: string
+        startedAt:
+          format: date-time
+          type: string
+        finishedAt:
+          format: date-time
+          type: string
+        answers:
+          type: array
+          items:
+            $ref: '#/components/schemas/Answer'
+        uploadUri:
+          type: string
+    Answer:
+      properties:
+        type:
+          format: int32
+          type: integer
+        freeText:
+          type: string
+        choice:
+          format: int32
+          type: integer
+        question:
+          $ref: '#/components/schemas/ExamQuestion'
+    AssessmentSubmissionEvaluation:
+      properties:
+        timestamp:
+          format: int32
+          type: integer
+        grades:
+          type: array
+          items:
+            $ref: '#/components/schemas/AnswerGrade'
+    AnswerGrade:
+      properties:
+        grade:
+          format: float
+          type: number
+        question:
+          $ref: '#/components/schemas/ExamQuestion'
+tags:
+- name: competify
+  description:
+- name: competifier
+  description:

Api/ExamPlayer.yaml

-paths:
-  '/assessments/{oid}':
-    get:
-      summary: 'Obtains the assessment'
-      responses:
-        '200':
-          description: 'Successfully received the assessment'
-          schema:
-            x-oad-type: reference
-            $ref: '#/definitions/Assessment'
-          x-oad-type: response
-      parameters:
-        -
-          name: oid
-          in: path
-          required: true
-          type: integer
-          format: int32
-          x-oad-type: parameter
-    x-oad-type: operation
-  '/assesments/{oid}/questions':
-    get:
-      summary: 'GEt questions from a given assessment'
-      responses:
-        '200':
-          description: 'Successfully recovered question(s) '
-          schema:
-            x-oad-type: reference
-            $ref: '#/definitions/Question'
-          x-oad-type: response
-      parameters:
-        -
-          name: oid
-          in: path
-          required: true
-          type: integer
-          format: int32
-          x-oad-type: parameter
-        -
-          name: oids
-          in: query
-          required: false
-          type: array
-          collectionFormat: csv
-          items:
-            type: integer
-            format: int32
-          x-oad-type: parameter
-    x-oad-type: operation
-definitions:
-  QuestionType:
-    x-oad-type: integer
-    type: integer
-    title: 'Enumerator QuestionType'
-    description: 'Value that identifies the question as objective of subjective'
-    format: int32
-    enum:
-      - 2
-      - 1
-  ExamType:
-    x-oad-type: integer
-    type: integer
-    title: 'Enumerator ExamType'
-    description: 'Value that identifies the exam as objective only, subjective only or mixed'
-    format: int32
-    enum:
-      - 0
-      - 1
-      - 2
-  AssessmentType:
-    x-oad-type: integer
-    type: integer
-    title: 'Enumerator AssessmentType'
-    description: 'Value that identifies the exam as online or on site'
-    format: int32
-    enum:
-      - 0
-      - 1
-  QuestionCategory:
-    x-oad-type: object
-    type: object
-    title: QuestionCategory
-    description: 'Category for which the Question belongs'
-    properties:
-      label:
-        x-oad-type: string
-        type: string
-        title: Label
-        description: 'The label of the category'
-      oid:
-        x-oad-type: integer
-        type: integer
-        title: OID
-        description: 'The object persistence identification'
-        format: int32
-        readOnly: true
-  AssessmentStatus:
-    x-oad-type: integer
-    type: integer
-    title: AssessmentStatus
-    description: 'The current idication status of the assessment (there''s none in the moment...)'
-    format: int32
-  ScheduledEvent:
-    x-oad-type: object
-    type: object
-    title: ScheduledEvent
-    description: 'The begining and ending of the assessment'
-    properties:
-      oid:
-        x-oad-type: integer
-        type: integer
-        title: OID
-        description: 'The object identification'
-        format: int32
-        readOnly: true
-      startsAt:
-        x-oad-type: string
-        type: string
-        title: startsAt
-        description: 'The time of the begining of the assessment'
-        format: date-time
-      endsAt:
-        x-oad-type: string
-        type: string
-        title: endsAt
-        description: 'The time of the ending of the assessment'
-        format: date-time
-  Assessment:
-    x-oad-type: object
-    type: object
-    title: Assessment
-    description: 'The assessment'
-    properties:
-      status:
-        x-oad-type: reference
-        $ref: '#/definitions/AssessmentStatus'
-        readOnly: true
-      type:
-        x-oad-type: reference
-        $ref: '#/definitions/AssessmentType'
-        readOnly: true
-      schedule:
-        x-oad-type: reference
-        $ref: '#/definitions/ScheduledEvent'
-        readOnly: true
-      enforceSequence:
-        x-oad-type: boolean
-        type: boolean
-        title: enforceSequence
-        description: 'Boolean indicading if the assessment must enforce the exams to be done in it''s order'
-      location:
-        x-oad-type: string
-        type: string
-        title: location
-      exam:
-        x-oad-type: reference
-        $ref: '#/definitions/Exam'
-  ExamQuestionStatus:
-    x-oad-type: integer
-    type: integer
-    title: ExamQuestionStatus
-    description: 'Enumerator indicading if the exam is active or canceled'
-    format: int32
-    enum:
-      - 0
-      - 1
-  QuestionGroup:
-    x-oad-type: object
-    type: object
-    title: QuestionGroup
-    properties:
-      oid:
-        x-oad-type: integer
-        type: integer
-        title: OID
-        format: int32
-        readOnly: true
-      label:
-        x-oad-type: string
-        type: string
-        title: label
-      weight:
-        x-oad-type: integer
-        type: integer
-        title: weight
-        format: int32
-  ExamQuestion:
-    x-oad-type: object
-    type: object
-    title: ExamQuestion
-    properties:
-      group:
-        x-oad-type: integer
-        type: integer
-        title: group
-        description: 'Group for which this given *ExamQuestion* belongs in this *Exam*'
-        format: int32
-        readOnly: true
-      order:
-        x-oad-type: integer
-        type: integer
-        title: order
-        description: 'Position of this *ExamQuestion* in this *Exam*'
-        format: int32
-      weight:
-        x-oad-type: integer
-        type: integer
-        title: weight
-        description: 'Weight associated with this *ExamQuestion*'
-        format: int32
-      question:
-        x-oad-type: integer
-        type: integer
-        title: 'question oid'
-        description: 'The oid of the question that this *ExamQuestion*  represents'
-        format: int32
-        readOnly: true
-  Exam:
-    x-oad-type: object
-    type: object
-    title: Exam
-    description: 'The gathering of multiple *ExamQuestion* with their respective *QuestionGroup*'
-    properties:
-      type:
-        x-oad-type: reference
-        $ref: '#/definitions/ExamType'
-        readOnly: true
-      label:
-        x-oad-type: string
-        type: string
-        title: label
-      cover:
-        x-oad-type: string
-        type: string
-        title: cover
-        description: 'An html t be embedded'
-      groups:
-        x-oad-type: array
-        type: array
-        title: groups
-        description: 'The possible *QuestionGroup* of this *Exam*'
-        items:
-          x-oad-type: reference
-          $ref: '#/definitions/QuestionGroup'
-      questions:
-        x-oad-type: array
-        type: array
-        title: questions
-        description: 'All the *ExamQuestions*  of this *Exam*'
-        items:
-          x-oad-type: reference
-          $ref: '#/definitions/ExamQuestion'
-  Alternative:
-    x-oad-type: object
-    type: object
-    title: Alternative
-    description: 'Alternative for a *ObjectiveQuestion*'
-    properties:
-      order:
-        x-oad-type: integer
-        type: integer
-        title: order
-        format: int32
-      statement:
-        x-oad-type: string
-        type: string
-        title: statement
-  Question:
-    x-oad-type: object
-    type: object
-    title: Question
-    properties:
-      categories:
-        x-oad-type: array
-        type: array
-        title: categories
-        items:
-          x-oad-type: reference
-          $ref: '#/definitions/QuestionCategory'
-        uniqueItems: true
-      type:
-        x-oad-type: reference
-        $ref: '#/definitions/QuestionType'
-        readOnly: true
-      statement:
-        x-oad-type: string
-        type: string
-        title: statement
-      answerKey:
-        x-oad-type: allOf
-        allOf:
-          -
-            x-oad-type: string
-            type: string
-            title: answerKey
-            description: 'Answer key for a *Subjective Question*'
-          -
-            x-oad-type: integer
-            type: integer
-            title: oid
-            description: 'OID of the correct alternative in an *Objective Question*'
-            format: int32
-      alternatives:
-        x-oad-type: array
-        type: array
-        title: alternatives
-        items:
-          x-oad-type: reference
-          $ref: '#/definitions/Alternative'
-        uniqueItems: true
-info:
-  title: 'ExamPlayer API'
-  version: 0.1.0
-  description: 'The API to be consumed by the ExamPlayer'
-  contact:
-    name: 'Bernardo Sunderhus'
-    email: bernardosunderhus@evologica.com.br
-    url: 'https://gitlab.dev.evologica.com.br/Competify'
-  license:
-    name: MIT
-basePath: /
-consumes:
-  - application/json
-produces:
-  - application/json
-swagger: '2.0'

Api/ExamWorflow.md

+# Processo de reaização de um assessment
+
+1. A aplicação deverá adquirir o `assessment` a ser realizado através da rota `/assessment/{assessmentId}`
+ ```json
+ {
+    "enforceSequence": false,
+    "locationType": 0,
+    "oid": 0,
+    "status": 0,
+    "submitterType": 0,
+    "type": 0,
+    "schedule": {
+        "startsAt": "date-time",
+        "endsAt": "date-time"
+    },
+    "exam": {
+        "type": 0,
+        "label": "test",
+        "cover": "<gateemeele>oi</gateemeele>",
+        "groups": [
+            {
+                "label": "group 1",
+                "weight": 0,
+                "oid": 0
+            }
+        ],
+        "questions": [
+            {
+                "oid": 0,
+                "order": 0,
+                "weight": 0,
+                "group": 0,
+                "status": 0,
+                "question": 0
+            }
+        ]
+    }
+}
+ ```
+2. Com o assessment em mãos, a aplicação é capaz de liberar o começo do exame, criando assim um `draft`, por um método POST na rota `assessments/{assessmentId}/drafts`.
+  ```json
+  {
+      "oid": 0,
+      "answers": [],
+      "assessment": 0,
+      "finishedAt": "date-time",
+      "lastUpdate": "date-time",
+      "startedAt": "date-time",
+      "status": 0,
+      "type": 0,
+      "uploadUri": ""
+  }
+  ```
+3. Para exibir uma nova questão, a aplicação deverá buscar a mesma através da rota `/assessments/{assessmentId}/questions/{questionId}`
+4. Assim que uma questão for realizada, um novo POST na rota `assessments/{assessmentId}/drafts` deverá ser realizado passando a nova questão
+  ```json
+  {
+    "oid": 0,
+    "answers": [
+        {
+            "choice": 0,
+            "freeText": "",
+            "question": 0
+        }
+    ],
+    "assessment": 0,
+    "finishedAt": "date-time",
+    "lastUpdate": "date-time",
+    "startedAt": "date-time",
+    "status": 0,
+    "type": 0,
+    "uploadUri": ""
+  }
+  ```
+5. Ao finalizar a prova o `draft` deve ser convertido em `submission` através do método POST na rota `/assessments/{assessmentId}/submissions`