Commit 7674ffbe authored by Gabriel Macena's avatar Gabriel Macena

[API] Inclui rota de Competition e altera as tags de operações de Template

parent 42e4afa5
...@@ -4,8 +4,10 @@ info: ...@@ -4,8 +4,10 @@ info:
description: Competition Admin API description: Competition Admin API
version: 0.1.0 version: 0.1.0
tags: tags:
- name: config - name: admin
description: 'Subscription configuration operations' description: 'Competition admin operations'
- name: public
description: 'Public operations'
- name: subscription - name: subscription
description: 'Subscription operations' description: 'Subscription operations'
- name: phases - name: phases
...@@ -13,8 +15,23 @@ tags: ...@@ -13,8 +15,23 @@ tags:
- name: exams - name: exams
description: 'Exam operations' description: 'Exam operations'
paths: 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: /competifiers:
get: get:
tags:
- public
summary: Retrieves all Competifiers for this competition summary: Retrieves all Competifiers for this competition
description: Retrieves all Competifiers for this competition. description: Retrieves all Competifiers for this competition.
responses: responses:
...@@ -29,6 +46,8 @@ paths: ...@@ -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/#/SoloCompetifier'
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier' - $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/TeamCompetifier'
post: post:
tags:
- admin
summary: Creates a new Competifier for the competition summary: Creates a new Competifier for the competition
description: Creates a new Competifier for the competition. description: Creates a new Competifier for the competition.
requestBody: requestBody:
...@@ -332,7 +351,7 @@ paths: ...@@ -332,7 +351,7 @@ paths:
/subscription: /subscription:
get: get:
tags: tags:
- config - public
summary: Retrieves the subscription rule summary: Retrieves the subscription rule
responses: responses:
'200': '200':
...@@ -343,7 +362,7 @@ paths: ...@@ -343,7 +362,7 @@ paths:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubscriptionRule' $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/SubscriptionRule'
patch: patch:
tags: tags:
- config - admin
summary: Updates the subscription rule summary: Updates the subscription rule
requestBody: requestBody:
content: content:
...@@ -363,7 +382,7 @@ paths: ...@@ -363,7 +382,7 @@ paths:
/subscription/templates: /subscription/templates:
get: get:
tags: tags:
- config - public
summary: Retrieves all form templates summary: Retrieves all form templates
responses: responses:
'200': '200':
...@@ -377,7 +396,7 @@ paths: ...@@ -377,7 +396,7 @@ paths:
/subscription/templates/team: /subscription/templates/team:
get: get:
tags: tags:
- config - public
summary: Retrieves the team form template summary: Retrieves the team form template
responses: responses:
'200': '200':
...@@ -388,7 +407,7 @@ paths: ...@@ -388,7 +407,7 @@ paths:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate' $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
patch: patch:
tags: tags:
- config - admin
summary: Updates the team form template summary: Updates the team form template
requestBody: requestBody:
content: content:
...@@ -408,7 +427,7 @@ paths: ...@@ -408,7 +427,7 @@ paths:
/subscription/templates/participant: /subscription/templates/participant:
get: get:
tags: tags:
- config - public
summary: Retrieves the participant form template summary: Retrieves the participant form template
responses: responses:
'200': '200':
...@@ -419,7 +438,7 @@ paths: ...@@ -419,7 +438,7 @@ paths:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate' $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/FormTemplate'
patch: patch:
tags: tags:
- config - admin
summary: Updates the participant form template summary: Updates the participant form template
requestBody: requestBody:
content: content:
...@@ -537,23 +556,6 @@ paths: ...@@ -537,23 +556,6 @@ paths:
type: array type: array
items: items:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Rank' $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: parameters:
- name: phaseId - name: phaseId
in: path in: path
...@@ -561,50 +563,6 @@ paths: ...@@ -561,50 +563,6 @@ paths:
schema: schema:
format: int32 format: int32
type: integer 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': '/phases/{phaseId}/participations':
get: get:
tags: tags:
......
...@@ -83,6 +83,8 @@ FormField: ...@@ -83,6 +83,8 @@ FormField:
type: boolean type: boolean
required: required:
type: boolean type: boolean
removable:
type: boolean
oid: oid:
type: integer type: integer
FormAnswer: FormAnswer:
......
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