1
0
forked from PGL/Clyde

Modification via les révisions

This commit is contained in:
Wal 2023-12-12 11:39:18 +01:00
parent 93ec63beae
commit ffc8682453

View File

@ -57,13 +57,6 @@ paths:
- Users - Users
security: security:
- bearer: [] - bearer: []
parameters:
- in: query
name: type
required: false
schema:
type: string
enum: [teacher, student, secretary]
responses: responses:
'200': '200':
description: Ok description: Ok
@ -248,7 +241,6 @@ paths:
faculty: faculty:
type: string type: string
teachers: teachers:
type: object
$ref: '#/components/schemas/User' $ref: '#/components/schemas/User'
assistants: assistants:
type: array type: array
@ -352,7 +344,6 @@ paths:
faculty: faculty:
type: string type: string
teachers: teachers:
type: object
$ref: '#/components/schemas/User' $ref: '#/components/schemas/User'
assistants: assistants:
type: array type: array
@ -377,7 +368,7 @@ paths:
summary: Create a new lesson summary: Create a new lesson
tags: tags:
- Secretariat - Secretariat
- lesson - Lesson
- Ext (Schedule) - Ext (Schedule)
security: security:
- bearer: [] - bearer: []
@ -391,7 +382,7 @@ paths:
date: date:
type: string type: string
description: Follow the iso 8601 ("YYYY-MM-DD") description: Follow the iso 8601 ("YYYY-MM-DD")
IDcourse: CourseId:
type: integer type: integer
duration: duration:
type: number type: number
@ -413,7 +404,7 @@ paths:
summary : See lesson's informations summary : See lesson's informations
tags: tags:
- Users - Users
- lesson - Lesson
- Ext (Schedule) - Ext (Schedule)
responses: responses:
'200': '200':
@ -426,7 +417,7 @@ paths:
summary : Modify Lesson summary : Modify Lesson
tags: tags:
- Secretariat - Secretariat
- lesson - Lesson
- Ext (Schedule) - Ext (Schedule)
security: security:
- bearer: [] - bearer: []
@ -455,7 +446,7 @@ paths:
delete: delete:
summary: Delete lesson summary: Delete lesson
tags: tags:
- lesson - Lesson
- Secretariat - Secretariat
- Ext (Schedule) - Ext (Schedule)
security: security:
@ -465,12 +456,12 @@ paths:
description: Success description: Success
'401': '401':
$ref: '#/components/responses/UnauthorizedError' $ref: '#/components/responses/UnauthorizedError'
/request: /scheduleRequest:
post: post:
summary: Create a new request summary: Create a new request
tags: tags:
- Teacher - Teacher
- request - ScheduleRequest
- Ext (Schedule) - Ext (Schedule)
requestBody: requestBody:
required: true required: true
@ -479,16 +470,24 @@ paths:
schema: schema:
type: object type: object
properties: properties:
id:
type: integer
requestType: requestType:
type: string type: string
lessonId: lessonId:
type: integer type: integer
newDate:
type: string
description: Follow the iso 8601 ("YYYY-MM-DD")
newClassroom:
type: string
newCourseId:
type: integer
responses: responses:
'201': '201':
description: Request created description: Request created
/request/{id}: '401':
$ref: '#/components/responses/UnauthorizedError'
/scheduleRequest/{id}:
parameters: parameters:
- name: id - name: id
in: path in: path
@ -500,7 +499,7 @@ paths:
tags: tags:
- Teacher - Teacher
- Secretariat - Secretariat
- request - ScheduleRequest
- Ext (Schedule) - Ext (Schedule)
responses: responses:
'200': '200':
@ -513,7 +512,7 @@ paths:
summary : Modify request summary : Modify request
tags: tags:
- Teacher - Teacher
- request - ScheduleRequest
- Ext (Schedule) - Ext (Schedule)
requestBody: requestBody:
required: true required: true
@ -522,11 +521,11 @@ paths:
schema: schema:
type: object type: object
properties: properties:
id: newDate:
type: integer
requestType:
type: string type: string
lessonId: newClassroom:
type: string
newCourseId:
type: integer type: integer
responses: responses:
'201': '201':
@ -536,7 +535,7 @@ paths:
tags: tags:
- Teacher - Teacher
- Secretariat - Secretariat
- request - ScheduleRequest
- Ext (Schedule) - Ext (Schedule)
responses: responses:
'201': '201':
@ -546,7 +545,7 @@ paths:
post: post:
summary: Create a new display summary: Create a new display
tags: tags:
- display - Display
- Ext (Schedule) - Ext (Schedule)
requestBody: requestBody:
required: true required: true
@ -555,11 +554,9 @@ paths:
schema: schema:
type: object type: object
properties: properties:
id: timeMode:
type: integer
time:
type: string type: string
display: displayMode:
type: string type: string
userId: userId:
type: integer type: integer
@ -578,7 +575,7 @@ paths:
summary : See display information summary : See display information
tags: tags:
- Users - Users
- display - Display
- Ext (Schedule) - Ext (Schedule)
responses: responses:
'200': '200':
@ -591,7 +588,7 @@ paths:
summary : Modify display summary : Modify display
tags: tags:
- Users - Users
- display - Display
- Ext (Schedule) - Ext (Schedule)
requestBody: requestBody:
required: true required: true
@ -600,14 +597,10 @@ paths:
schema: schema:
type: object type: object
properties: properties:
id: timeMode:
type: integer
time:
type: string type: string
display: displayMode:
type: string type: string
userId:
type: integer
responses: responses:
'201': '201':
description: Display modified description: Display modified
@ -718,15 +711,16 @@ components:
description: duration of a course in hours description: duration of a course in hours
classroom: classroom:
type: string type: string
course: courseId:
$ref: "#/components/schemas/Course" type: integer
example: example:
{ {
"id": 12, "id": 12,
"date": "2023-12-01", "date": "2023-12-01",
"duration": 1.5, "duration": 1.5,
"classroom": "AMPHI01", "classroom": "AMPHI01",
"course": } "courseId": 12
}
ScheduleRequest: ScheduleRequest:
type: object type: object
properties: properties:
@ -736,7 +730,6 @@ components:
type: string type: string
lessonId: lessonId:
type: integer type: integer
description: In the ADD case, lessonId is null
teacherId: teacherId:
type: integer type: integer
newDate: newDate:
@ -744,10 +737,8 @@ components:
description: Follow the iso 8601 ("YYYY-MM-DD") description: Follow the iso 8601 ("YYYY-MM-DD")
newClassroom: newClassroom:
type: string type: string
newCourse: newCourseId:
type: string type: integer
description: In the ADD case, correspond to the name of the course to add
example: example:
{ {
"id": 12, "id": 12,
@ -756,7 +747,7 @@ components:
"teacherId": 12, "teacherId": 12,
"newDate": "2023-12-20", "newDate": "2023-12-20",
"newClassroom":, "newClassroom":,
"newCourse":, "newCourseId":,
} }
Display: Display:
@ -764,10 +755,10 @@ components:
properties: properties:
id: id:
type: integer type: integer
time: timeMode:
type: string type: string
description: Define the period displayed on the schedule (week,month,quadrimester..) description: Define the period displayed on the schedule (week,month,quadrimester..)
display: displayMode:
type: string type: string
userId: userId:
type: integer type: integer
@ -775,8 +766,8 @@ components:
example: example:
{ {
"id": 12, "id": 12,
"time": "month", "timeMode": "month",
"display": "grid", "displayMode": "grid",
"UserId": 12 "UserId": 12
} }
responses: responses: