Compare commits
No commits in common. "b2db8eec16617d81b43cdb655337b9663a3e3679" and "b00ab090797b8dbad7346f2c906cafcaa5bcd825" have entirely different histories.
b2db8eec16
...
b00ab09079
@ -1,9 +1,7 @@
|
|||||||
openapi: 3.0.0
|
openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: ClydeAPI
|
title: ClydeAPI
|
||||||
description:
|
description: Clyde's api
|
||||||
This is the Clyde's api documentation. <br/>
|
|
||||||
Each endpoints are organised by endpoints **AND** by extensions making it easier to navigate.
|
|
||||||
version: 0.0.1
|
version: 0.0.1
|
||||||
|
|
||||||
servers:
|
servers:
|
||||||
@ -26,7 +24,6 @@ paths:
|
|||||||
get:
|
get:
|
||||||
summary: list all users
|
summary: list all users
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- SI
|
- SI
|
||||||
security:
|
security:
|
||||||
- bearer: []
|
- bearer: []
|
||||||
@ -53,17 +50,7 @@ paths:
|
|||||||
get:
|
get:
|
||||||
summary: get informations about yourself
|
summary: get informations about yourself
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Users
|
- Users
|
||||||
security:
|
|
||||||
- bearer: []
|
|
||||||
parameters:
|
|
||||||
- in: query
|
|
||||||
name: type
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
enum: [teacher, student, secretary]
|
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Ok
|
description: Ok
|
||||||
@ -71,12 +58,9 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/User"
|
$ref: "#/components/schemas/User"
|
||||||
'401':
|
|
||||||
$ref: '#/components/responses/UnauthorizedError'
|
|
||||||
post:
|
post:
|
||||||
summary: Create user
|
summary: Create user
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Users
|
- Users
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
@ -114,7 +98,6 @@ paths:
|
|||||||
patch:
|
patch:
|
||||||
summary: Change informations about yourself
|
summary: Change informations about yourself
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Users
|
- Users
|
||||||
security:
|
security:
|
||||||
- bearer: []
|
- bearer: []
|
||||||
@ -140,7 +123,6 @@ paths:
|
|||||||
get:
|
get:
|
||||||
summary: Get user's informations
|
summary: Get user's informations
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Admin
|
- Admin
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
@ -152,7 +134,6 @@ paths:
|
|||||||
patch:
|
patch:
|
||||||
summary: Alter user's informations
|
summary: Alter user's informations
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Admin
|
- Admin
|
||||||
security:
|
security:
|
||||||
- bearer: []
|
- bearer: []
|
||||||
@ -171,7 +152,6 @@ paths:
|
|||||||
post:
|
post:
|
||||||
summary: Create new course
|
summary: Create new course
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Courses
|
- Courses
|
||||||
- Secretariat
|
- Secretariat
|
||||||
security:
|
security:
|
||||||
@ -198,7 +178,6 @@ paths:
|
|||||||
get:
|
get:
|
||||||
summary: see courses informations
|
summary: see courses informations
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Courses
|
- Courses
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
@ -216,7 +195,6 @@ paths:
|
|||||||
delete:
|
delete:
|
||||||
summary: delete a course
|
summary: delete a course
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Courses
|
- Courses
|
||||||
- Secretariat
|
- Secretariat
|
||||||
security:
|
security:
|
||||||
@ -229,7 +207,6 @@ paths:
|
|||||||
patch:
|
patch:
|
||||||
summary: Change course options
|
summary: Change course options
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- Secretariat
|
- Secretariat
|
||||||
- Courses
|
- Courses
|
||||||
security:
|
security:
|
||||||
@ -272,7 +249,6 @@ paths:
|
|||||||
post:
|
post:
|
||||||
summary: Create a cursus
|
summary: Create a cursus
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- cursus
|
- cursus
|
||||||
security:
|
security:
|
||||||
- bearer: []
|
- bearer: []
|
||||||
@ -304,7 +280,6 @@ paths:
|
|||||||
get:
|
get:
|
||||||
summary: See Cursus's informations
|
summary: See Cursus's informations
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- cursus
|
- cursus
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
@ -322,7 +297,6 @@ paths:
|
|||||||
delete:
|
delete:
|
||||||
summary: Delete cursus
|
summary: Delete cursus
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- cursus
|
- cursus
|
||||||
security:
|
security:
|
||||||
- bearer: []
|
- bearer: []
|
||||||
@ -334,7 +308,6 @@ paths:
|
|||||||
patch:
|
patch:
|
||||||
summary: Modify cursus
|
summary: Modify cursus
|
||||||
tags:
|
tags:
|
||||||
- General
|
|
||||||
- cursus
|
- cursus
|
||||||
security:
|
security:
|
||||||
- bearer: []
|
- bearer: []
|
||||||
@ -632,7 +605,7 @@ components:
|
|||||||
"firstName": "John",
|
"firstName": "John",
|
||||||
"email": "John.Doe@example.com",
|
"email": "John.Doe@example.com",
|
||||||
"address": {
|
"address": {
|
||||||
"address": "Rue de Tournais 42",
|
"address": "Rue de Tounais 42",
|
||||||
"country": "BE"},
|
"country": "BE"},
|
||||||
"birthDate": "1941-02-22",
|
"birthDate": "1941-02-22",
|
||||||
"staffMember": true,
|
"staffMember": true,
|
||||||
@ -647,7 +620,7 @@ components:
|
|||||||
description: Follow the ISO-3166-1 alpha-2 standard.
|
description: Follow the ISO-3166-1 alpha-2 standard.
|
||||||
example:
|
example:
|
||||||
{
|
{
|
||||||
"address": "Rue de Tournais 42",
|
"address": "Rue de Tounais 42",
|
||||||
"country": "BE"
|
"country": "BE"
|
||||||
}
|
}
|
||||||
Course:
|
Course:
|
||||||
|
Loading…
Reference in New Issue
Block a user