Compare commits

...

2 Commits

Author SHA1 Message Date
f0b2c31a06
Adding all endpoint to "general" tag 2023-12-10 21:26:51 +01:00
b50e0db3fc
small changes 2023-12-10 21:21:11 +01:00

View File

@ -1,7 +1,9 @@
openapi: 3.0.0
info:
title: ClydeAPI
description: Clyde's api
description:
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
servers:
@ -24,6 +26,7 @@ paths:
get:
summary: list all users
tags:
- General
- SI
security:
- bearer: []
@ -50,7 +53,10 @@ paths:
get:
summary: get informations about yourself
tags:
- General
- Users
security:
- bearer: []
responses:
'200':
description: Ok
@ -58,9 +64,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/User"
'401':
$ref: '#/components/responses/UnauthorizedError'
post:
summary: Create user
tags:
- General
- Users
requestBody:
required: true
@ -98,6 +107,7 @@ paths:
patch:
summary: Change informations about yourself
tags:
- General
- Users
security:
- bearer: []
@ -123,6 +133,7 @@ paths:
get:
summary: Get user's informations
tags:
- General
- Admin
responses:
'200':
@ -134,6 +145,7 @@ paths:
patch:
summary: Alter user's informations
tags:
- General
- Admin
security:
- bearer: []
@ -152,6 +164,7 @@ paths:
post:
summary: Create new course
tags:
- General
- Courses
- Secretariat
security:
@ -178,6 +191,7 @@ paths:
get:
summary: see courses informations
tags:
- General
- Courses
responses:
'200':
@ -195,6 +209,7 @@ paths:
delete:
summary: delete a course
tags:
- General
- Courses
- Secretariat
security:
@ -207,6 +222,7 @@ paths:
patch:
summary: Change course options
tags:
- General
- Secretariat
- Courses
security:
@ -249,6 +265,7 @@ paths:
post:
summary: Create a cursus
tags:
- General
- cursus
security:
- bearer: []
@ -280,6 +297,7 @@ paths:
get:
summary: See Cursus's informations
tags:
- General
- cursus
responses:
'200':
@ -297,6 +315,7 @@ paths:
delete:
summary: Delete cursus
tags:
- General
- cursus
security:
- bearer: []
@ -308,6 +327,7 @@ paths:
patch:
summary: Modify cursus
tags:
- General
- cursus
security:
- bearer: []
@ -377,7 +397,7 @@ components:
"firstName": "John",
"email": "John.Doe@example.com",
"address": {
"address": "Rue de Tounais 42",
"address": "Rue de Tournais 42",
"country": "BE"},
"birthDate": "1941-02-22",
"staffMember": true,
@ -392,7 +412,7 @@ components:
description: Follow the ISO-3166-1 alpha-2 standard.
example:
{
"address": "Rue de Tounais 42",
"address": "Rue de Tournais 42",
"country": "BE"
}
Course: