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