diff --git a/Documents/proto/general/openapi.yaml b/Documents/proto/general/openapi.yaml index 028edc6..3c26c22 100644 --- a/Documents/proto/general/openapi.yaml +++ b/Documents/proto/general/openapi.yaml @@ -286,6 +286,8 @@ paths: description: Nouveau cursus crée '401': $ref: '#/components/responses/UnauthorizedError' + + /cursus/{id}: get: summary: Voir les informations sur un cursus @@ -356,6 +358,68 @@ paths: $ref: '#/components/responses/UnauthorizedError' + /RegRequests: + get : + summary : Get an array of every register requests + tags : + - RegisterRequests + responses : + '200': + description : OK + content : + application/json : + schema : + type : array + items : + $ref : '#/components/schemas/RegRequests' + + + + + + /RegRequest/{id}: + get : + summary : Get all the data composing a register request + tags : + - RegisterRequests + responses : + '200': + description : OK + content : + application/json : + schema : + type : object + properties: + $ref : '#/components/schemas/RegRequest' + + parameters: + - name: id + in: path + description: id of a regRequest + required: true + schema: + type: integer + + + /RegRequest: + post : + summary: Add a new student + tags : + - RegisterRequests + security: + - bearer: [] + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/RegRequest' + responses: + '201': + description: New student created + '401': + $ref: '#/components/responses/UnauthorizedError' + components: securitySchemes: bearer: @@ -417,7 +481,6 @@ components: faculty: type: string teachers: - type: object $ref: '#/components/schemas/User' assistants: type: array @@ -448,6 +511,59 @@ components: "id": 42, "courses": ['Math', 'Info'] } + RegRequest: + type : object + properties: + id: + type : integer + Name : + type: string + Firstname : + type : string + Address : + $ref: "#/components/schemas/Address" + Email: + type : string + BirthDate: + type : string + description: Follow the iso 8601 ("YYYY-MM-DD") + Cursus: + type : integer + description : ID of a specific cursus + Photo: + type : string + description: Path of the picture that the user uploaded + + IdentityCard: + type : string + description: Path of the picture of the user's identity card + Degree: + type : string + description: Path of the pdf containing the user's degree + Certificate: + type : string + description: Path of the pdf containing the user's admission certificate (optionnal) + ForeignerCertificate: + type : string + description: Path of the pdf containing the user's foreigner certificate (optionnal) + State: + type : string + + RegRequests: + type : object + properties: + id : + type : integer + Firstname : + type : string + Name : + type : string + Date : + type : string + description : Follow the iso 8601 ("YYYY-MM-DD") + State : + type : string + responses: UnauthorizedError: description: Permission non accordée