diff --git a/Documents/proto/general/openapi.yaml b/Documents/proto/general/openapi.yaml index 5054813..fb6ded7 100644 --- a/Documents/proto/general/openapi.yaml +++ b/Documents/proto/general/openapi.yaml @@ -35,8 +35,7 @@ paths: name: type required: false schema: - type: string - enum: [teacher, student, secretary] + $ref: '#components/schemas/Roles' responses: '200': description: OK @@ -89,6 +88,8 @@ paths: BirthDate: type: string description: Follow the iso 8601 ("YYYY-MM-DD") + Role: + $ref: "#/components/schemas/Roles" example: { "LastName": "Doe" , @@ -98,6 +99,7 @@ paths: "Address": "Rue de Tournais 42", "Country": "BE"}, "BirthDate": "1941-02-22", + "Role": "student" } responses: '201': @@ -122,6 +124,7 @@ paths: description: Successfully changed. '401': $ref: '#/components/responses/UnauthorizedError' + /user/{mat}: parameters: - name: mat @@ -390,6 +393,8 @@ components: birthDate: type: string description: Follow the iso 8601 ("YYYY-MM-DD") + role: + $ref: '#/components/schemas/Roles' example: { "regNo": 42, @@ -400,7 +405,7 @@ components: "address": "Rue de Tournais 42", "country": "BE"}, "birthDate": "1941-02-22", - "staffMember": true, + "role": "student" } Address: type: object @@ -459,6 +464,10 @@ components: "id": 42, "courses": ['Math', 'Info'] } + Roles: + type: string + enum: [teacher, student, secretary] + responses: UnauthorizedError: description: Unauthorized access or missing bearer