[API] Adiciona rota de login

1a3521b2 · bernardosunderhus · 50b53ba3 · 1a3521b2
Commit 1a3521b2 authored May 14, 2018 by bernardosunderhus
Hide whitespace changes
Inline Side-by-side

Showing with 128 additions and 96 deletions

Competifier.yaml Api/Competifier.yaml +128 -96

No files found.
--- a/Api/Competifier.yaml
+++ b/Api/Competifier.yaml
 openapi: 3.0.0
 info:
-  title: Competifier
+  title: Competition API
  version: 1.0.0
  description: >-
-    Api of the competifier. This API should be used by the client (AKA `competifier`) to perform assessments
+    Api of the competition. This API should be used by the client (AKA
+    `competifier`) to perform assessments
  contact:
    name: Documentation
    url: 'https://gitlab.dev.evologica.com.br/Competify/Docs'
@@ -17,7 +18,33 @@ tags:
    description: Operations involving the assessments
  - name: phases
    description: Operations involving the phases
+  - name: authentication
+    description: Operations involving the user authentication
 paths:
+  /login:
+    post:
+      tags:
+        - authentication
+      summary: Sends a payload to try to login into the application
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                username:
+                  type: string
+                password:
+                  type: string
+                  format: password
+        required: true
+      responses:
+        '200':
+          description: Returns a JWT token
+          content:
+            application/json:
+              schema:
+                type: string
  /competifier/messages:
    get:
      tags:
@@ -551,145 +578,150 @@ paths:
          schema:
            type: integer
 components:
+  securitySchemes:
+    COMPETITION_TOKEN:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
  schemas:
    ScheduledEvent:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/ScheduledEvent'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/ScheduledEvent
    Assessment:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/Assessment'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/Assessment
    VirtualAssessment:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/VirtualAssessment'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/VirtualAssessment
    HandmadeAssessment:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/HandmadeAssessment'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/HandmadeAssessment
    AssessmentEvent:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/AssessmentEvent'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/AssessmentEvent
    QuestionGroup:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionGroup'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionGroup
    QuestionStatement:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionStatement'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionStatement
    Question:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Question'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Question
    SubjectiveQuestion:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/SubjectiveQuestion'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/SubjectiveQuestion
    ObjectiveQuestion:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ObjectiveQuestion'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ObjectiveQuestion
    ExamCover:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamCover'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamCover
    Exam:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Exam'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Exam
    Alternative:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Alternative'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Alternative
    ExamQuestionComplaint:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamQuestionComplaint'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamQuestionComplaint
    AssessmentSubmission:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmission'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmission
    HandmadeAssessmentSubmission:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/HandmadeAssessmentSubmission'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/HandmadeAssessmentSubmission
    VirtualAssessmentSubmission:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmission'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmission
    Answer:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/Answer'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/Answer
    AssessmentSubmissionEvaluation:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmissionEvaluation'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmissionEvaluation
    AnswerGrade:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AnswerGrade'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AnswerGrade
    VirtualAssessmentSubmissionDraft:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmissionDraft'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmissionDraft
    Competifier:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Competifier'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Competifier
    SoloCompetifier:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/SoloCompetifier'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/SoloCompetifier
    TeamCompetifier:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/TeamCompetifier'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/TeamCompetifier
    CompetifierEvent:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/CompetifierEvent'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/CompetifierEvent
    Tag:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Tag'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Tag
    Participant:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Participant'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Participant
    Message:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Message'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Message
    JsonPatch:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/JsonPatch.yaml'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/JsonPatch.yaml
    Competition:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Competition'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Competition
    Phase:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Phase'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Phase
    PhaseEvent:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseEvent'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseEvent
    PhaseParticipation:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseParticipation'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseParticipation
    BestRanked:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/BestRanked'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/BestRanked
    MinimumPerformance:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/MinimumPerformance'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/MinimumPerformance
    ClassificationRule:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/ClassificationRule'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/ClassificationRule
    EvaluationRule:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/EvaluationRule'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/EvaluationRule
    TieBreakCriteria:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/TieBreakCriteria'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/TieBreakCriteria
    Rank:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Rank'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Rank
    SubscriptionRule:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SubscriptionRule'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SubscriptionRule
    Subscription:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/Subscription'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/Subscription
    SoloSubscription:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SoloSubscription'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SoloSubscription
    TeamSubscription:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/TeamSubscription'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/TeamSubscription
    FormTemplate:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormTemplate'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormTemplate
    FormField:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormField'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormField
    FormAnswer:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormAnswer'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormAnswer
    FormSection:
-      $ref:
+      $ref: >-
-        'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormSection'
+        https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormSection