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
Hide 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: ...@@ -115,26 +115,34 @@ paths:
application/json: application/json:
schema: schema:
type: string type: string
/competition:
# Public
/invitations/{invitationToken}:
get: get:
tags: tags:
- public - public
summary: Retrieves information about this competition summary: Retrieves the invitations
description: Retrieves information about this competition.
responses: responses:
'200': '200':
description: '' description: ''
content: content:
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/#/Invitation'
parameters:
/competifiers: - in: path
name: invitationToken
required: true
schema:
type: string
minimum: 1
/competition:
get: get:
tags: tags:
- competifiers - public
summary: Retrieves all competitors within the competition summary: Retrieves information about this competition
description: Retrieves all competitors within the competition. description: Retrieves information about this competition.
responses: responses:
'200': '200':
description: '' description: ''
...@@ -142,7 +150,7 @@ paths: ...@@ -142,7 +150,7 @@ 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'
/subscription: /subscription:
get: get:
tags: tags:
...@@ -182,25 +190,6 @@ paths: ...@@ -182,25 +190,6 @@ paths:
application/json: application/json:
schema: schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate' $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: /subscription/submissions:
post: post:
tags: tags:
...@@ -226,78 +215,6 @@ paths: ...@@ -226,78 +215,6 @@ 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:
# 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: /assessments:
parameters: parameters:
- $ref: >- - $ref: >-
...@@ -324,6 +241,122 @@ paths: ...@@ -324,6 +241,122 @@ 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
# 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: /assignments:
parameters: parameters:
- $ref: >- - $ref: >-
...@@ -350,8 +383,7 @@ paths: ...@@ -350,8 +383,7 @@ 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
/assignments/{assignmentId}/status:
'/assignments/{assignmentId}/status':
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
...@@ -371,22 +403,25 @@ paths: ...@@ -371,22 +403,25 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: >- type: object
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch 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 required: true
responses: responses:
'200': '200':
description: '' description: ''
content: content:
application/json: application/json:
schema: schema:
$ref: >- type: object
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Message 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': '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
/assignments/{assignmentId}:
'/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
...@@ -416,7 +451,7 @@ paths: ...@@ -416,7 +451,7 @@ 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
'/assignments/{assignmentId}/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
...@@ -449,7 +484,7 @@ paths: ...@@ -449,7 +484,7 @@ 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
'/assignments/{assignmentId}/draft': /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
...@@ -494,7 +529,6 @@ paths: ...@@ -494,7 +529,6 @@ 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
patch: patch:
tags: tags:
- assignments - assignments
...@@ -502,10 +536,11 @@ paths: ...@@ -502,10 +536,11 @@ paths:
description: Sync the progress for the assignment description: Sync the progress for the assignment
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
$ref: >- type: object
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmissionDraft'
required: true required: true
responses: responses:
'200': '200':
...@@ -514,11 +549,11 @@ paths: ...@@ -514,11 +549,11 @@ paths:
application/json: application/json:
schema: schema:
$ref: >- $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': '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
'/assignments/{assignmentId}/exam': /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
...@@ -541,13 +576,11 @@ paths: ...@@ -541,13 +576,11 @@ paths:
items: items:
anyOf: anyOf:
- $ref: >- - $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/ObjectiveQuestion https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Exam
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubjectiveQuestion
'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
'/assignments/{assignmentId}/exam/questions': /assignments/{assignmentId}/exam/questions:
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
...@@ -576,7 +609,7 @@ paths: ...@@ -576,7 +609,7 @@ 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
'/assignments/{assignmentId}/exam/questions/{questionId}': /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
...@@ -608,6 +641,96 @@ paths: ...@@ -608,6 +641,96 @@ 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
/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': # '/assessments/{assessmentId}/questions/{questionId}/statement':
# parameters: # parameters:
# - $ref: >- # - $ref: >-
...@@ -907,107 +1030,6 @@ paths: ...@@ -907,107 +1030,6 @@ 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:
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': # '/phases/{phaseId}/ranking/me':
# parameters: # parameters:
# - $ref: >- # - $ref: >-
......
Api/Competition.Adm.API.yaml
View file @ c9bb66ca
...@@ -38,6 +38,7 @@ tags: ...@@ -38,6 +38,7 @@ tags:
- name: exams - name: exams
description: 'Exam operations' description: 'Exam operations'
paths: paths:
# Competition
/competition: /competition:
get: get:
tags: tags:
...@@ -51,6 +52,8 @@ paths: ...@@ -51,6 +52,8 @@ 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
/competifiers: /competifiers:
get: get:
tags: tags:
...@@ -68,6 +71,232 @@ paths: ...@@ -68,6 +71,232 @@ paths:
oneOf: 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/#/SoloCompetifier'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier' - $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: /exams:
get: get:
tags: tags:
...@@ -123,7 +352,9 @@ paths: ...@@ -123,7 +352,9 @@ paths:
content: content:
application/json: application/json:
schema: 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 required: true
responses: responses:
'200': '200':
...@@ -202,9 +433,9 @@ paths: ...@@ -202,9 +433,9 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: array type: object
items: oneOf:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Question' - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Question'
required: true required: true
responses: responses:
'200': '200':
...@@ -248,8 +479,8 @@ paths: ...@@ -248,8 +479,8 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: array type: object
items: 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/#/ObjectiveQuestion'
- $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/#/SubjectiveQuestion'
required: true required: true
...@@ -293,8 +524,8 @@ paths: ...@@ -293,8 +524,8 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: array type: object
items: 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/#/ObjectiveQuestion'
- $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/#/SubjectiveQuestion'
required: true required: true
...@@ -308,6 +539,21 @@ paths: ...@@ -308,6 +539,21 @@ paths:
oneOf: 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/#/ObjectiveQuestion'
- $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/#/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: /exams/{examId}/groups:
get: get:
tags: tags:
...@@ -374,9 +620,9 @@ paths: ...@@ -374,9 +620,9 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: array type: object
items: oneOf:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/QuestionGroup' - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/QuestionGroup'
required: true required: true
responses: responses:
'200': '200':
...@@ -412,12 +658,13 @@ paths: ...@@ -412,12 +658,13 @@ paths:
schema: schema:
format: int32 format: int32
type: integer type: integer
/subscription/submissions:
# Phase
/phases:
get: get:
tags: tags:
- submissions - phases
summary: Retrieves all submissions for this competition summary: Retrieves all phases for the competition
description: Retrieves all submissions for this competition.
responses: responses:
'200': '200':
description: '' description: ''
...@@ -426,95 +673,46 @@ paths: ...@@ -426,95 +673,46 @@ paths:
schema: schema:
type: array type: array
items: items:
oneOf: $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
- $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'
post: post:
tags: tags:
- submissions - phases
summary: Creates a submission for the competition summary: Creates a new phase for the competition
description: Creates a new submission for the competition.
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
type: object $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/#/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'
patch:
tags:
- submissions
summary: Updates multiple Submissions
description: Updates multiple Submissions.
requestBody:
content:
application/json-schema+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'
required: true
responses: responses:
'200': '200':
description: '' description: ''
content: content:
application/json: application/json:
schema: schema:
type: array $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
items: /phases/{phaseId}:
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: get:
tags: tags:
- submissions - phases
summary: Retrieves a specific subscription summary: Retrieves a specific phase of this competition
description: Retrieves a subscription with the given id.
responses: responses:
'200': '200':
description: '' description: ''
content: content:
application/json: application/json:
schema: schema:
type: object $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/#/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
patch: patch:
tags: tags:
- submissions - phases
summary: Updates the status of a specific application summary: Updates a specific phase of this competition
description: 'Updates a subscription with the given id, setting a new status.'
requestBody: requestBody:
content: content:
application/json-patch+json: application/json:
schema: schema:
type: array type: object
items: oneOf:
$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/#/Phase'
required: true required: true
responses: responses:
'200': '200':
...@@ -522,81 +720,38 @@ paths: ...@@ -522,81 +720,38 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: object $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
oneOf: delete:
- $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: tags:
- subscription - phases
summary: Retrieves the subscription rule summary: Deletes a specific phase of this competition
responses: responses:
'200': '200':
description: '' description: ''
content: content:
application/json: application/json:
schema: schema:
type: object $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase'
oneOf: parameters:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloSubscription' - name: phaseId
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscription' in: path
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'
required: true required: true
responses: schema:
'200': format: int32
description: '' type: integer
content: /phases/{phaseId}/classification:
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'
patch: patch:
tags: tags:
- subscription - phases
summary: Updates the team form template summary: Updates the classification method for the specified phase
requestBody: requestBody:
content: content:
application/json: application/json:
schema: 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/#/MinimumPerformance'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked'
required: true required: true
responses: responses:
'200': '200':
...@@ -604,28 +759,29 @@ paths: ...@@ -604,28 +759,29 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate' type: object
/subscription/participant-template: oneOf:
get: - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/MinimumPerformance'
tags: - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked'
- subscription parameters:
summary: Retrieves the participant form template - name: phaseId
responses: in: path
'200': required: true
description: '' schema:
content: format: int32
application/json: type: integer
schema: /phases/{phaseId}/formula:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
patch: patch:
tags: tags:
- subscription - phases
summary: Updates the participant form template summary: Updates the evaluation formula for the specified phase
requestBody: requestBody:
content: content:
application/json: application/json:
schema: 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 required: true
responses: responses:
'200': '200':
...@@ -633,12 +789,19 @@ paths: ...@@ -633,12 +789,19 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate' $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/EvaluationFormula'
/phases: parameters:
- name: phaseId
in: path
required: true
schema:
format: int32
type: integer
/phases/{phaseId}/events:
get: get:
tags: tags:
- phases - phases
summary: Retrieves all phases for the competition summary: Retrieves all phase events
responses: responses:
'200': '200':
description: '' description: ''
...@@ -647,44 +810,43 @@ paths: ...@@ -647,44 +810,43 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase' $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/PhaseEvent'
post: parameters:
tags: - name: phaseId
- phases in: path
summary: Creates a new phase for the competition description: The unique identifier of the Exam.
requestBody: required: true
content: schema:
application/json: format: int32
schema: type: integer
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase' /phases/{phaseId}/assessments:
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}':
get: get:
tags: tags:
- phases - phases
summary: Retrieves a specific phase of this competition summary: Retrieves all assessments
responses: responses:
'200': '200':
description: '' description: ''
content: content:
application/json: application/json:
schema: schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase' type: array
patch: 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: tags:
- phases - phases
summary: Updates a specific phase of this competition summary: Creates a new assessment
requestBody: requestBody:
content: content:
application/json: application/json:
schema: 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 required: true
responses: responses:
'200': '200':
...@@ -692,18 +854,31 @@ paths: ...@@ -692,18 +854,31 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase' type: object
delete: 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: tags:
- phases - phases
summary: Deletes a specific phase of this competition summary: Retrieves the last Ranking for the Phase
responses: responses:
'200': '200':
description: '' description: ''
content: content:
application/json: application/json:
schema: schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase' type: array
items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
parameters: parameters:
- name: phaseId - name: phaseId
in: path in: path
...@@ -711,11 +886,11 @@ paths: ...@@ -711,11 +886,11 @@ paths:
schema: schema:
format: int32 format: int32
type: integer type: integer
'/phases/{phaseId}/ranking': /phases/{phaseId}/evaluations:
get: get:
tags: tags:
- phases - phases
summary: Retrieves the last Ranking for the Phase summary: Retrieves all Evaluations for the Phase
responses: responses:
'200': '200':
description: '' description: ''
...@@ -725,6 +900,23 @@ paths: ...@@ -725,6 +900,23 @@ paths:
type: array type: array
items: items:
$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/#/Ranking'
post:
tags:
- phases
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/#/Ranking'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
parameters: parameters:
- name: phaseId - name: phaseId
in: path in: path
...@@ -732,7 +924,7 @@ paths: ...@@ -732,7 +924,7 @@ paths:
schema: schema:
format: int32 format: int32
type: integer type: integer
'/phases/{phaseId}/participations': /phases/{phaseId}/participations:
get: get:
tags: tags:
- phases - phases
...@@ -752,8 +944,8 @@ paths: ...@@ -752,8 +944,8 @@ paths:
required: true required: true
schema: schema:
format: int32 format: int32
type: integer type: integer
'/phases/{phaseId}/participations/{participationId}': /phases/{phaseId}/participations/{participationId}:
get: get:
tags: tags:
- phases - phases
...@@ -771,11 +963,11 @@ paths: ...@@ -771,11 +963,11 @@ paths:
summary: Updates the specific Participation summary: Updates the specific Participation
requestBody: requestBody:
content: content:
application/json-patch+json: application/json:
schema: schema:
type: array type: object
items: oneOf:
$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/#/PhaseParticipation'
required: true required: true
responses: responses:
'200': '200':
...@@ -796,30 +988,19 @@ paths: ...@@ -796,30 +988,19 @@ paths:
required: true required: true
schema: schema:
format: int32 format: int32
type: integer type: integer
'/phases/{phaseId}/evaluations': /phases/{phaseId}/status:
get: patch:
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:
tags: tags:
- phases - phases
summary: Creates a new Evaluation summary: Updates the specific phase status
requestBody: requestBody:
content: content:
application/json: application/json:
schema: 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 required: true
responses: responses:
'200': '200':
...@@ -827,42 +1008,29 @@ paths: ...@@ -827,42 +1008,29 @@ paths:
content: content:
application/json: application/json:
schema: 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: parameters:
- name: phaseId - name: phaseId
in: path in: path
description: The unique identifier of the Exam.
required: true required: true
schema: schema:
format: int32 format: int32
type: integer type: integer
'/phases/{phaseId}/assessments':
get: # Assessments
tags: /assessments/{assessmentId}/status:
- phases patch:
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: tags:
- phases - assessments
summary: Creates a new assessment summary: Updates the specific assessment status
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
type: object type: object
oneOf: 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/#/Assessment'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
required: true required: true
responses: responses:
'200': '200':
...@@ -870,40 +1038,16 @@ paths: ...@@ -870,40 +1038,16 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: object $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Assessment'
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: parameters:
- name: assessmentId - name: assessmentId
in: path in: path
description: The unique identifier of the Exam.
required: true required: true
schema: schema:
format: int32 format: int32
type: integer type: integer
'/assessments/{assessmentId}/submissions': /assessments/{assessmentId}/submissions:
get: get:
tags: tags:
- assessments - assessments
...@@ -926,7 +1070,7 @@ paths: ...@@ -926,7 +1070,7 @@ paths:
schema: schema:
format: int32 format: int32
type: integer type: integer
'/assessments/{assessmentId}/submissions/{submissionId}': /assessments/{assessmentId}/submissions/{submissionId}:
get: get:
tags: tags:
- assessments - assessments
...@@ -954,84 +1098,112 @@ paths: ...@@ -954,84 +1098,112 @@ paths:
schema: schema:
format: int32 format: int32
type: integer type: integer
'/phases/{phaseId}/formula':
patch: # /subscription/templates:
tags: # get:
- phases # tags:
summary: Updates the evaluation formula for the specified phase # - public
requestBody: # summary: Retrieves all form templates
content: # responses:
application/json: # '200':
schema: # description: ''
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/EvaluationFormula' # content:
required: true # application/json:
responses: # schema:
'200': # type: array
description: '' # items:
content: # $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
application/json:
schema: # '/phases/{phaseId}/assessments':
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/EvaluationFormula' # get:
parameters: # tags:
- name: phaseId # - phases
in: path # summary: Retrieves all assessments
required: true # responses:
schema: # '200':
format: int32 # description: ''
type: integer # content:
'/phases/{phaseId}/classification': # application/json:
patch: # schema:
tags: # type: array
- phases # items:
summary: Updates the classification method for the specified phase # oneOf:
requestBody: # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
content: # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
application/json: # post:
schema: # tags:
type: object # - phases
oneOf: # summary: Creates a new assessment
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/MinimumPerformance' # requestBody:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked' # content:
required: true # application/json:
responses: # schema:
'200': # type: object
description: '' # oneOf:
content: # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
application/json: # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
schema: # required: true
type: object # responses:
oneOf: # '200':
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/MinimumPerformance' # description: ''
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/BestRanked' # content:
parameters: # application/json:
- name: phaseId # schema:
in: path # type: object
required: true # oneOf:
schema: # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
format: int32 # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
type: integer # parameters:
'/phases/{phaseId}/status': # - name: phaseId
patch: # in: path
tags: # required: true
- phases # schema:
summary: Updates the status for the specified phase # format: int32
requestBody: # type: integer
content: # '/assessments/{assessmentId}':
application/json: # get:
schema: # tags:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase' # - assessments
required: true # summary: Retrieves the specific assessment
responses: # responses:
'200': # '200':
description: '' # description: ''
content: # content:
application/json: # application/json:
schema: # schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Phase' # type: object
parameters: # oneOf:
- name: phaseId # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/HandmadeAssessment'
in: path # - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessment'
required: true # parameters:
schema: # - name: assessmentId
format: int32 # in: path
type: integer # 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: ...@@ -151,3 +151,6 @@ FormAnswer:
FormSection: FormSection:
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Subscription.yaml/#/FormSection 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