Skip to content

Docs
Docs
Commit c9bb66ca authored by Rosana Aurélio's avatar Rosana Aurélio
Browse files
Options

[API] Correções na API

parent 6a754cca
Show whitespace changes
Inline Side-by-side
Showing with 810 additions and 570 deletions
Api/Competition.API.yaml
View file @ c9bb66ca
......@@ -115,26 +115,34 @@ paths:
application/json:
schema:
type: string
/competition:
# Public
/invitations/{invitationToken}:
get:
tags:
- public
summary: Retrieves information about this competition
description: Retrieves information about this competition.
summary: Retrieves the invitations
responses:
'200':
description: ''
content:
application/json:
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/#/Invitation'
parameters:
- in: path
name: invitationToken
required: true
schema:
type: string
minimum: 1
/competifiers:
/competition:
get:
tags:
- competifiers
summary: Retrieves all competitors within the competition
description: Retrieves all competitors within the competition.
- public
summary: Retrieves information about this competition
description: Retrieves information about this competition.
responses:
'200':
description: ''
......@@ -182,25 +190,6 @@ paths:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
/subscription/invitations/{invitationToken}:
get:
tags:
- public
summary: Retrieves the invitations
parameters:
- in: path
name: invitationToken
required: true
schema:
type: string
minimum: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Invitation'
/subscription/submissions:
post:
tags:
......@@ -226,78 +215,6 @@ paths:
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/#/TeamSubscriptionSubmission'
# /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:
- $ref: >-
......@@ -324,6 +241,122 @@ paths:
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# Phase
/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/#/Competifier'
/phases:
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:
- phases
summary: Retrieves all phases
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/#/Phase
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/phases/{phaseId}:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- name: phaseId
in: path
required: true
schema:
type: integer
get:
tags:
- phases
summary: Retrieves a specific phase
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/phases/{phaseId}/board:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- name: phaseId
in: path
required: true
schema:
type: integer
get:
tags:
- phases
summary: Retrieves the list of competifiers running in the given phase
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/#/PhaseParticipation
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/phases/{phaseId}/ranking:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- name: phaseId
in: path
required: true
schema:
type: integer
get:
tags:
- phases
summary: Retrieves the competitor's classification of the given phase
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/#/Ranking
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/assignments:
parameters:
- $ref: >-
......@@ -350,8 +383,7 @@ paths:
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}/status':
/assignments/{assignmentId}/status:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
......@@ -371,8 +403,10 @@ paths:
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
type: object
oneOf:
- $ref: 'htps://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
required: true
responses:
'200':
......@@ -380,13 +414,14 @@ paths:
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}':
/assignments/{assignmentId}:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
......@@ -416,7 +451,7 @@ paths:
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}/submissions':
/assignments/{assignmentId}/submissions:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
......@@ -449,7 +484,7 @@ paths:
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}/draft':
/assignments/{assignmentId}/draft:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
......@@ -494,7 +529,6 @@ paths:
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
patch:
tags:
- assignments
......@@ -504,8 +538,9 @@ paths:
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmissionDraft'
required: true
responses:
'200':
......@@ -514,11 +549,11 @@ paths:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmissionDraft
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}/exam':
/assignments/{assignmentId}/exam:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
......@@ -541,13 +576,11 @@ paths:
items:
anyOf:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Exam
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}/exam/questions':
/assignments/{assignmentId}/exam/questions:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
......@@ -576,7 +609,7 @@ paths:
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/assignments/{assignmentId}/exam/questions/{questionId}':
/assignments/{assignmentId}/exam/questions/{questionId}:
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
......@@ -608,6 +641,96 @@ paths:
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/me:
get:
tags:
- competifiers
summary: Retrieves user information.
description: Retrieves user information.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/User'
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# /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/{assessmentId}/questions/{questionId}/statement':
# parameters:
# - $ref: >-
......@@ -907,107 +1030,6 @@ paths:
# '500':
# $ref: >-
# https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/phases:
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:
- phases
summary: Retrieves all phases
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/#/Phase
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/phases/{phaseId}':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- name: phaseId
in: path
required: true
schema:
type: integer
get:
tags:
- phases
summary: Retrieves a specific phase
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/phases/{phaseId}/board':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- name: phaseId
in: path
required: true
schema:
type: integer
get:
tags:
- phases
summary: Retrieves the list of competifiers running in the given phase
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/#/Rank
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'/phases/{phaseId}/ranking':
parameters:
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
- name: phaseId
in: path
required: true
schema:
type: integer
get:
tags:
- phases
summary: Retrieves the competitor's classification of the given phase
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/#/Rank
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
# '/phases/{phaseId}/ranking/me':
# parameters:
# - $ref: >-
......
Api/Competition.Adm.API.yaml
View file @ c9bb66ca
......@@ -38,6 +38,7 @@ tags:
- name: exams
description: 'Exam operations'
paths:
# Competition
/competition:
get:
tags:
......@@ -51,6 +52,8 @@ paths:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition'
# Competifiers
/competifiers:
get:
tags:
......@@ -68,6 +71,232 @@ paths:
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'
# Subscription
/subscription:
get:
tags:
- subscription
summary: Retrieves the subscription rule
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/#/SoloSubscription'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscription'
patch:
tags:
- subscription
summary: Updates the subscription rule
requestBody:
content:
application/json:
schema:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloSubscription'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscription'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloSubscription'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscription'
/subscription/participant-template:
get:
tags:
- subscription
summary: Retrieves the participant form template
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
patch:
tags:
- subscription
summary: Updates the participant form template
requestBody:
content:
application/json:
schema:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
/subscription/team-template:
get:
tags:
- subscription
summary: Retrieves the team form template
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
patch:
tags:
- subscription
summary: Updates the team form template
requestBody:
content:
application/json:
schema:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
/subscription/submissions:
get:
tags:
- submissions
summary: Retrieves all submissions for this competition
description: Retrieves all submissions for this competition.
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/#/SoloSubscriptionSubmission'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscriptionSubmission'
/subscription/submissions/{submissionId}:
get:
tags:
- submissions
summary: Retrieves a specific subscription
description: Retrieves a subscription with the given id.
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/#/SoloSubscriptionSubmission'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscriptionSubmission'
parameters:
- name: submissionId
in: path
description: The unique identifier of the application.
required: true
schema:
format: int32
type: integer
/subscription/submissions/{submissionId}/status:
patch:
tags:
- submissions
summary: Updates the status of a specific application
description: 'Updates a subscription with the given id, setting a new status.'
requestBody:
content:
application/json:
schema:
type: object
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/#/TeamSubscriptionSubmission'
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/#/SoloSubscriptionSubmission'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscriptionSubmission'
parameters:
- name: submissionId
in: path
description: The unique identifier of the application.
required: true
schema:
format: int32
type: integer
/subscription/submissions/{submissionId}/invitations:
get:
tags:
- submissions
summary: Retrieves all invitagions from submission
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/#/Invitation'
parameters:
- name: submissionId
in: path
description: The unique identifier of the application.
required: true
schema:
format: int32
type: integer
/subscription/submissions/{submissionId}/invitations/{invitationId}:
get:
tags:
- submissions
summary: Retrieves all invitagions from submission
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Invitation'
parameters:
- name: submissionId
in: path
description: The unique identifier of the application.
required: true
schema:
format: int32
type: integer
- name: invitationId
in: path
description: The unique identifier of the application.
required: true
schema:
format: int32
type: integer
# Exams
/exams:
get:
tags:
......@@ -123,7 +352,9 @@ paths:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Exam'
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Exam'
required: true
responses:
'200':
......@@ -202,9 +433,9 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Question'
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Question'
required: true
responses:
'200':
......@@ -248,8 +479,8 @@ paths:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion'
required: true
......@@ -293,8 +524,8 @@ paths:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion'
required: true
......@@ -308,6 +539,21 @@ paths:
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion'
parameters:
- name: examId
in: path
description: The unique identifier of the Exam.
required: true
schema:
format: int32
type: integer
- name: questionId
in: path
description: The unique identifier of the Question.
required: true
schema:
format: int32
type: integer
/exams/{examId}/groups:
get:
tags:
......@@ -374,9 +620,9 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/QuestionGroup'
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/QuestionGroup'
required: true
responses:
'200':
......@@ -412,12 +658,13 @@ paths:
schema:
format: int32
type: integer
/subscription/submissions:
# Phase
/phases:
get:
tags:
- submissions
summary: Retrieves all submissions for this competition
description: Retrieves all submissions for this competition.
- phases
summary: Retrieves all phases for the competition
responses:
'200':
description: ''
......@@ -426,47 +673,46 @@ paths:
schema:
type: array
items:
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/#/TeamSubscriptionSubmission'
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
post:
tags:
- submissions
summary: Creates a submission for the competition
description: Creates a new submission for the competition.
- phases
summary: Creates a new phase for the competition
requestBody:
content:
application/json:
schema:
type: object
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/#/TeamSubscriptionSubmission'
required: true
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
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/#/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/#/Phase'
/phases/{phaseId}:
get:
tags:
- phases
summary: Retrieves a specific phase of this competition
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
patch:
tags:
- submissions
summary: Updates multiple Submissions
description: Updates multiple Submissions.
- phases
summary: Updates a specific phase of this competition
requestBody:
content:
application/json-schema+json:
application/json:
schema:
type: array
items:
type: object
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/#/TeamSubscriptionSubmission'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
required: true
responses:
'200':
......@@ -474,63 +720,39 @@ paths:
content:
application/json:
schema:
type: array
items:
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/#/TeamSubscriptionSubmission'
'/subscription/submissions/{submissionId}':
get:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
delete:
tags:
- submissions
summary: Retrieves a specific subscription
description: Retrieves a subscription with the given id.
- phases
summary: Deletes a specific phase of this competition
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/#/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/#/Phase'
parameters:
- name: submissionId
- name: phaseId
in: path
description: The unique identifier of the application.
required: true
schema:
format: int32
type: integer
/phases/{phaseId}/classification:
patch:
tags:
- submissions
summary: Updates the status of a specific application
description: 'Updates a subscription with the given id, setting a new status.'
- phases
summary: Updates the classification method for the specified phase
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$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/#/SoloSubscriptionSubmission'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscriptionSubmission'
/subscription:
get:
tags:
- subscription
summary: Retrieves the subscription rule
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/MinimumPerformance'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked'
required: true
responses:
'200':
description: ''
......@@ -539,64 +761,27 @@ paths:
schema:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloSubscription'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscription'
patch:
tags:
- subscription
summary: Updates the subscription rule
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/MinimumPerformance'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked'
parameters:
- name: phaseId
in: path
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloSubscription'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscription'
# /subscription/templates:
# get:
# tags:
# - public
# summary: Retrieves all form templates
# 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/#/FormTemplate'
/subscription/team-template:
get:
tags:
- subscription
summary: Retrieves the team form template
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
format: int32
type: integer
/phases/{phaseId}/formula:
patch:
tags:
- subscription
summary: Updates the team form template
- phases
summary: Updates the evaluation formula for the specified phase
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/EvaluationFormula'
required: true
responses:
'200':
......@@ -604,41 +789,41 @@ paths:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
/subscription/participant-template:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/EvaluationFormula'
parameters:
- name: phaseId
in: path
required: true
schema:
format: int32
type: integer
/phases/{phaseId}/events:
get:
tags:
- subscription
summary: Retrieves the participant form template
- phases
summary: Retrieves all phase events
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
patch:
tags:
- subscription
summary: Updates the participant form template
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/PhaseEvent'
parameters:
- name: phaseId
in: path
description: The unique identifier of the Exam.
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
/phases:
format: int32
type: integer
/phases/{phaseId}/assessments:
get:
tags:
- phases
summary: Retrieves all phases for the competition
summary: Retrieves all assessments
responses:
'200':
description: ''
......@@ -647,83 +832,90 @@ paths:
schema:
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
post:
tags:
- phases
summary: Creates a new phase for the competition
summary: Creates a new assessment
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
'/phases/{phaseId}':
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
parameters:
- name: phaseId
in: path
required: true
schema:
format: int32
type: integer
/phases/{phaseId}/ranking:
get:
tags:
- phases
summary: Retrieves a specific phase of this competition
summary: Retrieves the last Ranking for the Phase
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
patch:
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
parameters:
- name: phaseId
in: path
required: true
schema:
format: int32
type: integer
/phases/{phaseId}/evaluations:
get:
tags:
- phases
summary: Updates a specific phase of this competition
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
required: true
summary: Retrieves all Evaluations for the Phase
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
delete:
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
post:
tags:
- phases
summary: Deletes a specific phase of this competition
responses:
'200':
description: ''
summary: Creates a new Evaluation
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
parameters:
- name: phaseId
in: path
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
required: true
schema:
format: int32
type: integer
'/phases/{phaseId}/ranking':
get:
tags:
- phases
summary: Retrieves the last Ranking for the Phase
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/#/Ranking'
parameters:
- name: phaseId
......@@ -732,7 +924,7 @@ paths:
schema:
format: int32
type: integer
'/phases/{phaseId}/participations':
/phases/{phaseId}/participations:
get:
tags:
- phases
......@@ -753,7 +945,7 @@ paths:
schema:
format: int32
type: integer
'/phases/{phaseId}/participations/{participationId}':
/phases/{phaseId}/participations/{participationId}:
get:
tags:
- phases
......@@ -771,11 +963,11 @@ paths:
summary: Updates the specific Participation
requestBody:
content:
application/json-patch+json:
application/json:
schema:
type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch'
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/PhaseParticipation'
required: true
responses:
'200':
......@@ -797,29 +989,18 @@ paths:
schema:
format: int32
type: integer
'/phases/{phaseId}/evaluations':
get:
tags:
- phases
summary: Retrieves all Evaluations for the Phase
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/#/Ranking'
post:
/phases/{phaseId}/status:
patch:
tags:
- phases
summary: Creates a new Evaluation
summary: Updates the specific phase status
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
required: true
responses:
'200':
......@@ -827,83 +1008,46 @@ paths:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
parameters:
- name: phaseId
in: path
description: The unique identifier of the Exam.
required: true
schema:
format: int32
type: integer
'/phases/{phaseId}/assessments':
get:
tags:
- phases
summary: Retrieves all assessments
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/#/HandmadeAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
post:
# Assessments
/assessments/{assessmentId}/status:
patch:
tags:
- phases
summary: Creates a new assessment
- assessments
summary: Updates the specific assessment status
requestBody:
content:
application/json:
schema:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
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/#/HandmadeAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
parameters:
- name: phaseId
in: path
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Assessment'
required: true
schema:
format: int32
type: integer
'/assessments/{assessmentId}':
get:
tags:
- assessments
summary: Retrieves the specific assessment
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/#/HandmadeAssessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Assessment'
parameters:
- name: assessmentId
in: path
description: The unique identifier of the Exam.
required: true
schema:
format: int32
type: integer
'/assessments/{assessmentId}/submissions':
/assessments/{assessmentId}/submissions:
get:
tags:
- assessments
......@@ -926,7 +1070,7 @@ paths:
schema:
format: int32
type: integer
'/assessments/{assessmentId}/submissions/{submissionId}':
/assessments/{assessmentId}/submissions/{submissionId}:
get:
tags:
- assessments
......@@ -954,84 +1098,112 @@ paths:
schema:
format: int32
type: integer
'/phases/{phaseId}/formula':
patch:
tags:
- phases
summary: Updates the evaluation formula for the specified phase
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/EvaluationFormula'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/EvaluationFormula'
parameters:
- name: phaseId
in: path
required: true
schema:
format: int32
type: integer
'/phases/{phaseId}/classification':
patch:
tags:
- phases
summary: Updates the classification method for the specified phase
requestBody:
content:
application/json:
schema:
type: object
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/MinimumPerformance'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked'
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/#/MinimumPerformance'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked'
parameters:
- name: phaseId
in: path
required: true
schema:
format: int32
type: integer
'/phases/{phaseId}/status':
patch:
tags:
- phases
summary: Updates the status for the specified phase
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
parameters:
- name: phaseId
in: path
required: true
schema:
format: int32
type: integer
# /subscription/templates:
# get:
# tags:
# - public
# summary: Retrieves all form templates
# 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/#/FormTemplate'
# '/phases/{phaseId}/assessments':
# get:
# tags:
# - phases
# summary: Retrieves all assessments
# 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/#/HandmadeAssessment'
# - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
# post:
# tags:
# - phases
# summary: Creates a new assessment
# requestBody:
# content:
# application/json:
# schema:
# type: object
# oneOf:
# - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
# - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
# 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/#/HandmadeAssessment'
# - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
# parameters:
# - name: phaseId
# in: path
# required: true
# schema:
# format: int32
# type: integer
# '/assessments/{assessmentId}':
# get:
# tags:
# - assessments
# summary: Retrieves the specific assessment
# 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/#/HandmadeAssessment'
# - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
# parameters:
# - name: assessmentId
# in: path
# required: true
# schema:
# format: int32
# type: integer
# '/phases/{phaseId}/status':
# patch:
# tags:
# - phases
# summary: Updates the status for the specified phase
# requestBody:
# content:
# application/json:
# schema:
# $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
# required: true
# responses:
# '200':
# description: ''
# content:
# application/json:
# schema:
# $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
# parameters:
# - name: phaseId
# in: path
# required: true
# schema:
# format: int32
# type: integer
Api/components/schemas.yaml
View file @ c9bb66ca
......@@ -151,3 +151,6 @@ FormAnswer:
FormSection:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Subscription.yaml/#/FormSection
User:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Auth.yaml/#/User
Api/components/schemas/Auth.yaml 0 → 100644
View file @ c9bb66ca
User:
required:
- username
- password
- email
properties:
username:
type: string
password:
type: string
email:
type: string
userProfile:
type: string
enum:
- SYS_ADMIN
- COMPETITION_ADMIN
- COMPETITOR
Access:
required:
- user
properties:
user:
$ref: '#/user'
resource:
$ref: '#/resource'
type:
type: string
enum:
- MASTER
- HOST
- USER
- ANONYM
Resource:
required:
- resourceId
properties:
resourceId:
type: string
type:
type: string
enum:
- COMPETITION
\ No newline at end of file
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