Ajout des énumérations dans les schémas et les urls

4 years ago · fd74f4c14d
parent 4c2592920e
commit fd74f4c14d
21 changed files with 148 additions and 80 deletions
--- a/parameters/_index.yaml
+++ b/parameters/_index.yaml
@ -51,6 +51,12 @@ actionEP:
 asc: 
  $ref: ./query/asc.yaml

+etatsEngagements: 
+  $ref: ./query/etatsEngagement.yaml
+
+etatsDemande: 
+  $ref: ./query/etatsDemande.yaml
+
 fonctions:
  $ref: ./query/fonctions.yaml

@ -60,6 +66,9 @@ idAgence:
 idBU:
  $ref: ./query/idBU.yaml

+idBUs:
+  $ref: ./query/idBUs.yaml
+
 idCollaborateurs:
  $ref: ./query/idCollaborateurs.yaml

--- a/parameters/query/etatsDemande.yaml
+++ b/parameters/query/etatsDemande.yaml
@ -0,0 +1,8 @@
+in: query
+name: etatsDemande
+schema:
+  type: array
+  items: 
+    $ref: ../../schemas/enum/etatDemande.yaml
+required: false
+description: Liste des états des demandes à afficher
--- a/parameters/query/etatsEngagement.yaml
+++ b/parameters/query/etatsEngagement.yaml
@ -0,0 +1,8 @@
+in: query
+name: etatsEngagement
+schema:
+  type: array
+  items: 
+    $ref: ../../schemas/enum/etatEngagement.yaml
+required: false
+description: Etat de l'engagement
--- a/parameters/query/idBUs.yaml
+++ b/parameters/query/idBUs.yaml
@ -0,0 +1,9 @@
+in: query 
+name: idBUs
+schema:
+  type: array
+  items: 
+    type: integer
+    format: int64
+required: false
+description: liste des ids des BU auxquelles les données sont rattachées
--- a/paths/demandeepi/demandesEPICollaborateur.yaml
+++ b/paths/demandeepi/demandesEPICollaborateur.yaml
@ -4,13 +4,8 @@ get:
  operationId: getDemandeEPICollaborateur
  description: Récupération de la liste des demandes EPI d'un collaborateur
  parameters:
-    - $ref: ../../parameters/query/asc.yaml
-    - $ref: ../../parameters/query/fonctions.yaml
    - $ref: ../../parameters/path/idCollaborateur.yaml
-    - $ref: ../../parameters/query/numPage.yaml
-    - $ref: ../../parameters/query/parPage.yaml
-    - $ref: ../../parameters/query/texte.yaml
-    - $ref: ../../parameters/query/tri.yaml
+    - $ref: ../../parameters/query/etatsDemande.yaml
  responses:
    '200':
      $ref: ../../responses/demandeepi/getListeDemandesEPI.yaml
--- a/paths/demandeepi/demandesEPIReferent.yaml
+++ b/paths/demandeepi/demandesEPIReferent.yaml
@ -4,14 +4,8 @@ get:
  operationId: getDemandeEPIReferent
  description: Récupération de la liste des demandes EPI d'un referent
  parameters:
-    - $ref: ../../parameters/query/asc.yaml
-    - $ref: ../../parameters/query/fonctions.yaml
    - $ref: ../../parameters/path/idReferent.yaml
-    - $ref: ../../parameters/query/numPage.yaml
-    - $ref: ../../parameters/query/parPage.yaml
-    - $ref: ../../parameters/query/texte.yaml
-    - $ref: ../../parameters/query/tri.yaml
-    
+    - $ref: ../../parameters/query/etatsDemande.yaml
  responses:
    '200':
      $ref: ../../responses/demandeepi/getListeDemandesEPI.yaml
--- a/paths/demandeformation/demandesformation.yaml
+++ b/paths/demandeformation/demandesformation.yaml
@ -4,13 +4,14 @@ get:
  operationId: getDemandesFormation
  description: Récupérer la liste des demandes de formations
  parameters:
+    - $ref: ../../parameters/query/etatsDemande.yaml
+    - $ref: ../../parameters/query/idBUs.yaml
    - $ref: ../../parameters/query/asc.yaml
-    - $ref: ../../parameters/query/idAgence.yaml
    - $ref: ../../parameters/query/numPage.yaml
    - $ref: ../../parameters/query/parPage.yaml
    - $ref: ../../parameters/query/texte.yaml
-    - $ref: ../../parameters/query/theme.yaml
    - $ref: ../../parameters/query/tri.yaml
+    - $ref: ../../parameters/query/theme.yaml
  responses:
    '200':
      $ref: ../../responses/demandeformation/getListeDemandesFormation.yaml
--- a/paths/engagement/engagements.yaml
+++ b/paths/engagement/engagements.yaml
@ -4,8 +4,9 @@ get:
  operationId: getEngagements
  description: Récupérer la liste des engagements
  parameters:
+    - $ref: ../../parameters/query/etatsEngagement.yaml
    - $ref: ../../parameters/query/asc.yaml
-    - $ref: ../../parameters/query/idAgence.yaml
+    - $ref: ../../parameters/query/idBUs.yaml
    - $ref: ../../parameters/query/numPage.yaml
    - $ref: ../../parameters/query/parPage.yaml
    - $ref: ../../parameters/query/texte.yaml
--- a/schemas/_index.yaml
+++ b/schemas/_index.yaml
@ -108,6 +108,28 @@ StatutFormationDTO:
 TypeFormationDTO:
  $ref: ./formation/typeFormation.yaml

+#Enum
+TypeEp:
+  $ref: ./enum/typeEP.yaml
+
+StatutEp:
+  $ref: ./enum/statutEP.yaml
+
+EtatDemande:
+  $ref: ./enum/etatDemande.yaml
+
+EtatEngagement:
+  $ref: ./enum/etatEngagement.yaml
+
+StatutObjectif:
+  $ref: ./enum/statutObjectif.yaml
+
+TypeChamps:
+  $ref: ./enum/typeChamps.yaml
+
+TypeSaisie:
+  $ref: ./enum/typeSaisie.yaml
+
 #Erreur
 ErreurDTO:
  $ref: ./erreur/erreur.yaml
--- a/schemas/demandedelegation/demandeDelegation.yaml
+++ b/schemas/demandedelegation/demandeDelegation.yaml
@ -4,13 +4,17 @@ properties:
  id:
    type: integer
    format: int64
+  referent:
+    $ref: ../collaborateur/collaborateur.yaml
  ep:
    $ref: ../ep/epInformations.yaml
  dateDemande:
    type: string
    format: date-time
-  reponse:
-    type: boolean
+  raisonDemande:
+    type: string
+  etatDemande:
+    $ref: ../enum/etatDemande.yaml
  dateReponse:
    type: string
    format: date-time
@ -18,6 +22,8 @@ properties:
    type: string

 required:
-  - id
+  - referent
  - ep
  - dateDemande
+  - raisonDemande
+  - etatDemande
--- a/schemas/demandeepi/demandeEPI.yaml
+++ b/schemas/demandeepi/demandeEPI.yaml
@ -4,19 +4,15 @@ properties:
  id:
    type: integer
    format: int64
-  idCollaborateur: 
-    type: string
-    format: uuid
-  idReferent: 
-    type: string
-    format: uuid
+  collaborateur:
+    $ref: ../collaborateur/collaborateur.yaml
+  referent:
+    $ref: ../collaborateur/collaborateur.yaml
  dateDemande:
    type: string
    format: date-time
-  etat:
-    type: integer
-  reponse:
-    type: boolean
+  etatDemande:
+    $ref: ../enum/etatDemande.yaml
  dateReponse:
    type: string
    format: date-time
@ -27,7 +23,6 @@ properties:
  

 required:
-  - id
-  - idCollaborateur
-  - idReferent
+  - collaborateur
  - dateDemande
+  - etatDemande
--- a/schemas/demandeformation/demandeFormation.yaml
+++ b/schemas/demandeformation/demandeFormation.yaml
@ -14,8 +14,8 @@ properties:
  dateDemande:
    type: string
    format: date-time
-  reponse:
-    type: boolean
+  etatDemande:
+    $ref: ../enum/etatDemande.yaml
  commentaireRefus:
    type: string
  dateDerniereReponse:
@ -23,15 +23,20 @@ properties:
    format: date-time
  theme:
    $ref: ./theme.yaml
+  origine:
+    $ref: ./origineDemandesFormation.yaml
+  collaborateur:
+    $ref: ../collaborateur/collaborateur.yaml
  ep:
    $ref: ../ep/epInformations.yaml
+  formation:
+    $ref: ../formation/formation.yaml

 required:
-  - id
-  - status
  - libelle
  - description
  - demandeRH
  - dateDemande
+  - etatDemande
  - ep
  - theme
--- a/schemas/ep/document.yaml
+++ b/schemas/ep/document.yaml
@ -4,12 +4,13 @@ properties:
  id:
    type: integer
    format: int64
-  type:
-    type: string
+  typeDocument:
+    $ref: ../enum/typeChamps.yaml
  saisies:
    type: array
    items:
      $ref: ../saisie/saisie.yaml
 required:
  - id
-  - type
+  - typeDocument
+  - saisies
--- a/schemas/ep/engagement.yaml
+++ b/schemas/ep/engagement.yaml
@ -10,13 +10,11 @@ properties:
    type: string
  dispositif:
    type: string
-  datePrevisionnelle:
+  dateLimite:
    type: string
    format: date-time
-  realisable:
-    type: boolean 
-  realise:
-    type: boolean
+  etatEngagement:
+    $ref: ../enum/etatEngagement.yaml
  raisonNonRealisable:
    type: string
  ep:
@ -26,4 +24,4 @@ required:
  - action
  - modalite
  - dispositif
-  - datePrevisionnelle
+  - dateLimite
--- a/schemas/ep/ep.yaml
+++ b/schemas/ep/ep.yaml
@ -1,24 +1,37 @@
 type: object
-description: Tous les détails d'un EP lorsqu'il est consulté
+description: DTO contenant l'ensemble des informations d’un EP
 properties:
  id:
    type: integer
    format: int64
+    description: Id de l’EP
  type:
-    type: string
+    $ref: ../enum/typeEP.yaml
  dateDisponibilite:
    type: string
    format: date-time
+    description: Date à partir de laquelle l'EP peut ê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)
+  dateSignatureCollaborateur:
+    type: string
+    format: date-time
+    description: Date à laquelle le collaborateur a signé l'EP
+  dateSignatureReferent:
+    type: string
+    format: date-time
+    description: Date à laquelle le référent a signé l'EP
  dateSaisie:
    type: string
    format: date-time
+    description: Date à laquelle l’EP a été saisi par le collaborateur
  statut:
-    type: integer
+    $ref: ../enum/statutEP.yaml
  cv:
    type: string
+    description: Nom du CV Apside du collaborateur
  propositionsEntretien:
    type: array
    items: 
@ -29,6 +42,7 @@ properties:
    $ref: ./typeEntretien.yaml
  obligatoire:
    type: boolean
+    description: Indique si oui ou non l'EP doit obligatoirement être effectué
  objectif:
    type: array
    items:
@ -37,10 +51,6 @@ properties:
    type: array
    items:
      $ref: ./objectifPrecedent.yaml
-  commentaireAssistant:
-    type: string
-  commentaireCommercial:
-    type: string
  collaborateur:
    $ref: ../collaborateur/collaborateur.yaml
  referent:
@ -63,6 +73,8 @@ properties:
    type: array
    items:
      $ref: ../demandedelegation/demandeDelegation.yaml
+  demandeEPI:
+      $ref: ../demandeepi/demandeEPI.yaml
  documents:
    type: array
    items:
@ -76,6 +88,4 @@ required:
  - statut
  - cv
  - obligatoire
-  - collaborateur
-  - referent
  - documents
--- a/schemas/ep/epInformations.yaml
+++ b/schemas/ep/epInformations.yaml
@ -1,21 +1,25 @@
 type: object
-description: Les informations de base d'un EP
+description: DTO permettant d'afficher les informations utiles d'un EP dans un tableau
 properties:
  id:
    type: integer
    format: int64
+    description: Id de l'EP
  type:
-    type: integer
+    $ref: ../enum/typeEP.yaml
  statut:
-    type: integer
+    $ref: ../enum/statutEP.yaml
  dateDisponibilite:
    type: string
    format: date-time
+    description: Date à partir de laquelle l'EP peut ê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é
  collaborateur:
    $ref: ../collaborateur/collaborateur.yaml
  referent:
@ -28,5 +32,3 @@ required:
  - datePrevisionnelle
  - statut
  - obligatoire
-  - collaborateur
-  - referent
--- a/schemas/ep/epSaisie.yaml
+++ b/schemas/ep/epSaisie.yaml
@ -1,20 +1,20 @@
 type: object
-description: Objet de l'EP au moment de la saisie du collaborateur
+description: DTO utilisé lors de la saisie du collaborateur ou du référent
 properties:
  id:
    type: integer
    format: int64
+    description: Id de l’EP
  type:
-    type: string
-  datePrevisionnelle:
-    type: string
-    format: date-time
+    $ref: ../enum/typeEP.yaml
  cv:
    type: string
+    description: Nom du CV Apside du collaborateur
  choixEntretien:
    $ref: ./typeEntretien.yaml
  obligatoire:
    type: boolean
+    description: Indique si oui ou non l'EP doit obligatoirement être effectué
  objectif:
    type: array
    items:
@ -23,6 +23,16 @@ properties:
    type: array
    items:
      $ref: ./objectifPrecedent.yaml
+  collaborateur:
+    $ref: ../collaborateur/collaborateur.yaml
+  referent:
+    $ref: ../collaborateur/collaborateur.yaml
+  engagements:
+    type: array
+    items:
+      $ref: ../ep/engagement.yaml
+  augmentationSalaire:
+    $ref: ./augmentationSalaire.yaml
  documents:
    type: array
    items:
@ -31,7 +41,5 @@ properties:
 required:
  - id
  - type
-  - datePrevisionnelle
  - obligatoire
-  - collaborateur
  - documents
--- a/schemas/ep/objectifPrecedent.yaml
+++ b/schemas/ep/objectifPrecedent.yaml
@ -6,13 +6,11 @@ properties:
    format: int64
  libelle: 
    type: string
-  atteint:
-    type: boolean
+  statutObjectif:
+    $ref: ../enum/statutObjectif.yaml
  commentaire:
    type: string

 required:
  - id
  - libelle
-  - atteint
-  - commentaire
--- a/schemas/ep/prochainEP.yaml
+++ b/schemas/ep/prochainEP.yaml
@ -5,7 +5,7 @@ properties:
    type: integer
    format: int64
  type:
-    type: integer
+    $ref: ../enum/typeChamps.yaml
  dateDisponibilite:
    type: string
    format: date-time
--- a/schemas/saisie/champ.yaml
+++ b/schemas/saisie/champ.yaml
@ -13,10 +13,9 @@ properties:
  ordre:
    type: integer
  typeChamp:
-    type: string
+    $ref: ../enum/typeChamps.yaml
  typeSaisie:
-    type: string
-
+    $ref: ../enum/typeSaisie.yaml
 required:
  - id
  - texte
--- a/schemas/saisie/saisie.yaml
+++ b/schemas/saisie/saisie.yaml
@ -5,7 +5,7 @@ properties:
    type: string
    format: int64
  typeSaisie:
-    type: integer
+    $ref: ../enum/typeEP.yaml
  note:
    type: integer
  texte:
@ -16,7 +16,6 @@ properties:
    type: integer
  champ:
    $ref: ./champ.yaml
-
 required:
  - id
  - type