Skip to content

Docs
Docs
Commit c566617c authored by bernardosunderhus's avatar bernardosunderhus Committed by Bernardo Lucas Almeida Sunderhus
Browse files
Options

[API] Adiciona token da competição como parametro obrigatório

parent b1289f90
Hide whitespace changes
Inline Side-by-side
Showing with 109 additions and 38 deletions
Api/Competition.yaml
View file @ c566617c
...@@ -12,18 +12,21 @@ info: ...@@ -12,18 +12,21 @@ info:
name: Apache 2.0 name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0.html' url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
tags: tags:
- name: authentication
description: Operations involving the user authentication
- name: competifier - name: competifier
description: Operations involving the competifier description: Operations involving the competifier
- name: assessments - name: assessments
description: Operations involving the assessments description: Operations involving the assessments
- name: phases - name: phases
description: Operations involving the phases description: Operations involving the phases
- name: authentication
description: Operations involving the user authentication
paths: paths:
'/login': /login:
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
post: post:
tags: tags:
- authentication - authentication
...@@ -47,15 +50,18 @@ paths: ...@@ -47,15 +50,18 @@ paths:
application/json: application/json:
schema: schema:
type: string type: string
'500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
'422': '422':
$ref: >- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/UnprocessableEntityError https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/UnprocessableEntityError
'/competifier/messages': '500':
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
/competifier/messages:
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get: get:
tags: tags:
- competifier - competifier
...@@ -75,12 +81,15 @@ paths: ...@@ -75,12 +81,15 @@ paths:
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
'/competifier/messages/{messageId}': '/competifier/messages/{messageId}':
parameters: parameters:
- $ref: https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language - $ref: >-
- name: messageId https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/language
in: path - $ref: >-
required: true https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
schema: - name: messageId
type: integer in: path
required: true
schema:
type: integer
get: get:
tags: tags:
- competifier - competifier
...@@ -119,9 +128,12 @@ paths: ...@@ -119,9 +128,12 @@ 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
'/assessments': /assessments:
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get: get:
tags: tags:
- assessments - assessments
...@@ -144,7 +156,10 @@ paths: ...@@ -144,7 +156,10 @@ paths:
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
'/assessments/{assessmentId}': '/assessments/{assessmentId}':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -170,7 +185,10 @@ paths: ...@@ -170,7 +185,10 @@ paths:
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
'/assessments/{assessmentId}/submissions': '/assessments/{assessmentId}/submissions':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -252,7 +270,10 @@ paths: ...@@ -252,7 +270,10 @@ paths:
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
'/assessments/{assessmentId}/submissions/{submissionId}': '/assessments/{assessmentId}/submissions/{submissionId}':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -294,7 +315,10 @@ paths: ...@@ -294,7 +315,10 @@ paths:
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
'/assessments/{assessmentId}/questions': '/assessments/{assessmentId}/questions':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -322,7 +346,10 @@ paths: ...@@ -322,7 +346,10 @@ paths:
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
'/assessments/{assessmentId}/questions/{questionId}': '/assessments/{assessmentId}/questions/{questionId}':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -353,7 +380,10 @@ paths: ...@@ -353,7 +380,10 @@ paths:
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
'/assessments/{assessmentId}/questions/{questionId}/statement': '/assessments/{assessmentId}/questions/{questionId}/statement':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -381,7 +411,10 @@ paths: ...@@ -381,7 +411,10 @@ paths:
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
'/assessments/{assessmentId}/questions/{questionId}/alternatives': '/assessments/{assessmentId}/questions/{questionId}/alternatives':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -411,7 +444,10 @@ paths: ...@@ -411,7 +444,10 @@ paths:
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
'/assessments/{assessmentId}/drafts': '/assessments/{assessmentId}/drafts':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -466,7 +502,10 @@ paths: ...@@ -466,7 +502,10 @@ paths:
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
'/assessments/{assessmentId}/drafts/{draftId}': '/assessments/{assessmentId}/drafts/{draftId}':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -497,7 +536,10 @@ paths: ...@@ -497,7 +536,10 @@ paths:
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
'/assessments/{assessmentId}/evaluation': '/assessments/{assessmentId}/evaluation':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: assessmentId - name: assessmentId
in: path in: path
required: true required: true
...@@ -518,9 +560,12 @@ paths: ...@@ -518,9 +560,12 @@ 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
'/competifier': /competifier:
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get: get:
tags: tags:
- competifier - competifier
...@@ -565,9 +610,12 @@ paths: ...@@ -565,9 +610,12 @@ 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
'/competifier/participants': /competifier/participants:
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get: get:
tags: tags:
- competifier - competifier
...@@ -588,7 +636,10 @@ paths: ...@@ -588,7 +636,10 @@ paths:
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
'/competifier/participants/{participantId}': '/competifier/participants/{participantId}':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: participantId - name: participantId
in: path in: path
required: true required: true
...@@ -632,9 +683,12 @@ paths: ...@@ -632,9 +683,12 @@ 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': /phases:
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
get: get:
tags: tags:
- phases - phases
...@@ -654,7 +708,10 @@ paths: ...@@ -654,7 +708,10 @@ paths:
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/{phaseId}': '/phases/{phaseId}':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: phaseId - name: phaseId
in: path in: path
required: true required: true
...@@ -677,7 +734,10 @@ paths: ...@@ -677,7 +734,10 @@ paths:
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/{phaseId}/ranking': '/phases/{phaseId}/ranking':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: phaseId - name: phaseId
in: path in: path
required: true required: true
...@@ -702,7 +762,10 @@ paths: ...@@ -702,7 +762,10 @@ paths:
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/{phaseId}/ranking/me': '/phases/{phaseId}/ranking/me':
parameters: 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/#/language
- $ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
- name: phaseId - name: phaseId
in: path in: path
required: true required: true
...@@ -727,7 +790,7 @@ paths: ...@@ -727,7 +790,7 @@ paths:
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
components: components:
securitySchemes: securitySchemes:
COMPETITION_TOKEN: Authorization:
type: http type: http
scheme: bearer scheme: bearer
bearerFormat: JWT bearerFormat: JWT
Api/components/parameters.yaml
View file @ c566617c
...@@ -6,3 +6,11 @@ language: ...@@ -6,3 +6,11 @@ language:
schema: schema:
type: string type: string
style: simple style: simple
competition_token:
name: Competition-Token
in: header
description: The JWT Token that uniquely identifies this competition within the competify scope
required: true
schema:
type: integer
style: simple
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