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