Commit d38ff61d authored by bernardosunderhus's avatar bernardosunderhus

[API] Troca declaração de headers por parametros

parent 0877424e
......@@ -27,11 +27,6 @@ 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:
......@@ -45,11 +40,6 @@ 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:
......@@ -64,11 +54,6 @@ 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:
......@@ -85,11 +70,6 @@ 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:
......@@ -103,11 +83,6 @@ 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:
......@@ -115,11 +90,6 @@ 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:
......@@ -140,11 +110,6 @@ 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:
......@@ -163,11 +128,6 @@ 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:
......@@ -190,11 +150,6 @@ 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:
......@@ -230,11 +185,6 @@ 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:
......@@ -256,11 +206,6 @@ 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:
......@@ -281,11 +226,6 @@ 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:
......@@ -325,11 +265,6 @@ 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:
......@@ -354,11 +289,6 @@ 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:
......@@ -386,11 +316,6 @@ 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:
......@@ -416,11 +341,6 @@ 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:
......@@ -448,11 +368,6 @@ 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:
......@@ -469,11 +384,6 @@ 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:
......@@ -482,11 +392,6 @@ 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:
......@@ -520,11 +425,6 @@ 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:
......@@ -541,11 +441,6 @@ 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:
......@@ -566,11 +461,6 @@ 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:
......@@ -586,11 +476,6 @@ 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:
......@@ -598,11 +483,6 @@ 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:
......@@ -620,11 +500,6 @@ 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:
......@@ -641,11 +516,6 @@ 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:
......@@ -658,11 +528,6 @@ 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:
......@@ -671,11 +536,6 @@ 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:
......@@ -696,11 +556,6 @@ 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:
......@@ -717,11 +572,6 @@ 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:
......@@ -742,11 +592,6 @@ 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:
......@@ -769,11 +614,6 @@ 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.
......
Competition-Token:
description: The token that identifies the endpoint
schema:
type: integer
Accept-Language:
description: The desired language
schema:
type: string
language:
name: Accept-Language
in: header
description: preferred language
required: false
schema:
type: string
style: simple
......@@ -11,9 +11,9 @@ NotFoundError:
type: string
completeMessage:
type: string
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
parameters:
language:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language'
InternalServerError:
description: Internal Server Error
content:
......@@ -27,6 +27,6 @@ InternalServerError:
type: string
completeMessage:
type: string
headers:
Accept-Language:
$ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/headers.yaml/#/Accept-Language
parameters:
language:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language'
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