Debut des MAJ des urls

openapi.yaml

@@ -13,8 +13,10 @@ servers:
 
 paths:
   #Collaborateur
-  /collaborateurs:
+  /collaborateur:
     $ref: ./paths/collaborateur/collaborateurs.yaml
+  /collaborateur/count:
+    $ref: ./paths/collaborateur/collaborateurcount.yaml
   /collaborateurs/{idCollaborateur}:
     $ref: ./paths/collaborateur/collaborateurById.yaml
   /collaborateurs/mail/{mail}:

parameters/_index.yaml

@@ -51,14 +51,20 @@ actionEP:
 asc: 
   $ref: ./query/asc.yaml
 
+dateDebut: 
+  $ref: ./query/dateDebut.yaml
+
+dateFin: 
+  $ref: ./query/dateFin.yaml
+
 etatsEngagements: 
   $ref: ./query/etatsEngagement.yaml
 
 etatsDemande: 
   $ref: ./query/etatsDemande.yaml
 
-fonctions:
+roles:
-  $ref: ./query/fonctions.yaml
+  $ref: ./query/roles.yaml
 
 idAgence:
   $ref: ./query/idAgence.yaml

parameters/query/asc.yaml

@@ -3,5 +3,5 @@ name: asc
 schema:
   type: boolean
   default: true
-description: Préciser si les données sont dans l'ordre (true) ou dans l'ordre inverse (false)
+description: Indique si les données sont récupérées dans l'ordre croissant ou non
-required: true
+required: false

parameters/query/dateDebut.yaml

@@ -0,0 +1,8 @@
+in: query
+name: dateDebut
+schema:
+  type: string
+  format: date-time
+  default: null
+description: Date à partir de laquelle les données sont récupérées, selon la date d'arrivée du collaborateur
+required: false

parameters/query/dateFin.yaml

@@ -0,0 +1,8 @@
+in: query
+name: dateFin
+schema:
+  type: string
+  format: date-time
+  default: null
+description: Date jusqu'à laquelle les données sont récupérées, selon la date d'arrivée du collaborateur
+required: false

parameters/query/fonctions.yaml

@@ -1,15 +0,0 @@
-in: query
-name: fonctions
-schema:
-  type: array
-  items: 
-    type: string
-    enum: 
-      - assistants
-      - cp
-      - commerciaux
-      - deliveries
-      - referent
-      - techlead
-required: false
-description: Liste des fonctions des collaborateurs que l'on veut récupérer

parameters/query/idBUs.yaml

@@ -5,5 +5,6 @@ schema:
   items: 
     type: integer
     format: int64
+  default: null
 required: false
 description: liste des ids des BU auxquelles les données sont rattachées

parameters/query/idBu.yaml

@@ -3,4 +3,5 @@ name: idBU
 schema:
   type: integer
   format: int64
+  minimum: 1
 description: id de la business unit à laquelle sont rattachées les données à récupérer

parameters/query/numPage.yaml

@@ -3,5 +3,5 @@ name: numPage
 schema:
   type: integer
   default : 1
-description: Numéro de la page du tableau qui affiche les données
+description: Numéro de la page du tableau à afficher
-required: true
+required: false

parameters/query/parPage.yaml

@@ -2,5 +2,8 @@ in: query
 name: parPAge
 schema:
   type: integer
+  default : 15
+  minimum: 5
+  maximum: 100
 description: Nombre d'éléments affiché sur chaque page du tableau
-required: true
+required: false

parameters/query/roles.yaml

@@ -0,0 +1,9 @@
+in: query
+name: roles
+schema:
+  type: array
+  items: 
+    type: string
+  default: null
+description: Liste des rôles auquels appartiennent les collaborateurs (e.g [”CP”, ”Commerciaux”,”RA”])
+required: false

parameters/query/texte.yaml

@@ -2,4 +2,6 @@ in: query
 name: texte
 schema:
   type: string
-description: Texte permettant d'identifier l'objet rechercher
+  default: null
+description: Texte permettant de filtrer les données
+required: false

parameters/query/tri.yaml

@@ -2,4 +2,6 @@ in: query
 name: tri
 schema:
   type: string
-description: Colonne du tableau sur lequel le tri s'effectue
+  default: null
+description: Colonne du tableau sur lequel le tri devra être effectué
+required: false

paths/collaborateur/collaborateurcount.yaml

@@ -0,0 +1,17 @@
+get:
+  tags:
+    - collaborateurs
+  operationId: getCollaborateurCount
+  description: Récupérer le nombre total de collaborateurs
+  responses:
+    '200': 
+      $ref: ../../responses/collaborateur/getcountcollaborateur.yaml
+  
+    '401':
+      $ref: ../../responses/erreur/unauthorized.yaml
+
+    '403':
+      $ref: ../../responses/erreur/forbidden.yaml
+
+    '500':
+      $ref: ../../responses/erreur/internalServerError.yaml

paths/collaborateur/collaborateurs.yaml

@@ -2,20 +2,27 @@ get:
   tags:
     - collaborateurs
   operationId: getCollaborateurs
-  description: Récupérer la liste des collaborateurs
+  description: Récupérer une liste de collaborateurs
   parameters:
+    - $ref: ../../parameters/query/roles.yaml
+    - $ref: ../../parameters/query/idBUs.yaml
     - $ref: ../../parameters/query/asc.yaml
-    - $ref: ../../parameters/query/fonctions.yaml
-    - $ref: ../../parameters/query/idAgence.yaml
-    - $ref: ../../parameters/query/idBU.yaml
     - $ref: ../../parameters/query/numPage.yaml
     - $ref: ../../parameters/query/parPage.yaml
     - $ref: ../../parameters/query/texte.yaml
     - $ref: ../../parameters/query/tri.yaml
+    - $ref: ../../parameters/query/dateDebut.yaml
+    - $ref: ../../parameters/query/dateFin.yaml
     
   responses:
     '200':
       $ref: ../../responses/collaborateur/getListeCollaborateurs.yaml
 
+    '401':
+      $ref: ../../responses/erreur/unauthorized.yaml
+
     '403':
       $ref: ../../responses/erreur/forbidden.yaml
+
+    '500':
+      $ref: ../../responses/erreur/internalServerError.yaml

paths/demandedelegation/demandesDelegation.yaml

@@ -5,7 +5,7 @@ get:
   description: Récupération de la liste des demandes de délégation
   parameters:
     - $ref: ../../parameters/query/asc.yaml
-    - $ref: ../../parameters/query/fonctions.yaml
+    - $ref: ../../parameters/query/roles.yaml
     - $ref: ../../parameters/path/idCollaborateur.yaml
     - $ref: ../../parameters/query/numPage.yaml
     - $ref: ../../parameters/query/parPage.yaml

paths/referents/referents.yaml

@@ -5,7 +5,7 @@ get:
   description: Récupérer la liste de tous les referents
   parameters:
     - $ref: ../../parameters/query/asc.yaml
-    - $ref: ../../parameters/query/fonctions.yaml
+    - $ref: ../../parameters/query/roles.yaml
     - $ref: ../../parameters/query/idAgence.yaml
     - $ref: ../../parameters/query/idBU.yaml
     - $ref: ../../parameters/query/numPage.yaml

responses/_index.yaml

@@ -5,6 +5,12 @@ NotFoundResponse:
 ForbiddenResponse:
   $ref: ./erreur/forbidden.yaml
 
+InternalServerErrorResponse:
+  $ref: ./erreur/internalServerError.yaml
+
+Unauthorized:
+  $ref: ./erreur/unauthorized.yaml 
+  
 
 #Collaborateur
 GetCollaborateurResponse:

responses/collaborateur/getcountcollaborateur.yaml

@@ -0,0 +1,7 @@
+description: OK
+content:
+  application/json:
+    schema:
+      type: integer
+      format: int64
+      description: Nombre total de collaborateurs

responses/erreur/internalServerError.yaml

@@ -0,0 +1,5 @@
+description: Une erreur est survenue sur le serveur
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/erreur/erreur.yaml

responses/erreur/unauthorized.yaml

@@ -0,0 +1,5 @@
+description: L'utilisateur souhaitant accéder à la ressource n'est pas authentifié
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/erreur/erreur.yaml

schemas/collaborateur/businessunit.yaml

@@ -4,7 +4,7 @@ properties:
   id:
     type: integer
     format: int64
-    description: Id de l'agence
+    description: Id de la business unit
   nom:
     type: string
     description: Nom de la business unit

schemas/ep/engagement.yaml

@@ -17,7 +17,7 @@ properties:
   dateLimite:
     type: string
     format: date-time
-    description: Date limite pour respecter l'engament
+    description: Date limite pour respecter l'engagement
   etatEngagement:
     $ref: ../enum/etatEngagement.yaml
   raisonNonRealisable: