MAJ des schémas pour la partie Formation en fonction des spécifications techniques

schemas/formation/evaluation.yaml

@@ -1,14 +1,28 @@
 type: object
-description: Evaluation d'une participation formation
+description: DTO pour les évaluations concernant les formations
 properties:
-  idParticipation:
+  id:
     type: integer
     format: int64
+    description: Id de la participation à la formation
+  intitule:
+    type: string
+    description: Intitulé de la formation
+  dateDebut:
+    type: string
+    format: date-time
+    description: Date de début de la formation
+  estCertifie:
+    type: boolean
+    description: Indique si la formation est certifiée ou non
   saisies:
     type: array
     items:
       $ref: ../saisie/saisie.yaml
 
 required:
-  - idParticipation
+  - id
+  - intitule
+  - dateDebut
+  - estCertifie
   - saisies

schemas/formation/formation.yaml

@@ -1,11 +1,13 @@
 type: object
-description: Toutes les informations d'une formation
+description: DTO pour la gestion des formations
 properties: 
   id:
     type: integer
     format: int64
+    description: Id de la formation
   intitule: 
     type: string
+    description: Intitulé de la formation
   origine:
     $ref: ./origineFormation.yaml
   statut: 
@@ -13,40 +15,51 @@ properties:
   idAgence:
     type: integer
     format: int64
+    description: Id de l'agence de la RH qui a créé la formation
   dateDebut:
     type: string
     format: date-time
+    description: Date de la première séance de la formation
   dateFin:
     type: string
     format: date-time
+    description: Date de la dernière séance de la formation
   heure: 
     type: integer
+    description: Nombre d'heures total de formation
   jour:
     type: integer
+    description: Nombre de jours total de formation
   organisme:
     type: string
+    description: Organisme en charge d'effectuer la formation
   mode:
     $ref: ./modeFormation.yaml
   type:
     $ref: ./typeFormation.yaml
-  estCertifie:
+  estCertifiee:
     type: boolean
-  participantsFormation:
+    description: Indique qu'il s'agit d'une formation certifiée ou non
+  estRealisee:
+    type: boolean
+    description: Indique que la formation a bien été effectuée ou non
+  participations:
     type: array
     items:  
       $ref: ./participationformation.yaml
 
   
 required:
- - id
  - intitule
  - origine
  - status
  - dateDebut
  - dateFin
+ - idAgence
  - heure
  - jour
  - organisme
+ - estCertifiee
+ - estRealisee
  - mode
  - type
- - estCertifie

schemas/formation/formationDetails.yaml

@@ -1,37 +1,42 @@
 type: object
-description: Les détails d'une formation
+description: DTO pour l'affichage des détails d'une formation
 properties:
   id:
     type: integer
     format: int64
+    description: Id de la formation
   intitule: 
     type: string
+    description: Intitulé de la formation
   statut: 
     $ref: ./statutFormation.yaml
   dateDebut:
     type: string
     format: date-time
+    description: Date de début de la formation
   dateFin:
     type: string
     format: date-time
-  nbPartitipants:
+    description: Date de la dernière séance de la formation
+  organisme:
+    type: string
+    description: Organisme en charge d'effectuer la formation
+  nbParticipations:
     type: integer
+    description: Nombre de participants de la formation
   origine:
     $ref: ./origineFormation.yaml
-  mode:
-    $ref: ./modeFormation.yaml
-  type:
-    $ref: ./typeFormation.yaml
   estCertifie:
     type: boolean
+    description: Indique si la formation est certifiée ou non
   
   
 required:
+ - id
  - intitule
- - status
+ - origine
+ - statut
  - dateDebut
  - dateFin
- - nbPartitipants
- - mode
- - type
+ - nbParticipations
  - estCertifie

schemas/formation/modeFormation.yaml

@@ -1,10 +1,12 @@
 type: object
-description: Mode d'une formation
+description: DTO concernant le mode d'une formation
 properties:
   id:
     type: integer
+    description: Id du mode de formation
   libelle: 
     type: string
+    description: Libellé du mode de formation
 
 required:
   - id

schemas/formation/origineFormation.yaml

@@ -1,10 +1,12 @@
 type: object
-description: Origine d'une formation
+description: DTO concernant l'origine d'une formation
 properties:
   id:
     type: integer
+    description: Id de l'origine de la formation
   libelle: 
     type: string
+    description: Libellé de l'origine de la formation
 
 required:
   - id

schemas/formation/participationformation.yaml

@@ -1,29 +1,35 @@
 type: object
+description: DTO concernant la participation à une formation
 properties:
   id: 
     type: integer
     format: int64
+    description: Id de la participation formation
   dateCreation:
     type: string
     format: date-time
-  formation:
+    description: Date à laquelle la participation a été créée
+  intitule:
     type: string
-  date:
+    description: Intitulé de la formation
+  dateDebut:
     type: string
     format: date-time
+    description: Date de début de la formation
   statut: 
-    type: string
-  idCollaborateur:
-    type: string
-    format : uuid
+    $ref: ./statutFormation.yaml
   collaborateur:
-    type: string
+    $ref: ../collaborateur/collaborateur.yaml
   estEvaluee:
     type: boolean
+    description: Indique si le collaborateur a effectué l'évaluation de la formation
+  ep:
+    $ref: ../ep/epInformations.yaml
 
 required:
-  - id
   - dateCreation
-  - formation
-  - demandeformation
+  - intitule
+  - dateDebut
+  - statut
+  - collaborateur
   - estEvaluee

schemas/formation/statutFormation.yaml

@@ -1,10 +1,12 @@
 type: object
-description: Statut actuel d'une formation
+description: DTO concernant le statut d’une formation
 properties:
   id:
     type: integer
+    description: Id du statut de la formation
   libelle: 
     type: string
+    description: Libellé du statut de la formation
 
 required:
   - id

schemas/formation/typeFormation.yaml

@@ -1,10 +1,12 @@
 type: object
-description: Type d'une formation
+description: DTO concernant le type d'une formation
 properties:
   id:
     type: integer
+    description: Id du type de la formation
   libelle: 
     type: string
+    description: Libellé du type de la formation
 
 required:
   - id