1
0
forked from PGL/Clyde

Merge branch 'master' into GestionHoraire

This commit is contained in:
Wawilski 2023-12-11 11:02:29 +01:00
commit b2db8eec16

View File

@ -1,7 +1,9 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: ClydeAPI 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 version: 0.0.1
servers: servers:
@ -24,6 +26,7 @@ paths:
get: get:
summary: list all users summary: list all users
tags: tags:
- General
- SI - SI
security: security:
- bearer: [] - bearer: []
@ -50,7 +53,17 @@ 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
@ -58,9 +71,12 @@ 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
@ -98,6 +114,7 @@ paths:
patch: patch:
summary: Change informations about yourself summary: Change informations about yourself
tags: tags:
- General
- Users - Users
security: security:
- bearer: [] - bearer: []
@ -123,6 +140,7 @@ paths:
get: get:
summary: Get user's informations summary: Get user's informations
tags: tags:
- General
- Admin - Admin
responses: responses:
'200': '200':
@ -134,6 +152,7 @@ paths:
patch: patch:
summary: Alter user's informations summary: Alter user's informations
tags: tags:
- General
- Admin - Admin
security: security:
- bearer: [] - bearer: []
@ -152,6 +171,7 @@ paths:
post: post:
summary: Create new course summary: Create new course
tags: tags:
- General
- Courses - Courses
- Secretariat - Secretariat
security: security:
@ -178,6 +198,7 @@ paths:
get: get:
summary: see courses informations summary: see courses informations
tags: tags:
- General
- Courses - Courses
responses: responses:
'200': '200':
@ -195,6 +216,7 @@ paths:
delete: delete:
summary: delete a course summary: delete a course
tags: tags:
- General
- Courses - Courses
- Secretariat - Secretariat
security: security:
@ -207,6 +229,7 @@ paths:
patch: patch:
summary: Change course options summary: Change course options
tags: tags:
- General
- Secretariat - Secretariat
- Courses - Courses
security: security:
@ -249,6 +272,7 @@ paths:
post: post:
summary: Create a cursus summary: Create a cursus
tags: tags:
- General
- cursus - cursus
security: security:
- bearer: [] - bearer: []
@ -280,6 +304,7 @@ paths:
get: get:
summary: See Cursus's informations summary: See Cursus's informations
tags: tags:
- General
- cursus - cursus
responses: responses:
'200': '200':
@ -297,6 +322,7 @@ paths:
delete: delete:
summary: Delete cursus summary: Delete cursus
tags: tags:
- General
- cursus - cursus
security: security:
- bearer: [] - bearer: []
@ -308,6 +334,7 @@ paths:
patch: patch:
summary: Modify cursus summary: Modify cursus
tags: tags:
- General
- cursus - cursus
security: security:
- bearer: [] - bearer: []
@ -605,7 +632,7 @@ components:
"firstName": "John", "firstName": "John",
"email": "John.Doe@example.com", "email": "John.Doe@example.com",
"address": { "address": {
"address": "Rue de Tounais 42", "address": "Rue de Tournais 42",
"country": "BE"}, "country": "BE"},
"birthDate": "1941-02-22", "birthDate": "1941-02-22",
"staffMember": true, "staffMember": true,
@ -620,7 +647,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 Tounais 42", "address": "Rue de Tournais 42",
"country": "BE" "country": "BE"
} }
Course: Course: