diff --git a/Documents/proto/general/openapi.yaml b/Documents/proto/general/openapi.yaml index 5751404..55e8168 100644 --- a/Documents/proto/general/openapi.yaml +++ b/Documents/proto/general/openapi.yaml @@ -10,6 +10,15 @@ servers: - url: https://clyde.herisson.ovh/api description: default api point for clyde's service +tags: + - name: default + - name: General + description: General endpoints + - name: Ext (scientific articles) + description: Scientifics articles extension's endpoints + - name: Ext (Schedule) + description: Schedule extension's endpoints + paths: /ping: get: @@ -35,8 +44,7 @@ paths: name: type required: false schema: - type: string - enum: [teacher, student, secretary] + $ref: '#components/schemas/Roles' responses: '200': description: OK @@ -89,6 +97,8 @@ paths: BirthDate: type: string description: Follow the iso 8601 ("YYYY-MM-DD") + Role: + $ref: "#/components/schemas/Roles" example: { "LastName": "Doe" , @@ -98,6 +108,7 @@ paths: "Address": "Rue de Tournais 42", "Country": "BE"}, "BirthDate": "1941-02-22", + "Role": "student" } responses: '201': @@ -244,7 +255,8 @@ paths: faculty: type: string teachers: - $ref: '#/components/schemas/User' + type: integer + description: Teacher's identifier assistants: type: array items: @@ -295,8 +307,6 @@ paths: description: Cursus created '401': $ref: '#/components/responses/UnauthorizedError' - - /cursus/{id}: get: summary: See Cursus's informations @@ -691,7 +701,7 @@ paths: required: true content: application/x-www-form-urlencoded: - schema: + schema: type: object properties: timeMode: @@ -912,7 +922,6 @@ paths: items: $ref: "#/components/schemas/DisplayArticle" - components: securitySchemes: bearer: @@ -937,6 +946,8 @@ components: birthDate: type: string description: Follow the iso 8601 ("YYYY-MM-DD") + role: + $ref: '#/components/schemas/Roles' example: { "regNo": 42, @@ -947,7 +958,7 @@ components: "address": "Rue de Tournais 42", "country": "BE"}, "birthDate": "1941-02-22", - "staffMember": true, + "role": "student" } Address: type: object @@ -1006,6 +1017,9 @@ components: "id": 42, "courses": ['Math', 'Info'] } + Roles: + type: string + enum: [teacher, student, secretary] RegRequest: type : object @@ -1218,9 +1232,8 @@ components: } responses: - UnauthorizedError: - description: Unauthorized access or missing bearer - + UnauthorizedError: + description: Unauthorized access or missing bearer