Skip to content

Docs
Docs
Commit 313e1555 authored by Rosana Aurélio's avatar Rosana Aurélio
Browse files
Options

[API] Inclusão de rota que altera status de uma competição e que busca... 

[API] Inclusão de rota que altera status de uma competição e que busca vencedores de uma determinada competição.
parent 0f10abd6
Show whitespace changes
Inline Side-by-side
Showing with 216 additions and 153 deletions
Api/Competition.Adm.API.yaml
View file @ 313e1555
......@@ -38,24 +38,68 @@ tags:
- name: exams
description: 'Exam operations'
- name: assignment
description: 'Assignments information'
description: 'Information from a assessment assignment'
paths:
# Competition
/competition:
get:
tags:
tags:s
- competition
summary: Retrieves information about this competition
description: Retrieves information about this competition.
responses:
'200':
description: ''
description: 'Object json containing competition information'
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.json#/Competition'
/competition/{competitionId}/status:
patch:
tags:
- competition
summary: Updates the competition status
description: Updates the competition status
requestBody:
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.json#/Competition'
required: true
responses:
'200':
description: Object json containing competition information
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.json#/Competition'
parameters:
- name: competitionId
in: path
description: The unique identifier of the application.
required: true
schema:
format: int32
type: integer
/competition/winners:
get:
tags:
- competition
summary: Retrieves all competition winners
description: Retrieves all competition winners
responses:
'200':
description: 'Array of object json with competition winners information'
content:
application/json:
schema:
type: array
items:
oneOf:
- $ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.json#/Winner'
# Competifiers
/competifiers:
get:
......@@ -65,7 +109,7 @@ paths:
description: Retrieves all Competifiers for this competition.
responses:
'200':
description: ''
description: 'Array of object json containing competifiers information.'
content:
application/json:
schema:
......@@ -83,7 +127,7 @@ paths:
summary: Retrieves the subscription rule
responses:
'200':
description: ''
description: 'Object json containing subscription information'
content:
application/json:
schema:
......@@ -106,7 +150,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing information from updated subscription'
content:
application/json:
schema:
......@@ -121,7 +165,7 @@ paths:
summary: Retrieves the participant form template
responses:
'200':
description: ''
description: 'Object json containing form template information'
content:
application/json:
schema:
......@@ -138,7 +182,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing updated subscription'
content:
application/json:
schema:
......@@ -150,7 +194,7 @@ paths:
summary: Retrieves the team form template
responses:
'200':
description: ''
description: 'Object json containing subscription information'
content:
application/json:
schema:
......@@ -167,7 +211,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing information from updated subscription'
content:
application/json:
schema:
......@@ -182,7 +226,7 @@ paths:
description: Retrieves all submissions for this competition.
responses:
'200':
description: ''
description: 'Array of object json containing all subscription submission information'
content:
application/json:
schema:
......@@ -199,7 +243,7 @@ paths:
description: Retrieves a subscription with the given id.
responses:
'200':
description: ''
description: 'Object json containing data from specific submission'
content:
application/json:
schema:
......@@ -232,7 +276,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing submission updated'
content:
application/json:
schema:
......@@ -252,10 +296,10 @@ paths:
get:
tags:
- submissions
summary: Retrieves all invitagions from submission
summary: Retrieves all invitations from submission
responses:
'200':
description: ''
description: 'Array of object json containing invitation data'
content:
application/json:
schema:
......@@ -274,10 +318,10 @@ paths:
get:
tags:
- submissions
summary: Retrieves all invitagions from submission
summary: Retrieves specific submission invitation
responses:
'200':
description: ''
description: 'Object json containing invitation information'
content:
application/json:
schema:
......@@ -307,7 +351,7 @@ paths:
description: Retrieves all Exams for this competition.
responses:
'200':
description: ''
description: 'Array of object json containing exam information.'
content:
application/json:
schema:
......@@ -340,7 +384,7 @@ paths:
description: Retrieves the specified Exam.
responses:
'200':
description: ''
description: 'Object json containing exam information'
content:
application/json:
schema:
......@@ -358,7 +402,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing information from updated exam'
content:
application/json:
schema:
......@@ -370,11 +414,11 @@ paths:
description: Delete an exam.
responses:
'200':
description: ''
description: 'Success indication in operation'
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.json#/Exam'
type: boolean
parameters:
- name: examId
in: path
......@@ -463,7 +507,7 @@ paths:
description: Retrieves the specified Question of the Exam.
responses:
'200':
description: ''
description: 'Object json containing information from specific question'
content:
application/json:
schema:
......@@ -531,7 +575,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing information from question answer.'
content:
application/json:
schema:
......@@ -562,7 +606,7 @@ paths:
description: Retrieves all question groups of a exam
responses:
'200':
description: ''
description: 'Array of object Json with question group information'
content:
application/json:
schema:
......@@ -604,7 +648,7 @@ paths:
description: Retrieves a specific question of a exam
responses:
'200':
description: ''
description: 'Object json containing question group information'
content:
application/json:
schema:
......@@ -622,7 +666,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing question group information'
content:
application/json:
schema:
......@@ -634,11 +678,11 @@ paths:
description: Delete a question group of a exam.
responses:
'200':
description: ''
description: 'Indication of success in operation'
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.json#/QuestionGroup'
type: boolean
parameters:
- name: examId
in: path
......@@ -663,7 +707,7 @@ paths:
summary: Retrieves all phases for the competition
responses:
'200':
description: ''
description: 'Array of object json containg phase information'
content:
application/json:
schema:
......@@ -693,7 +737,7 @@ paths:
summary: Retrieves a specific phase of this competition
responses:
'200':
description: ''
description: 'Object json containing phase information'
content:
application/json:
schema:
......@@ -710,7 +754,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing phase information.'
content:
application/json:
schema:
......@@ -721,11 +765,11 @@ paths:
summary: Deletes a specific phase of this competition
responses:
'200':
description: ''
description: 'Indication of success in operation'
content:
application/json:
schema:
$ref: 'https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.json#/Phase'
type: boolean
parameters:
- name: phaseId
in: path
......@@ -749,7 +793,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json containing classification information'
content:
application/json:
schema:
......@@ -797,7 +841,7 @@ paths:
summary: Retrieves all phase events
responses:
'200':
description: ''
description: 'Array of object json with information from all phase events.'
content:
application/json:
schema:
......@@ -819,7 +863,7 @@ paths:
summary: Retrieves all assessments
responses:
'200':
description: ''
description: 'Array of object json with information from all phase assessments.'
content:
application/json:
schema:
......@@ -865,7 +909,7 @@ paths:
summary: Retrieves the last Ranking for the Phase
responses:
'200':
description: ''
description: 'Array of object json with all ranking from specific phase.'
content:
application/json:
schema:
......@@ -886,7 +930,7 @@ paths:
summary: Retrieves all Evaluations for the Phase
responses:
'200':
description: ''
description: 'Array of object json with phase evaluation information'
content:
application/json:
schema:
......@@ -924,7 +968,7 @@ paths:
summary: Retrieves all Participations for the Phase
responses:
'200':
description: ''
description: 'Array of object json with phase participation information'
content:
application/json:
schema:
......@@ -945,7 +989,7 @@ paths:
summary: Retrieves the specific Participation
responses:
'200':
description: ''
description: 'Object json with information from specific phase participation'
content:
application/json:
schema:
......@@ -993,7 +1037,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json with phase information'
content:
application/json:
schema:
......@@ -1021,7 +1065,7 @@ paths:
required: true
responses:
'200':
description: ''
description: 'Object json with information from specific assessment.'
content:
application/json:
schema:
......@@ -1041,7 +1085,7 @@ paths:
summary: Retrieves all submissions
responses:
'200':
description: ''
description: 'Array of object json with submissions from specific assessment'
content:
application/json:
schema:
......@@ -1064,7 +1108,7 @@ paths:
summary: Retrieves the specific submission
responses:
'200':
description: ''
description: 'Object Json containing submission information'
content:
application/json:
schema:
......@@ -1092,7 +1136,7 @@ paths:
summary: Retrieve all assignment from assessment
responses:
'200':
description: ''
description: 'Object Json containing all assignment from specific assessment'
content:
application/json:
schema:
......@@ -1114,7 +1158,7 @@ paths:
summary: Retrieves all assignments for the assessment.
responses:
'200':
description: ''
description: 'Array of object Json with assignments information'
content:
application/json:
schema:
......@@ -1128,7 +1172,7 @@ paths:
summary: Retrieves a specific assignment.
responses:
'200':
description: ''
description: 'Object Json with a specific assignment'
content:
application/json:
schema:
......@@ -1147,7 +1191,7 @@ paths:
summary: Retrives all submissions from specific assignment
responses:
'200':
description: ''
description: 'Array of object Json with information of a specific assignment.'
content:
application/json:
schema:
......@@ -1168,7 +1212,7 @@ paths:
summary: Retrieve a specific submission from assignment
responses:
'200':
description: ''
description: 'Object json with submission information.'
content:
application/json:
schema:
......
Api/components/schemas.json
View file @ 313e1555
......@@ -160,6 +160,8 @@
},
"Assignment":{
"$ref": "https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Assessment.json#/Assignment"
},
"Winner":{
"$ref": "https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Competition.json#/Winner"
}
}
\ No newline at end of file
Api/components/schemas.yaml
View file @ 313e1555
......@@ -160,3 +160,6 @@ Submission:
Subscription:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Subscription.json/#/Subscription
Winner:
$ref: >-
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas/Competition.json/#/Winner
\ No newline at end of file
Api/components/schemas/Competition.json
View file @ 313e1555
......@@ -21,7 +21,8 @@
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
"INACTIVE",
"FINISHED"
]
},
"subscription": {
......@@ -55,5 +56,18 @@
]
}
}
},
"Winner": {
"required": [
"id",
"position",
"competition",
"competifier"
],
"properties":{
"position": "integer",
"competition": "integer",
"competifier": "integer"
}
}
}
\ No newline at end of file
uml/Competify.mdj
View file @ 313e1555
......@@ -62456,9 +62456,9 @@
},
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 941,
"left": 933,
"top": 517,
"width": 115.552734375,
"width": 119,
"height": 13,
"text": "«enum»"
},
......@@ -62470,9 +62470,9 @@
},
"fillColor": "#c082ff",
"font": "Arial;13;1",
"left": 941,
"left": 933,
"top": 532,
"width": 115.552734375,
"width": 119,
"height": 13,
"text": "CompetitionStatus"
},
......@@ -62485,7 +62485,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 194,
"left": 178,
"top": 650,
"width": 107.63720703125,
"height": 13,
......@@ -62500,7 +62500,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 194,
"left": 178,
"top": 650,
"height": 13,
"horizontalAlignment": 1
......@@ -62508,9 +62508,9 @@
],
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 936,
"left": 928,
"top": 512,
"width": 125.552734375,
"width": 129,
"height": 38,
"stereotypeLabel": {
"$ref": "AAAAAAFj+TuyIJVUEpk="
......@@ -62546,9 +62546,9 @@
},
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 941,
"left": 933,
"top": 555,
"width": 115.552734375,
"width": 119,
"height": 13,
"text": "+label: String",
"horizontalAlignment": 0
......@@ -62556,9 +62556,9 @@
],
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 936,
"left": 928,
"top": 550,
"width": 125.552734375,
"width": 129,
"height": 23
},
{
......@@ -62572,9 +62572,9 @@
},
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 936,
"left": 928,
"top": 573,
"width": 125.552734375,
"width": 129,
"height": 10
},
{
......@@ -62589,7 +62589,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 97,
"left": 89,
"top": 325,
"width": 10,
"height": 10
......@@ -62606,7 +62606,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 97,
"left": 89,
"top": 325,
"width": 10,
"height": 10
......@@ -62615,9 +62615,9 @@
"fillColor": "#c082ff",
"font": "Arial;13;0",
"containerChangeable": true,
"left": 936,
"left": 928,
"top": 512,
"width": 125.552734375,
"width": 129,
"height": 71,
"nameCompartment": {
"$ref": "AAAAAAFj+TuyIJVTOFQ="
......@@ -64985,7 +64985,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": -192,
"left": -224,
"top": 64,
"height": 13
},
......@@ -64997,7 +64997,7 @@
},
"fillColor": "#c082ff",
"font": "Arial;13;1",
"left": 733,
"left": 717,
"top": 191,
"width": 103,
"height": 13,
......@@ -65012,7 +65012,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": -192,
"left": -224,
"top": 64,
"width": 107.63720703125,
"height": 13,
......@@ -65027,7 +65027,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": -192,
"left": -224,
"top": 64,
"height": 13,
"horizontalAlignment": 1
......@@ -65035,7 +65035,7 @@
],
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 728,
"left": 712,
"top": 184,
"width": 113,
"height": 25,
......@@ -65073,17 +65073,17 @@
},
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 733,
"left": 717,
"top": 214,
"width": 103,
"height": 13,
"text": "+Position: Integer",
"text": "+position: Integer",
"horizontalAlignment": 0
}
],
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 728,
"left": 712,
"top": 209,
"width": 113,
"height": 23
......@@ -65099,7 +65099,7 @@
},
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": 728,
"left": 712,
"top": 232,
"width": 113,
"height": 10
......@@ -65116,7 +65116,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": -96,
"left": -112,
"top": 32,
"width": 10,
"height": 10
......@@ -65133,7 +65133,7 @@
"visible": false,
"fillColor": "#c082ff",
"font": "Arial;13;0",
"left": -96,
"left": -112,
"top": 32,
"width": 10,
"height": 10
......@@ -65142,7 +65142,7 @@
"fillColor": "#c082ff",
"font": "Arial;13;0",
"containerChangeable": true,
"left": 728,
"left": 712,
"top": 184,
"width": 113,
"height": 65,
......@@ -65183,7 +65183,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 765,
"left": 753,
"top": 299,
"height": 13,
"alpha": 1.5707963267948966,
......@@ -65204,7 +65204,7 @@
},
"visible": null,
"font": "Arial;13;0",
"left": 750,
"left": 738,
"top": 299,
"height": 13,
"alpha": 1.5707963267948966,
......@@ -65225,7 +65225,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 794,
"left": 782,
"top": 300,
"height": 13,
"alpha": -1.5707963267948966,
......@@ -65245,7 +65245,7 @@
"$ref": "AAAAAAFkqEa0XYlL71M="
},
"font": "Arial;13;0",
"left": 759,
"left": 747,
"top": 320,
"width": 74.07080078125,
"height": 13,
......@@ -65268,7 +65268,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 751,
"left": 739,
"top": 329,
"height": 13,
"alpha": 0.7853981633974483,
......@@ -65288,7 +65288,7 @@
"$ref": "AAAAAAFkqEa0XYlL71M="
},
"font": "Arial;13;0",
"left": 784,
"left": 772,
"top": 344,
"width": 7.22998046875,
"height": 13,
......@@ -65310,7 +65310,7 @@
"$ref": "AAAAAAFkqEa0XYlMFR0="
},
"font": "Arial;13;0",
"left": 719,
"left": 707,
"top": 256,
"width": 52.38720703125,
"height": 13,
......@@ -65332,7 +65332,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 751,
"left": 739,
"top": 270,
"height": 13,
"alpha": -0.7853981633974483,
......@@ -65351,7 +65351,7 @@
"$ref": "AAAAAAFkqEa0XYlMFR0="
},
"font": "Arial;13;0",
"left": 784,
"left": 772,
"top": 255,
"width": 21.68359375,
"height": 13,
......@@ -65398,7 +65398,7 @@
"tail": {
"$ref": "AAAAAAFj+TuoZpUlJgY="
},
"points": "780:364;780:248",
"points": "768:364;768:248",
"showVisibility": true,
"nameLabel": {
"$ref": "AAAAAAFkqEa0XYlPyhI="
......@@ -65902,7 +65902,7 @@
"visible": false,
"font": "Arial;13;0",
"left": 1087,
"top": 385,
"top": 377,
"height": 13,
"alpha": 1.5707963267948966,
"distance": 15,
......@@ -65923,7 +65923,7 @@
"visible": null,
"font": "Arial;13;0",
"left": 1087,
"top": 400,
"top": 392,
"height": 13,
"alpha": 1.5707963267948966,
"distance": 30,
......@@ -65944,7 +65944,7 @@
"visible": false,
"font": "Arial;13;0",
"left": 1088,
"top": 355,
"top": 347,
"height": 13,
"alpha": -1.5707963267948966,
"distance": 15,
......@@ -66032,8 +66032,8 @@
"top": 375,
"width": 74.07080078125,
"height": 13,
"alpha": -0.14888991093468956,
"distance": 40.44749683231337,
"alpha": -0.3366747414357423,
"distance": 42.37924020083418,
"hostEdge": {
"$ref": "AAAAAAFkqEkClpAZH0k="
},
......@@ -66051,7 +66051,7 @@
"visible": false,
"font": "Arial;13;0",
"left": 856,
"top": 398,
"top": 390,
"height": 13,
"alpha": -0.7853981633974483,
"distance": 40,
......@@ -66070,7 +66070,7 @@
},
"font": "Arial;13;0",
"left": 846,
"top": 357,
"top": 349,
"width": 7.22998046875,
"height": 13,
"alpha": 0.5235987755982988,
......@@ -66116,7 +66116,7 @@
"tail": {
"$ref": "AAAAAAFkqEkCkpADdD4="
},
"points": "1088:240;1088:376;828:376",
"points": "1088:240;1088:368;828:368",
"showVisibility": true,
"nameLabel": {
"$ref": "AAAAAAFkqEkClpAaWE4="
......@@ -66173,7 +66173,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 941,
"left": 933,
"top": 187,
"height": 13,
"alpha": 1.5707963267948966,
......@@ -66194,7 +66194,7 @@
},
"visible": null,
"font": "Arial;13;0",
"left": 941,
"left": 933,
"top": 172,
"height": 13,
"alpha": 1.5707963267948966,
......@@ -66215,7 +66215,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 941,
"left": 933,
"top": 217,
"height": 13,
"alpha": -1.5707963267948966,
......@@ -66236,7 +66236,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 865,
"left": 849,
"top": 187,
"height": 13,
"alpha": 0.5235987755982988,
......@@ -66257,7 +66257,7 @@
},
"visible": false,
"font": "Arial;13;0",
"left": 868,
"left": 852,
"top": 173,
"height": 13,
"alpha": 0.7853981633974483,
......@@ -66277,7 +66277,7 @@
"$ref": "AAAAAAFkqFXMraXziTo="
},
"font": "Arial;13;0",
"left": 852,
"left": 836,
"top": 214,
"width": 19.5126953125,
"height": 13,
......@@ -66387,7 +66387,7 @@
"tail": {
"$ref": "AAAAAAFkqD84goI6eZQ="
},
"points": "840:208;1042:208",
"points": "824:208;1042:208",
"showVisibility": true,
"nameLabel": {
"$ref": "AAAAAAFkqFXMrqX3gd4="
......@@ -66720,7 +66720,7 @@
"_parent": {
"$ref": "AAAAAAFkqD84fYI4uOw="
},
"name": "Position",
"name": "position",
"type": "Integer"
}
]
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