Skip to content

Docs
Docs
Commit 57fff5cf authored by Isaac Pereira's avatar Isaac Pereira
Browse files
Options

[API] Atualiza endpoints do competidor

parent e57a476d
Hide whitespace changes
Inline Side-by-side
Showing with 65350 additions and 414 deletions
Api/Competition.API.yaml
View file @ 57fff5cf
...@@ -27,8 +27,8 @@ tags: ...@@ -27,8 +27,8 @@ tags:
description: Operations involving the user authentication description: Operations involving the user authentication
- name: public - name: public
description: 'Public operations' description: 'Public operations'
- name: competifier # - name: competifier
description: Operations involving the competifier # description: Operations involving the competifier
- name: assessments - name: assessments
description: Operations involving the assessments description: Operations involving the assessments
- name: phases - name: phases
...@@ -128,11 +128,26 @@ paths: ...@@ -128,11 +128,26 @@ paths:
application/json: application/json:
schema: schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition' $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition'
/competifiers:
get:
tags:
- competifiers
summary: Retrieves all competitors within the competition
description: Retrieves all competitors within the competition.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition'
/subscription: /subscription:
get: get:
tags: tags:
- public - public
summary: Retrieves the subscription rule summary: Retrieves the subscription configuration
responses: responses:
'200': '200':
description: '' description: ''
...@@ -211,7 +226,79 @@ paths: ...@@ -211,7 +226,79 @@ paths:
oneOf: oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloSubscriptionSubmission' - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloSubscriptionSubmission'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscriptionSubmission' - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscriptionSubmission'
/competifier/messages: # /competifier/messages:
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
# get:
# tags:
# - competifier
# summary: Retrieves all messages from the competifier
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: array
# items:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/competifier/messages/{messageId}':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
# - name: messageId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - competifier
# summary: Retrieves one message from a competifier
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# patch:
# tags:
# - competifier
# summary: Updates the message read state
# description: The only attribute allowed to be altered is read
# requestBody:
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
# required: true
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/assessments:
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
...@@ -219,8 +306,8 @@ paths: ...@@ -219,8 +306,8 @@ paths:
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get: get:
tags: tags:
- competifier - assessments
summary: Retrieves all messages from the competifier summary: Retrieves all assessments within the competition
responses: responses:
'200': '200':
description: '' description: ''
...@@ -229,61 +316,15 @@ paths: ...@@ -229,61 +316,15 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: >- oneOf:
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message - $ref: >-
'500': https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment
$ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment
'/competifier/messages/{messageId}':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: messageId
in: path
required: true
schema:
type: integer
get:
tags:
- competifier
summary: Retrieves one message from a competifier
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
patch:
tags:
- competifier
summary: Updates the message read state
description: The only attribute allowed to be altered is read
requestBody:
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/assessments: /assignments:
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
...@@ -291,8 +332,8 @@ paths: ...@@ -291,8 +332,8 @@ paths:
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get: get:
tags: tags:
- assessments - assignments
summary: Retrieves all assessments summary: Retrieves all assignments for an user
responses: responses:
'200': '200':
description: '' description: ''
...@@ -309,21 +350,57 @@ paths: ...@@ -309,21 +350,57 @@ paths:
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}':
'/assignments/{assignmentId}/status':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assignmentId
in: path
required: true
schema:
type: integer
patch:
tags:
- assignments
summary: Updates status of the assignment
description: The only attribute allowed to be altered is read
requestBody:
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assignmentId
in: path in: path
required: true required: true
schema: schema:
type: integer type: integer
get: get:
tags: tags:
- assessments - assignments
summary: Retrives an Assessment summary: Retrives an assignment
responses: responses:
'200': '200':
description: Successfully retrieved assessment description: Successfully retrieved assessment
...@@ -339,38 +416,21 @@ paths: ...@@ -339,38 +416,21 @@ paths:
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/submissions': '/assignments/{assignmentId}/submissions':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assignmentId
in: path in: path
required: true required: true
schema: schema:
type: integer type: integer
get:
tags:
- assessments
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: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/AssessmentSubmission
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
post: post:
tags: tags:
- assessments - assignments
summary: Creates or updates a submission from an assessment summary: Creates or updates a submission for an assignment
requestBody: requestBody:
content: content:
application/json: application/json:
...@@ -389,13 +449,13 @@ paths: ...@@ -389,13 +449,13 @@ paths:
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/submissions/{submissionId}': '/assignments/{assignmentId}/draft':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assignmentId
in: path in: path
required: true required: true
schema: schema:
...@@ -407,8 +467,8 @@ paths: ...@@ -407,8 +467,8 @@ paths:
type: integer type: integer
get: get:
tags: tags:
- assessments - assignments
summary: Retrieves a single submission from an assessment summary: Retrieves the last draft saved for the assignment
responses: responses:
'200': '200':
description: '' description: ''
...@@ -434,21 +494,43 @@ paths: ...@@ -434,21 +494,43 @@ paths:
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/questions':
patch:
tags:
- assignments
summary: Sync the progress for the assignment
description: Sync the progress for the assignment
requestBody:
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}/exam':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >- - name: assignmentId
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId
in: path in: path
required: true required: true
schema: schema:
type: integer type: integer
get: get:
tags: tags:
- assessments - assignments
summary: Retrives all questions from an assessment summary: Retrives the assessment's exam
responses: responses:
'200': '200':
description: '' description: ''
...@@ -465,91 +547,19 @@ paths: ...@@ -465,91 +547,19 @@ paths:
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/questions/{questionId}': '/assignments/{assignmentId}/exam/questions':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId
in: path
required: true
schema:
type: integer
- name: questionId
in: path
required: true
schema:
type: integer
get:
tags:
- assessments
summary: Retrieves single question from a given assessment
responses:
'200':
description: ''
content:
application/json:
schema:
anyOf:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/questions/{questionId}/statement':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >- - name: assignmentId
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId
in: path
required: true
schema:
type: integer
- name: questionId
in: path in: path
required: true required: true
schema: schema:
type: integer type: integer
get: get:
tags: tags:
- assessments - assignments
summary: Retrieves statement from a question summary: Retrives all questions from an assessment's exam
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/QuestionStatement
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/questions/{questionId}/alternatives':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId
in: path
required: true
schema:
type: integer
- name: questionId
in: path
required: true
schema:
type: integer
get:
tags:
- assessments
summary: Retrieves alternatives from an objective question
responses: responses:
'200': '200':
description: '' description: ''
...@@ -558,256 +568,345 @@ paths: ...@@ -558,256 +568,345 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: >- anyOf:
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Alternative
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/drafts':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId
in: path
required: true
schema:
type: integer
get:
tags:
- assessments
summary: Retrieves all drafts
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
oneOf:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
post:
tags:
- assessments
summary: Creates or overrides an existing draft
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
oneOf:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/drafts/{draftId}': '/assignments/{assignmentId}/exam/questions/{questionId}':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >- - name: assignmentId
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId
in: path in: path
required: true required: true
schema: schema:
type: integer type: integer
- name: draftId - name: questionId
in: path
required: true
schema:
type: integer
get:
tags:
- assessments
summary: Retrieves a draft
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
oneOf:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assessments/{assessmentId}/evaluation':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId
in: path in: path
required: true required: true
schema: schema:
type: integer type: integer
get: get:
tags: tags:
- assessments - assignments
summary: Retrieves the Assessment Submission Evaluation. summary: Retrieves single question from a given assessment's exam assignment
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/AssessmentSubmissionEvaluation
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/competifier:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get:
tags:
- competifier
summary: Retrives competifier
responses: responses:
'200': '200':
description: '' description: ''
content: content:
application/json: application/json:
schema: schema:
type: object anyOf:
oneOf:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloCompetifier
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
patch:
tags:
- competifier
summary: Updates competifier
description: All except password
requestBody:
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
oneOf:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloCompetifier https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/competifier/participants:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get:
tags:
- competifier
summary: Retrives all participants from a competifier
description: only valid if the competifier is of type TEAM
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Participant
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/competifier/participants/{participantId}':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: participantId
in: path
required: true
schema:
type: integer
get:
tags:
- competifier
summary: Retrieves a single participant from a competifier
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Participant
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
patch:
tags:
- competifier
summary: Updates participant
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Participant
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/assessments/{assessmentId}/questions/{questionId}/statement':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - name: assessmentId
# in: path
# required: true
# schema:
# type: integer
# - name: questionId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - assessments
# summary: Retrieves statement from a question
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/QuestionStatement
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/assessments/{assessmentId}/questions/{questionId}/alternatives':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - name: assessmentId
# in: path
# required: true
# schema:
# type: integer
# - name: questionId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - assessments
# summary: Retrieves alternatives from an objective question
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: array
# items:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Alternative
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/assessments/{assessmentId}/drafts':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - name: assessmentId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - assessments
# summary: Retrieves all drafts
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: array
# items:
# oneOf:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# post:
# tags:
# - assessments
# summary: Creates or overrides an existing draft
# requestBody:
# content:
# application/json:
# schema:
# oneOf:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: object
# oneOf:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/assessments/{assessmentId}/drafts/{draftId}':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - name: assessmentId
# in: path
# required: true
# schema:
# type: integer
# - name: draftId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - assessments
# summary: Retrieves a draft
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: object
# oneOf:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessmentSubmission
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/assessments/{assessmentId}/evaluation':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - name: assessmentId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - assessments
# summary: Retrieves the Assessment Submission Evaluation.
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/AssessmentSubmissionEvaluation
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# /competifier:
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
# get:
# tags:
# - competifier
# summary: Retrives competifier
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: object
# oneOf:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloCompetifier
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# patch:
# tags:
# - competifier
# summary: Updates competifier
# description: All except password
# requestBody:
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
# required: true
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: object
# oneOf:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloCompetifier
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# /competifier/participants:
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
# get:
# tags:
# - competifier
# summary: Retrives all participants from a competifier
# description: only valid if the competifier is of type TEAM
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# type: array
# items:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Participant
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/competifier/participants/{participantId}':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
# - name: participantId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - competifier
# summary: Retrieves a single participant from a competifier
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Participant
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# patch:
# tags:
# - competifier
# summary: Updates participant
# requestBody:
# content:
# application/json:
# schema:
# type: array
# items:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Participant
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/phases: /phases:
parameters: parameters:
- $ref: >- - $ref: >-
...@@ -835,8 +934,6 @@ paths: ...@@ -835,8 +934,6 @@ paths:
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: phaseId - name: phaseId
in: path in: path
required: true required: true
...@@ -857,12 +954,11 @@ paths: ...@@ -857,12 +954,11 @@ paths:
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/phases/{phaseId}/ranking':
'/phases/{phaseId}/board':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: phaseId - name: phaseId
in: path in: path
required: true required: true
...@@ -871,7 +967,7 @@ paths: ...@@ -871,7 +967,7 @@ paths:
get: get:
tags: tags:
- phases - phases
summary: Retrieves the last ranking of a given Phase summary: Retrieves the list of competifiers running in the given phase
responses: responses:
'200': '200':
description: '' description: ''
...@@ -885,12 +981,11 @@ paths: ...@@ -885,12 +981,11 @@ paths:
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/phases/{phaseId}/ranking/me':
'/phases/{phaseId}/ranking':
parameters: parameters:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: phaseId - name: phaseId
in: path in: path
required: true required: true
...@@ -899,20 +994,48 @@ paths: ...@@ -899,20 +994,48 @@ paths:
get: get:
tags: tags:
- phases - phases
summary: Retrieves the Competifier's Rank summary: Retrieves the competitor's classification of the given phase
responses: responses:
'200': '200':
description: >- description: ''
Must return the Classification Rule, the Evaluation Rule and
evaluations.
content: content:
application/json: application/json:
schema: schema:
$ref: >- type: array
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Rank items:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Rank
'500': '500':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/phases/{phaseId}/ranking/me':
# parameters:
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
# - $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
# - name: phaseId
# in: path
# required: true
# schema:
# type: integer
# get:
# tags:
# - phases
# summary: Retrieves the Competifier's Rank
# responses:
# '200':
# description: >-
# Must return the Classification Rule, the Evaluation Rule and
# evaluations.
# content:
# application/json:
# schema:
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Rank
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
externalDocs: externalDocs:
description: Gitlab documentation description: Gitlab documentation
url: 'https://gitlab.dev.evologica.com.br/Competify/Docs' url: 'https://gitlab.dev.evologica.com.br/Competify/Docs'
Api/components/schemas/Phase.yaml
View file @ 57fff5cf
...@@ -32,17 +32,13 @@ Phase: ...@@ -32,17 +32,13 @@ Phase:
required: required:
- label - label
- type - type
- status
properties: properties:
label: label:
type: string type: string
order: previous:
type: integer
next:
type: integer type: integer
type:
type: string
enum:
- CLASSIFICATORY
- FINAL
status: status:
type: integer type: integer
id: id:
...@@ -51,6 +47,10 @@ Phase: ...@@ -51,6 +47,10 @@ Phase:
type: array type: array
items: items:
$ref: '#/PhaseEvent' $ref: '#/PhaseEvent'
assessments:
type: arrays
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Assessment.yaml/#/Assessment'
participations: participations:
type: array type: array
items: items:
......
uml/Competify_.mdj 0 → 100644
View file @ 57fff5cf
This source diff could not be displayed because it is too large. You can view the blob instead.
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