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

schemas/_index.yaml

@@ -23,6 +23,9 @@ DemandeEPIDTO:
 AugmentationSalaireDTO:
   $ref: ./ep/augmentationSalaire.yaml
 
+CommentaireAssistantDTO:
+  $ref: ./ep/commentaireAssistant.yaml
+
 DocumentDTO:
   $ref: ./ep/document.yaml
 

schemas/ep/augmentationsalaire.yaml

@@ -1,17 +1,21 @@
 type: object
-description: Demande d'augmentation du salaire du collaborateur
+description: DTO lié à la demande d'augmentation du salaire effectuée lors d'un EP
 properties:
   id:
     type: integer
     format: int64
+    description: Id de l'augmentation du salaire
   augmentation:
     type: number
     format : float
-  primeMission:
+    description: Pourcentage de l'augmentation du salaire
+  augmentationPrimeMission:
     type: number
     format: float
+    description: Pourcentage de l'augmentation de la prime de mission
   message:
     type: string
+    description: Message laissé par le référent suite à l'augmentation du salaire
 required:
   - id
   - augmentation

schemas/ep/commentaireAssistant.yaml

@@ -0,0 +1,18 @@
+type: object
+description: DTO contenant le commentaire d'un assistant sur l'EP
+properties:
+  id:
+    type: integer
+    format: int64
+    description: Id du commentaire assistant
+  idAssistante: 
+    type: string
+    format: uuid
+    description: Id de l'assistant qui a écrit le commentaire
+  commentaire:
+    type: string
+    description: Le commentaire de l’assistant
+
+required:
+  - idAssistant
+  - commentaire

schemas/ep/document.yaml

@@ -1,9 +1,10 @@
 type: object
-description: Un document pour récupérer les saisies et leur champ en fonction du type de l'EP qui peut être EPS, EPA ou EPASIXANS
+description:  DTO permettant de faire le lien entre les saisies (EPS ou EPA...) avec l'EP
 properties:
   id:
     type: integer
     format: int64
+    description: Id du document
   typeDocument:
     $ref: ../enum/typeChamps.yaml
   saisies:

schemas/ep/engagement.yaml

@@ -1,27 +1,33 @@
 type: object
-description: Les détails d'un engagement pris par un référent pour un EP
+description: DTO concernant les engagements pris par le référent lors de l'EP
 properties:
   id:
     type: integer
     format: int64
+    description: Id de l'engagement
   action:
     type: string
-  modalite:
-    type: string
+    description: Action de l'engagement
   dispositif:
     type: string
+    description: Dispositif à mettre en place pour respecter l'engagement dans les temps
+  modalite:
+    type: string
+    description: ”Sur temps de travail” ou ”Hors-temps”
   dateLimite:
     type: string
     format: date-time
+    description: Date limite pour respecter l'engament
   etatEngagement:
     $ref: ../enum/etatEngagement.yaml
   raisonNonRealisable:
     type: string
+    description: Raison pour laquelle l'engagement ne sera pas respecté
   ep:
     $ref: ./epInformations.yaml
 required:
   - id
   - action
-  - modalite
   - dispositif
+  - modalite
   - dateLimite

schemas/ep/ep.yaml

@@ -79,7 +79,10 @@ properties:
     type: array
     items:
       $ref: ./document.yaml
-
+  commentairesAssistant:
+    type: array
+    items:
+      $ref: ./commentaireAssistant.yaml
 required:
   - id
   - type

schemas/ep/epSaisie.yaml

@@ -23,10 +23,14 @@ properties:
     type: array
     items:
       $ref: ./objectifPrecedent.yaml
-  collaborateur:
-    $ref: ../collaborateur/collaborateur.yaml
-  referent:
-    $ref: ../collaborateur/collaborateur.yaml
+  idCollaborateur:
+    type: string
+    format: uuid
+    description: Id du collaborateur qui passe son EP
+  idReferent:
+    type: string
+    format: uuid
+    description: Id du référent actuel de l'EP
   engagements:
     type: array
     items:

schemas/ep/objectif.yaml

@@ -1,11 +1,13 @@
 type: object
-description: Les objectifs pris par le collaborateur
+description: DTO concernant un objectif du collaborateur
 properties:
   id:
     type: integer
     format: int64
+    description: Id de l'objectif
   libelle: 
     type: string
+    description: L'objectif du collaborateur
 
 required:
   - id

schemas/ep/objectifPrecedent.yaml

@@ -1,15 +1,18 @@
 type: object
-description: Les objectifs pris par le collaborateur durant le précédent EP
+description: DTO concernant un objectif du dernier EP effectué par le collaborateur
 properties:
   id:
     type: integer
     format: int64
+    description: Id de l'objectif précédent
   libelle: 
     type: string
+    description: Contenu de l'objectif
   statutObjectif:
     $ref: ../enum/statutObjectif.yaml
   commentaire:
     type: string
+    description: Commentaire du collaborateur sur l'objectif
 
 required:
   - id

schemas/ep/participationEP.yaml

@@ -1,16 +1,22 @@
 type: object
-description: Information des participants d'un EP (autre que le référent et le collaborateur)
+description: DTO concernant les participants d'un EP hors collaborateur et référent
 properties:
   id:
     type: integer
     format: int64
-  idCollaborateur:
+    description: Id de la participation
+  idParticipant:
     type: string
     format: uuid
-  collaborateur:
+    description: Id du participant
+  estPermanente:
+    type: boolean
+    description: Indique si la participation est juste une participation d'un EP en cours ou des prochains EP en plus
+  participant:
     type: string
+    description: Nom et prénom
     
 required:
-  - id
-  - idCollaborateur
-  - collaborateur
+  - idParticipant
+  - estPermanente
+  - participant

schemas/ep/prochainEP.yaml

@@ -1,19 +1,23 @@
 type: object
-description: Objet contenant les détails du prochain EP non saisi du collaborateur
+description: DTO permettant au collaborateur d'avoir les informations sur la date de son prochain EP
 properties:
   id:
     type: integer
     format: int64
+    description: Id de l'EP
   type:
     $ref: ../enum/typeChamps.yaml
   dateDisponibilite:
     type: string
     format: date-time
+    description: Date à laquelle l'EP est disponible pour être saisi
   datePrevisionnelle:
     type: string
     format: date-time
+    description: Date à laquelle l'EP est prévu, la date par défaut est celle de l'anniversaire du collaborateur (+6 mois pour EPS)
   obligatoire:
     type: boolean
+    description: Indique si oui ou non l'EP doit obligatoirement être effectué
 
 required:
   - id

schemas/ep/rdventretien.yaml

@@ -1,15 +1,16 @@
 type: object
-description: RDV pour un entretien
+description: DTO concernant la proposition d'un RDV pour l'entretien professionnel
 properties:
   id:
     type: integer
     format: int64
+    description: Id du RDV
   dateEntretien:
     type: string
     format: date-time
+    description: Date proposée/prévue pour l'entretien
   typeEntretien:
     $ref: ./typeEntretien.yaml
 required:
-  - id
   - dateEntretien
   - typeEntretien

schemas/ep/typeEntretien.yaml

@@ -1,10 +1,12 @@
 type: object
-description: Type de l'entretien d'un EP
+description: DTO concernant comment l'entretien va se dérouler
 properties:
   id:
     type: integer
+    description: Id du type de l'entretien
   libelle:
     type: string
+    description: Texte du type de l'entretien
 required:
   - id
   - libelle