Finished RestApi

Documents/proto/general/openapi.yaml

@@ -11,63 +11,114 @@ servers:
 paths:
   /ping:
     get:
-      summary: Test if the api is up.
+      summary: Vérifie l'état de l'api. 
       responses:
         default:
-          description: Standard response to ping
+          description: Retourne pong 
           content:
             text/plain:
               schema:
                 type: string
                 example: pong
-  /requests:
-    post:
-      summary: Faire une demande
-      tags:
-        - Student
-      responses: 
-        '201':
-          description: Demande envoyée
   /users:
     get:
-      summary: Listere les utilisateurs
+      summary: Liste les utilisateurs
       tags:
         - SI
       security:
         - bearer: []
+      parameters:
+        - in: query
+          name: type
+          required: false 
+          schema:
+            type: string
+            enum: [teacher, student, secretary]
       responses: 
-        default:
+        '200':
-          description: Success
+          content: 
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/User"
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
   
-  /user: # registration
+  /user:
+    get:
+      summary: Récupére ses informations 
+      tags:
+        - Users
+      responses:
+        '200':
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/User"
     post:
       summary: Créer un utilisateur
       tags:
-        - users
+        - Users
+      requestBody:
+        require: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object 
+              properties:
+                LastName: 
+                  type: string
+                FirstName:
+                  type: string
+                Email:
+                  type: string
+                Address:
+                  $ref: "#/components/schemas/Address"
+                BirthDate:
+                  type: string
+                  description: Follow the iso 8601 ("YYYY-MM-DD")
+              example:
+                {
+                "LastName": "Doe" ,
+                "FirstName": "John",
+                "Email": "John.Doe@example.com",
+                "Address": {
+                  "Address": "Rue de Tounais 42",
+                  "Country": "BE"},
+                "BirthDate": "1941-02-22",
+                }
       responses:
-        '200':
+        '201':
           description: User created
         '401':
           $ref: '#/components/responses/UnauthorizedError'
     patch:
       summary: modifier ses informations
       tags:
-        - users
+        - Users
       security:
         - bearer: []
+      requestBody:
+        require: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/User'
       responses:
-        '200':
+        '201':
-          description: Informaitions modifiées
+          description: Informations modifiées 
         '401':
           $ref: '#/components/responses/UnauthorizedError'
   /user/{mat}:
     get:
-      summary: get user's info
+      summary: Récupérer les informations d'un utilisateur
       tags:
         - Admin
       responses:
         '200':
-          description: User found 
+          description: Utilisateur trouvé
           content:
             application/json:
               schema:
@@ -85,65 +136,56 @@ paths:
         - Admin
       security:
         - bearer: []
+      requestBody:
+        require: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/User'
       responses:
-        '200':
+        '201':
-          description: Informaitions modifiées
+          description: Informations modifiées 
         '401':
           $ref: '#/components/responses/UnauthorizedError'
 
-  /users/requests:
+  /course:
-    get:
+    post:
-      summary: Lister les requetes d'utilisateurs
+      summary: Créer un nouveau cours
-      security:
-        - bearer: []
       tags:
-        - Secretaria
+        - Courses
-        - SI
+        - Secretariat
-      responses:
+      security: 
-        '200':
-          description: Liste les requètes
-
-
-  /user/{mat}/validate/{id}:
-    patch:
-      summary: Valider un utilisateur
-      tags:
-        - Secretaria
-        - SI
-      security:
         - bearer: []
-      parameters:
+      requestBody:
-        - name: mat
+        require: true
-          in: path
+        content:
-          description: matricule de l'utilisateur
+          application/x-www-form-urlencoded:
-          required: true
+            schema:
-          schema:
+              type: object
-            type: integer
+              properties:
-        - name: id
+                name:
-          in: path
+                  type: string
-          description: Identifiant de la demande
+                courses:
-          required: true
+                  type: array
-          schema:
+                  items:
-            type: integer
+                    type: string
-        - name: answer
-          in: header
-          description: valide l'utilisateur ou non
-          schema:
-            type: boolean
       responses:
-        '200':
+        '201':
-          description: Informaitions modifiées
+          description: Nouveau cours crée
         '401':
           $ref: '#/components/responses/UnauthorizedError'
-
   /courses/{id}:
     get:
-      summary: Voir les informations sur un cours*
+      summary: Voir les informations sur un cours
       tags:
         - Courses
       responses:
-        '202':
+        '200':
-          description: success
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Course'
     parameters:
       - name: id
         in: path
@@ -154,49 +196,107 @@ paths:
       summary: Suprimer un cours
       tags:
         - Courses
-        - Secretaria
+        - Secretariat
       security: 
         - bearer: []
       responses:
-        '202':
+        '201':
-          description: success
+          description: Success
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
     patch:
       summary: Changer les options du cours
       tags:
-        - Secretaria
+        - Secretariat
         - Courses
       security:
         - bearer: []
-      parameters: 
+      requestBody:
-        - name: professeur
+        require: true
-          in: header
+        content:
-          required: true
+          application/x-www-form-urlencoded:
-          schema:
+            schema:
-            type: string
+              type: object
+              properties:
+                name:
+                  type: string
+                credits:
+                  type: integer
+                faculty:
+                  type: string
+                teachers:
+                  type: object
+                  $ref: '#/components/schemas/User'
+                assistants:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/User'
+              example:
+                {
+                "name": "Math pour l'info",
+                "credits": 11,
+                "faculty": "science",
+                "Teacher": ,
+                "Assistants": [ ]
+                }
       responses:
-        '202':
+        '201':
-          description: Bien ouej
+          description: Cours modifié 
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
           
   /cursus:
     post:
-      summary: Créer un nouveau cours
+      summary: Créer un nouveau cursus
       tags:
         - cursus
       security: 
         - bearer: []
+      requestBody:
+        require: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                credits:
+                  type: integer
+                faculty:
+                  type: string
+                teachers:
+                  type: object
+                  $ref: '#/components/schemas/User'
+                assistants:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/User'
+              example:
+                {
+                "name": "Math pour l'info",
+                "credits": 11,
+                "faculty": "science",
+                "Teacher": ,
+                "Assistants": [ ]
+                }
       responses:
-        '202':
+        '201':
-          description: success
+          description: Nouveau cursus crée
-
+        '401':
-            
+          $ref: '#/components/responses/UnauthorizedError'
   /cursus/{id}:
     get:
       summary: Voir les informations sur un cursus
       tags:
         - cursus
       responses:
-        '202':
+        '200':
-          description: success
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Cursus'
     parameters:
       - name: id
         in: path
@@ -210,30 +310,50 @@ paths:
       security: 
         - bearer: []
       responses:
-        '202':
+        '201':
-          description: success
+          description: Success
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
     patch:
       summary: Changer les options du cursus
       tags:
         - cursus
       security:
         - bearer: []
+      requestBody:
+        require: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                credits:
+                  type: integer
+                faculty:
+                  type: string
+                teachers:
+                  type: object
+                  $ref: '#/components/schemas/User'
+                assistants:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/User'
+              example:
+                {
+                "name": "Math pour l'info",
+                "credits": 11,
+                "faculty": "science",
+                "Teacher": ,
+                "Assistants": [ ]
+                }
       responses:
-        '202':
+        '201':
-          description: Bien ouej
+          description: Cours modifié 
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
           
-  /courses:
-    post:
-      summary: Créer un nouveau cours
-      tags:
-        - Courses
-        - Secretaria
-      security: 
-        - bearer: []
-      responses:
-        '202':
-          description: success
-
     
 components:
   securitySchemes:
@@ -244,54 +364,81 @@ components:
     User:
       type: object 
       properties:
-        RegNo:
+        regNo:
           type: integer
-        Photo:
+        photo:
           type: object
-        LastName: 
+        lastName: 
           type: string
-        FirstName:
+        firstName:
           type: string
-        Email:
+        email:
           type: string
-        Address:
+        address:
           $ref: "#/components/schemas/Address"
-        BirthDate:
+        birthDate:
           type: string
           description: Follow the iso 8601 ("YYYY-MM-DD")
-        StaffMember:
-          type: boolean
       example:
         {
-        "RegNo": 42,
+        "regNo": 42,
-        "LastName": "Doe" ,
+        "lastName": "Doe" ,
-        "FirstName": "John",
+        "firstName": "John",
-        "Email": "John.Doe@example.com",
+        "email": "John.Doe@example.com",
-        "Address": {
+        "address": {
-          "Address": "Rue de Tounais 42",
+          "address": "Rue de Tounais 42",
-          "Country": "BE"},
+          "country": "BE"},
-        "BirthDate": "1941-02-22",
+        "birthDate": "1941-02-22",
-        "StaffMember": true,
+        "staffMember": true,
         }
     Address:
       type: object
       properties:
-        Address:
+        address:
           type: string
-        Country:
+        country:
           type: string
           description: Follow the ISO-3166-1 alpha-2 standard.
       example:
         {
-          "Address": "Rue de Tounais 42",
+          "address": "Rue de Tounais 42",
-          "Country": "BE"
+          "country": "BE"
+        }
+    Course:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        credits:
+          type: integer
+        faculty:
+          type: string
+        teachers:
+          type: object
+          $ref: '#/components/schemas/User'
+        assistants:
+          type: array
+          items:
+            $ref: '#/components/schemas/User'
+      example:
+        {
+        "id": 42,
+        "name": "Math pour l'info",
+        "credits": 11,
+        "faculty": "science",
+        "Teacher": ,
+        "Assistants": [ ]
         }
     Cursus:
       type: object
       properties:
-        Id:
+        id:
           type: integer
-        Courses:
+        name:
+          type: string
+        courses:
           type: array
           items:
             type: string
@@ -302,4 +449,4 @@ components:
         }
   responses:
     UnauthorizedError:
-      description: Access token is missing or invalid
+      description: Permission non accordée