Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Docs
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Registry
Registry
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Competify
Docs
Commits
620bcac8
Commit
620bcac8
authored
Jun 06, 2018
by
Isaac Pereira
Committed by
Isaac Pereira
Jun 06, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[API] Adiciona API do Competify
parent
48d7f20f
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
190 additions
and
0 deletions
+190
-0
Competify.API.yaml
Api/Competify.API.yaml
+190
-0
No files found.
Api/Competify.API.yaml
0 → 100644
View file @
620bcac8
openapi
:
3.0.0
info
:
title
:
Competify API
description
:
>-
Api of the competition administration. This API should be used by the competify
application to control the competition itself
version: 1.0.0
servers
:
-
url
:
http://api.competify.test.evologica.com.br
components
:
securitySchemes
:
bearerAuth
:
# arbitrary name for the security scheme
type
:
http
scheme
:
bearer
bearerFormat
:
JWT
responses
:
UnauthorizedError
:
description
:
Access token is missing or invalid
tags
:
-
name
:
auth
description
:
'
Register
and
authentication'
-
name
:
user
description
:
'
User
operations'
-
name
:
competition
description
:
'
Competition
admin
operations'
-
name
:
assessments
description
:
'
Assessments
operations'
paths
:
/login
:
post
:
tags
:
-
auth
summary
:
Authenticate to retrieve an API auth token
description
:
Retrieves information about this competition
requestBody
:
content
:
application/json
:
schema
:
type
:
object
properties
:
username
:
type
:
string
password
:
type
:
string
required
:
true
responses
:
'
200'
:
description
:
'
Auth
token'
content
:
application/json
:
schema
:
type
:
object
properties
:
token
:
type
:
string
redirectUrl
:
type
:
string
'
401'
:
description
:
'
Authetication
failed'
content
:
application/json
:
schema
:
type
:
string
/register
:
post
:
tags
:
-
auth
summary
:
Register a new admin user
description
:
Register a new admin user
requestBody
:
content
:
application/json
:
schema
:
type
:
object
properties
:
username
:
type
:
string
fullname
:
type
:
string
email
:
type
:
string
password
:
type
:
string
required
:
true
responses
:
'
200'
:
description
:
'
registered
user'
content
:
application/json
:
schema
:
type
:
object
properties
:
id
:
type
:
integer
username
:
type
:
string
fullname
:
type
:
string
email
:
type
:
string
'
422'
:
description
:
'
validation
error'
content
:
application/json
:
schema
:
type
:
string
/competitions
:
get
:
security
:
-
bearerAuth
:
[]
tags
:
-
competition
summary
:
Retrieves user's competition
description
:
Retrieves user's competition.
responses
:
'
200'
:
description
:
'
'
content
:
application/json
:
schema
:
type
:
array
items
:
$ref
:
'
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition'
post
:
security
:
-
bearerAuth
:
[]
tags
:
-
competition
summary
:
Creates a new competition
description
:
Creates a new competition
requestBody
:
content
:
application/json
:
schema
:
type
:
object
oneOf
:
-
$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'
required
:
true
responses
:
'
200'
:
description
:
'
'
content
:
application/json
:
schema
:
type
:
object
oneOf
:
-
$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'
/competitions/{competitionId}
:
get
:
security
:
-
bearerAuth
:
[]
tags
:
-
competition
summary
:
Retrieves an user's specific competition
description
:
Retrieves an user's specific competition.
responses
:
'
200'
:
description
:
'
'
content
:
application/json
:
schema
:
$ref
:
'
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition'
delete
:
security
:
-
bearerAuth
:
[]
tags
:
-
competition
summary
:
Retrieves an user's specific competition
description
:
Retrieves an user's specific competition.
responses
:
'
200'
:
description
:
'
'
content
:
application/json
:
schema
:
$ref
:
'
https://gitlab.dev.evologica.com.br/Competify/Docs/raw/master/Api/components/schemas.yaml/#/Competition'
parameters
:
-
name
:
competitionId
in
:
path
description
:
The unique identifier of the Competition.
required
:
true
schema
:
format
:
int32
type
:
integer
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment