Skip to content

Docs
Docs
Commit 0877424e authored by bernardosunderhus's avatar bernardosunderhus
Browse files
Options

[API] Adiciona headers padrões em todas as rotas

parent 57e910e7
Hide whitespace changes
Inline Side-by-side
Showing with 160 additions and 0 deletions
Api/Competition.yaml
View file @ 0877424e
......@@ -27,6 +27,11 @@ paths:
- authentication
summary: Sends a payload to try to login into the application
requestBody:
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
content:
application/json:
schema:
......@@ -40,6 +45,11 @@ paths:
required: true
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: Returns a JWT token
content:
application/json:
......@@ -54,6 +64,11 @@ paths:
summary: Retrieves all messages from the competifier
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -70,6 +85,11 @@ paths:
summary: Retrieves one message from a competifier
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -83,6 +103,11 @@ paths:
summary: Updates the message read state
description: The only attribute allowed to be altered is read
requestBody:
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
content:
application/json:
schema:
......@@ -90,6 +115,11 @@ paths:
required: true
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -110,6 +140,11 @@ paths:
summary: Retrieves all assessments
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -128,6 +163,11 @@ paths:
summary: Retrives an Assessment
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: Successfully retrieved assessment
content:
application/json:
......@@ -150,6 +190,11 @@ paths:
summary: Retrives all submissions from an assessment
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: Successfully retrieved all submissions from an assessment
content:
application/json:
......@@ -185,6 +230,11 @@ paths:
- assessments
summary: Creates or updates a submission from an assessment
requestBody:
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
content:
application/json:
schema:
......@@ -206,6 +256,11 @@ paths:
required: true
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: Successfully created the submission
content:
application/json:
......@@ -226,6 +281,11 @@ paths:
summary: Retrieves a single submission from an assessment
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -265,6 +325,11 @@ paths:
summary: Retrives all questions from an assessment
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -289,6 +354,11 @@ paths:
summary: Retrieves single question from a given assessment
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -316,6 +386,11 @@ paths:
summary: Retrieves statement from a question
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -341,6 +416,11 @@ paths:
summary: Retrieves alternatives from an objective question
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -368,6 +448,11 @@ paths:
summary: Retrieves all drafts
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -384,6 +469,11 @@ paths:
- assessments
summary: Creates or overrides an existing draft
requestBody:
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
content:
application/json:
schema:
......@@ -392,6 +482,11 @@ paths:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/VirtualAssessmentSubmission'
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -425,6 +520,11 @@ paths:
summary: Retrieves a draft
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -441,6 +541,11 @@ paths:
summary: Retrieves the Assessment Submission Evaluation.
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -461,6 +566,11 @@ paths:
summary: Retrives competifier
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -476,6 +586,11 @@ paths:
summary: Updates competifier
description: All except password
requestBody:
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
content:
application/json:
schema:
......@@ -483,6 +598,11 @@ paths:
required: true
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -500,6 +620,11 @@ paths:
description: only valid if the competifier is of type TEAM
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -516,6 +641,11 @@ paths:
summary: Retrieves a single participant from a competifier
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -528,6 +658,11 @@ paths:
- competifier
summary: Updates participant
requestBody:
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
content:
application/json:
schema:
......@@ -536,6 +671,11 @@ paths:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch'
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -556,6 +696,11 @@ paths:
summary: Retrieves all phases
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -572,6 +717,11 @@ paths:
summary: Retrieves a specific phase
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -592,6 +742,11 @@ paths:
summary: Retrieves the last ranking of a given Phase
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: ''
content:
application/json:
......@@ -614,6 +769,11 @@ paths:
summary: Retrieves the Competifier's Rank
responses:
'200':
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
Competition-Token:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Competition-Token
description: >-
Must return the Classification Rule, the Evaluation Rule and
evaluations.
......
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