Merge branch 'master' of gitlab.dev.evologica.com.br:Competify/Docs

Api/Competify.yaml

@@ -4,8 +4,10 @@ info:
   description: Competition Admin API
   version: 0.1.0
 tags:
-  - name: config
-    description: 'Subscription configuration operations'
+  - name: admin
+    description: 'Competition admin operations'
+  - name: public
+    description: 'Public operations'
   - name: subscription
     description: 'Subscription operations'
   - name: phases
@@ -13,8 +15,23 @@ tags:
   - name: exams
     description: 'Exam operations'
 paths:
+  /competition:
+    get:
+      tags:
+        - public
+      summary: Retrieves information about this competition
+      description: Retrieves information about this competition.
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition'
   /competifiers:
     get:
+      tags:
+        - public
       summary: Retrieves all Competifiers for this competition
       description: Retrieves all Competifiers for this competition.
       responses:
@@ -29,6 +46,8 @@ paths:
                     - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SoloCompetifier'
                     - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier'
     post:
+      tags:
+        - admin
       summary: Creates a new Competifier for the competition
       description: Creates a new Competifier for the competition.
       requestBody:
@@ -332,7 +351,7 @@ paths:
   /subscription:
     get:
       tags:
-        - config
+        - public
       summary: Retrieves the subscription rule
       responses:
         '200':
@@ -345,7 +364,7 @@ paths:
                   - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamSubscriptionRule'
     patch:
       tags:
-        - config
+        - admin
       summary: Updates the subscription rule
       requestBody:
         content:
@@ -362,10 +381,10 @@ paths:
             application/json:
               schema:
                 $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubscriptionRule'
-  /subscription/template:
+  /subscription/templates:
     get:
       tags:
-        - config
+        - public
       summary: Retrieves all form templates
       responses:
         '200':
@@ -376,10 +395,10 @@ paths:
                 type: array
                 items:
                   $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
-  /subscription/template/team:
+  /subscription/templates/team:
     get:
       tags:
-        - config
+        - public
       summary: Retrieves the team form template
       responses:
         '200':
@@ -390,7 +409,7 @@ paths:
                 $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
     patch:
       tags:
-        - config
+        - admin
       summary: Updates the team form template
       requestBody:
         content:
@@ -407,10 +426,10 @@ paths:
             application/json:
               schema:
                 $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
-  /subscription/template/participant:
+  /subscription/templates/participant:
     get:
       tags:
-        - config
+        - public
       summary: Retrieves the participant form template
       responses:
         '200':
@@ -421,7 +440,7 @@ paths:
                 $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
     patch:
       tags:
-        - config
+        - admin
       summary: Updates the participant form template
       requestBody:
         content:
@@ -539,23 +558,6 @@ paths:
                 type: array
                 items:
                   $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Rank'
-    # post:
-    #   tags:
-    #     - phases
-    #   summary: Creates a new Ranking for the Phase
-    #   requestBody:
-    #     content:
-    #       application/json:
-    #         schema:
-    #           $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
-    #     required: true
-    #   responses:
-    #     '200':
-    #       description: ''
-    #       content:
-    #         application/json:
-    #           schema:
-    #             $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
     parameters:
       - name: phaseId
         in: path
@@ -563,50 +565,6 @@ paths:
         schema:
           format: int32
           type: integer
-  # '/phases/{phaseId}/rankings/{rankingId}':
-  #   get:
-  #     tags:
-  #       - phases
-  #     summary: Retrieves the specific Ranking
-  #     responses:
-  #       '200':
-  #         description: ''
-  #         content:
-  #           application/json:
-  #             schema:
-  #               $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
-    # patch:
-    #   tags:
-    #     - phases
-    #   summary: Updates the specific Ranking
-    #   requestBody:
-    #     content:
-    #       application/json-patch+json:
-    #         schema:
-    #           type: array
-    #           items:
-    #             $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/JsonPatch'
-    #     required: true
-    #   responses:
-    #     '200':
-    #       description: ''
-    #       content:
-    #         application/json:
-    #           schema:
-    #             $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Ranking'
-    # parameters:
-    #   - name: phaseId
-    #     in: path
-    #     required: true
-    #     schema:
-    #       format: int32
-    #       type: integer
-    #   - name: rankingId
-    #     in: path
-    #     required: true
-    #     schema:
-    #       format: int32
-    #       type: integer
   '/phases/{phaseId}/participations':
     get:
       tags:

Api/components/schemas/Subscription.yaml

+SoloSubscriptionRule:
+  $ref: '#/SubscriptionRule'
+TeamSubscriptionRule:
+  allOf:
+    - $ref: '#/SubscriptionRule'
+    - type: object
+      properties:
+        minMembers:
+          type: integer
+        maxMembers:
+          type: integer
 SubscriptionRule:
   required:
     - type
     - status
   properties:
     type:
-      description: '{SOLO, TEAM}'
-      type: integer
+      type: string
+      enum:
+        - SOLO
+        - TEAM
     status:
-      description: '{PREP, OPEN, CLOSED}'
-      type: integer
+      type: string
+      enum:
+        - PREP
+        - OPEN
+        - CLOSED
     oid:
       type: integer
-    minMembers:
-      type: integer
-    maxMembers:
-      type: integer
+  discriminator:
+    propertyName: type
+    mapping:
+      - SOLO: '#/SoloSubscriptionRule'
+      - TEAM: '#/TeamSubscriptionRule'
 Subscription:
   required:
     - status
@@ -83,6 +100,8 @@ FormField:
       type: boolean
     required:
       type: boolean
+    removable:
+      type: boolean
     oid:
       type: integer
 FormAnswer: