Skip to content

Docs
Docs
Commit ef54329e authored by bernardosunderhus's avatar bernardosunderhus
Browse files
Options

[API] Renomea os arquivos de declaração de API's

parent cfa7de21
Hide whitespace changes
Inline Side-by-side
Showing with 98 additions and 68 deletions
Api/Competifier.openapi.yaml → Api/Competifier.yaml
View file @ ef54329e
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: Competifier API title: Competifier
version: 1.0.0 version: 1.0.0
description: description: >-
missing description Api of the competifier. This API should be used by the client (AKA `competifier`) to perform assessments
contact: contact:
name: Documentation name: Documentation
url: 'https://gitlab.dev.evologica.com.br/Competify/Docs' url: 'https://gitlab.dev.evologica.com.br/Competify/Docs'
license: license:
name: Apache 2.0 name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
servers:
- url: https://localhost:3000/v1
tags: tags:
- name: competifier - name: competifier
description: Operations involving the competifier description: Operations involving the competifier
...@@ -69,7 +67,6 @@ paths: ...@@ -69,7 +67,6 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
/assessments: /assessments:
get: get:
...@@ -106,7 +103,6 @@ paths: ...@@ -106,7 +103,6 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/submissions': '/assessments/{assessmentId}/submissions':
get: get:
...@@ -179,7 +175,6 @@ paths: ...@@ -179,7 +175,6 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/submissions/{submissionId}': '/assessments/{assessmentId}/submissions/{submissionId}':
get: get:
...@@ -212,13 +207,11 @@ paths: ...@@ -212,13 +207,11 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
- name: submissionId - name: submissionId
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/questions': '/assessments/{assessmentId}/questions':
get: get:
...@@ -241,7 +234,6 @@ paths: ...@@ -241,7 +234,6 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/questions/{questionId}': '/assessments/{assessmentId}/questions/{questionId}':
get: get:
...@@ -262,13 +254,11 @@ paths: ...@@ -262,13 +254,11 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
- name: questionId - name: questionId
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/questions/{questionId}/statement': '/assessments/{assessmentId}/questions/{questionId}/statement':
get: get:
...@@ -287,13 +277,11 @@ paths: ...@@ -287,13 +277,11 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
- name: questionId - name: questionId
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/questions/{questionId}/alternatives': '/assessments/{assessmentId}/questions/{questionId}/alternatives':
get: get:
...@@ -314,13 +302,11 @@ paths: ...@@ -314,13 +302,11 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
- name: questionId - name: questionId
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/drafts': '/assessments/{assessmentId}/drafts':
get: get:
...@@ -363,7 +349,6 @@ paths: ...@@ -363,7 +349,6 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
'/assessments/{assessmentId}/drafts/{draftId}': '/assessments/{assessmentId}/drafts/{draftId}':
parameters: parameters:
...@@ -371,13 +356,11 @@ paths: ...@@ -371,13 +356,11 @@ paths:
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
- name: draftId - name: draftId
in: path in: path
required: true required: true
schema: schema:
format: int32
type: integer type: integer
get: get:
tags: tags:
...@@ -570,96 +553,143 @@ paths: ...@@ -570,96 +553,143 @@ paths:
components: components:
schemas: schemas:
ScheduledEvent: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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