Skip to content

Docs
Docs
Commit 1a3521b2 authored by bernardosunderhus's avatar bernardosunderhus
Browse files
Options

[API] Adiciona rota de login

parent 50b53ba3
Show whitespace changes
Inline Side-by-side
Showing with 128 additions and 96 deletions
Api/Competifier.yaml
View file @ 1a3521b2
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:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/ScheduledEvent'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/ScheduledEvent
Assessment:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/Assessment'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/Assessment
VirtualAssessment:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/VirtualAssessment'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/VirtualAssessment
HandmadeAssessment:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/HandmadeAssessment'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/HandmadeAssessment
AssessmentEvent:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/AssessmentEvent'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Assessment.yaml/#/AssessmentEvent
QuestionGroup:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionGroup'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionGroup
QuestionStatement:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionStatement'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/QuestionStatement
Question:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Question'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Question
SubjectiveQuestion:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/SubjectiveQuestion'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/SubjectiveQuestion
ObjectiveQuestion:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ObjectiveQuestion'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ObjectiveQuestion
ExamCover:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamCover'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamCover
Exam:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Exam'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Exam
Alternative:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Alternative'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/Alternative
ExamQuestionComplaint:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamQuestionComplaint'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Exam.yaml/#/ExamQuestionComplaint
AssessmentSubmission:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmission'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmission
HandmadeAssessmentSubmission:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/HandmadeAssessmentSubmission'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/HandmadeAssessmentSubmission
VirtualAssessmentSubmission:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmission'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmission
Answer:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/Answer'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/Answer
AssessmentSubmissionEvaluation:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmissionEvaluation'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AssessmentSubmissionEvaluation
AnswerGrade:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AnswerGrade'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/AnswerGrade
VirtualAssessmentSubmissionDraft:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmissionDraft'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Submission.yaml/#/VirtualAssessmentSubmissionDraft
Competifier:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Competifier'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Competifier
SoloCompetifier:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/SoloCompetifier'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/SoloCompetifier
TeamCompetifier:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/TeamCompetifier'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/TeamCompetifier
CompetifierEvent:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/CompetifierEvent'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/CompetifierEvent
Tag:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Tag'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Tag
Participant:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Participant'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Participant
Message:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Message'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Competifier.yaml/#/Message
JsonPatch:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/JsonPatch.yaml'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/JsonPatch.yaml
Competition:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Competition'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Competition
Phase:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Phase'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Phase
PhaseEvent:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseEvent'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseEvent
PhaseParticipation:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseParticipation'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/PhaseParticipation
BestRanked:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/BestRanked'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/BestRanked
MinimumPerformance:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/MinimumPerformance'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/MinimumPerformance
ClassificationRule:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/ClassificationRule'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/ClassificationRule
EvaluationRule:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/EvaluationRule'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/EvaluationRule
TieBreakCriteria:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/TieBreakCriteria'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/TieBreakCriteria
Rank:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Rank'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Phase.yaml/#/Rank
SubscriptionRule:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SubscriptionRule'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SubscriptionRule
Subscription:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/Subscription'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/Subscription
SoloSubscription:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SoloSubscription'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/SoloSubscription
TeamSubscription:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/TeamSubscription'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/TeamSubscription
FormTemplate:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormTemplate'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormTemplate
FormField:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormField'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormField
FormAnswer:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormAnswer'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormAnswer
FormSection:
$ref:
'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormSection'
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/schemas/Subscription.yaml/#/FormSection
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment