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

c566617c · bernardosunderhus · Bernardo Lucas Almeida Sunderhus · b1289f90 · c566617c · c566617c
Commit c566617c authored May 14, 2018 by bernardosunderhus Committed by Bernardo Lucas Almeida Sunderhus May 14, 2018
Show whitespace changes
Inline Side-by-side

Showing with 109 additions and 38 deletions

Competition.yaml Api/Competition.yaml +101 -38

parameters.yaml Api/components/parameters.yaml +8 -0

No files found.
--- a/Api/Competition.yaml
+++ b/Api/Competition.yaml
@@ -12,18 +12,21 @@ info:
    name: Apache 2.0
    url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
 tags:
+  - name: authentication
+    description: Operations involving the user authentication
  - name: competifier
    description: Operations involving the competifier
  - name: assessments
    description: Operations involving the assessments
  - name: phases
    description: Operations involving the phases
-  - name: authentication
-    description: Operations involving the user authentication
 paths:
-  '/login':
+  /login:
    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:
      tags:
        - authentication
@@ -47,15 +50,18 @@ paths:
            application/json:
              schema:
                type: string
-        '500':
-          $ref: >-
-            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
        '422':
          $ref: >-
            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:
-      - $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:
      tags:
        - competifier
@@ -75,7 +81,10 @@ paths:
            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/#/language
+      - $ref: >-
+          https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
      - name: messageId
        in: path
        required: true
@@ -119,9 +128,12 @@ paths:
        '500':
          $ref: >-
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
-  '/assessments':
+  /assessments:
    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:
      tags:
        - assessments
@@ -144,7 +156,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}':
    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
        in: path
        required: true
@@ -170,7 +185,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/submissions':
    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
        in: path
        required: true
@@ -252,7 +270,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/submissions/{submissionId}':
    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
        in: path
        required: true
@@ -294,7 +315,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/questions':
    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
        in: path
        required: true
@@ -322,7 +346,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/questions/{questionId}':
    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
        in: path
        required: true
@@ -353,7 +380,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/questions/{questionId}/statement':
    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
        in: path
        required: true
@@ -381,7 +411,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/questions/{questionId}/alternatives':
    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
        in: path
        required: true
@@ -411,7 +444,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/drafts':
    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
        in: path
        required: true
@@ -466,7 +502,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/drafts/{draftId}':
    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
        in: path
        required: true
@@ -497,7 +536,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/assessments/{assessmentId}/evaluation':
    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
        in: path
        required: true
@@ -518,9 +560,12 @@ paths:
        '500':
          $ref: >-
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
-  '/competifier':
+  /competifier:
    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:
      tags:
        - competifier
@@ -565,9 +610,12 @@ paths:
        '500':
          $ref: >-
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
-  '/competifier/participants':
+  /competifier/participants:
    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:
      tags:
        - competifier
@@ -588,7 +636,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/competifier/participants/{participantId}':
    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
        in: path
        required: true
@@ -632,9 +683,12 @@ paths:
        '500':
          $ref: >-
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
-  '/phases':
+  /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/#/language
+      - $ref: >-
+          https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/parameters.yaml/#/competition_token
    get:
      tags:
        - phases
@@ -654,7 +708,10 @@ paths:
            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
+      - $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
        in: path
        required: true
@@ -677,7 +734,10 @@ paths:
            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
+      - $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
        in: path
        required: true
@@ -702,7 +762,10 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
  '/phases/{phaseId}/ranking/me':
    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
        in: path
        required: true
@@ -727,7 +790,7 @@ paths:
            https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/responses.yaml/#/InternalServerError
 components:
  securitySchemes:
-    COMPETITION_TOKEN:
+    Authorization:
      type: http
      scheme: bearer
      bearerFormat: JWT
--- a/Api/components/parameters.yaml
+++ b/Api/components/parameters.yaml
@@ -6,3 +6,11 @@ language:
  schema:
    type: string
  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