From 6e9366b3dcf3732786538132e5203e88660e4cdc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yana=C3=ABl=20GRETTE?= Date: Tue, 8 Dec 2020 13:54:34 +0100 Subject: [PATCH] =?UTF-8?q?passage=20des=20urls=20r=C3=A9f=C3=A9rent=20ver?= =?UTF-8?q?s=20les=20urls=20collaborateurs=20et=20ajouts=20de=20param?= =?UTF-8?q?=C3=A8tres=20pour=20r=C3=A9cup=C3=A9rer=20une=20liste=20de=20co?= =?UTF-8?q?llaborateurs=20en=20fonction=20des=20roles=20et=20business=20un?= =?UTF-8?q?its?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- API/_build/openapi.yaml | 83 ++++++++++++------- API/openapi.yaml | 4 +- API/parameters/BuIds.yaml | 8 ++ API/parameters/Roles.yaml | 17 ++++ API/parameters/_index.yaml | 5 ++ API/routes/Collaborateur/Id/patchCollab.yaml | 2 +- API/routes/Collaborateur/Id/putCollab.yaml | 2 +- .../Collaborateur/Mail/patchCollab.yaml | 2 +- API/routes/Collaborateur/Mail/putCollab.yaml | 2 +- API/routes/Collaborateur/postCollabs.yaml | 2 +- API/routes/Collaborateurs/getCollabs.yaml | 6 +- .../Collaborateurs/getCollabsAgence.yaml | 5 +- API/routes/Collaborateurs/getCollabsBU.yaml | 5 +- API/routes/Collaborateurs/getCollabsRef.yaml | 4 +- API/routes/PE/patch1Periode.yaml | 2 +- API/routes/PE/patchPeriode.yaml | 2 +- API/routes/PE/put1Periode.yaml | 2 +- API/routes/PE/putPeriode.yaml | 2 +- API/routes/Referent/getRefCollabId.yaml | 9 +- API/routes/Referent/getRefCollabMail.yaml | 9 +- API/routes/Referents/getRefsCollabId.yaml | 2 +- API/routes/Referents/getRefsCollabMail.yaml | 2 +- API/routes/_index.yaml | 2 +- 23 files changed, 116 insertions(+), 63 deletions(-) create mode 100644 API/parameters/BuIds.yaml create mode 100644 API/parameters/Roles.yaml diff --git a/API/_build/openapi.yaml b/API/_build/openapi.yaml index 0107c3d..37ed501 100644 --- a/API/_build/openapi.yaml +++ b/API/_build/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: description: 'Api du service Collaborateur, utilisée pour récupérer les données des collaborateurs d''Apside' - version: 1.1.2 + version: 1.1.3 title: Service Collaborateur API contact: email: lilian.gayet@apside-groupe.com @@ -9,8 +9,7 @@ paths: /collaborateurs: get: tags: - - collaborateurs - - référents + - collaborateur summary: rechercher tous les collaborateurs operationId: ChercherCollab description: | @@ -18,7 +17,8 @@ paths: parameters: - $ref: '#/components/parameters/CollabsId' - $ref: '#/components/parameters/Anciens' - - $ref: '#/components/parameters/Referent' + - $ref: '#/components/parameters/Role' + - $ref: '#/components/parameters/BuIds' responses: '200': description: résultats de la recherche @@ -51,15 +51,14 @@ paths: '/collaborateurs/bu/{buId}': get: tags: - - collaborateurs - - référents + - collaborateur summary: rechercher tous les collaborateurs d'un Business-unit operationId: ChercherCollabBU description: | Cette requette demande de récupérer tous les collaborateurs existant au sein d'une business-unit parameters: - $ref: '#/components/parameters/BuId' - - $ref: '#/components/parameters/Referent' + - $ref: '#/components/parameters/Role' responses: '200': description: résultats de la recherche @@ -76,15 +75,14 @@ paths: '/collaborateurs/agence/{agenceId}': get: tags: - - collaborateurs - - référents + - collaborateur summary: rechercher tous les collaborateurs d'un Business-unit operationId: ChercherCollabAgence description: | Cette requette demande de récupérer tous les collaborateurs existant au sein d'une agence parameters: - $ref: '#/components/parameters/AgenceId' - - $ref: '#/components/parameters/Referent' + - $ref: '#/components/parameters/Role' responses: '200': description: résultats de la recherche @@ -101,11 +99,11 @@ paths: '/collaborateurs/referent/{refId}': get: tags: - - collaborateurs + - collaborateur summary: rechercher tous les collaborateurs d'un référent operationId: ChercherCollabRef description: | - Cette requette demande de récupérer tous les collaborateurs existant au sein d'une business-unit + Cette requette demande de récupérer tous les collaborateurs d'un référent parameters: - $ref: '#/components/parameters/RefId' responses: @@ -238,7 +236,7 @@ paths: '/collaborateurs/{collabId}/referents': get: tags: - - référents + - collaborateur summary: rechercher les référents operationId: ChercherRefCollabId description: | @@ -261,7 +259,7 @@ paths: '/collaborateurs/{mailApside}/referents': get: tags: - - référents + - collaborateur summary: rechercher les référents operationId: ChercherRefCollabMail description: | @@ -284,14 +282,13 @@ paths: '/collaborateurs/{collabId}/referent': get: tags: - - référent - summary: rechercher le référent qui a le plus suivit - operationId: ChercherRefSuiviParDateCollabId + - collaborateur + summary: rechercher le référent actuel + operationId: ChercherRefActuelId description: | - rechercher le référent du collaborateur l’ayant le plus suivi depuis une date donnée à l'aide de son identifiant + rechercher le référent actuel du collaborateur à l'aide de son identifiant parameters: - $ref: '#/components/parameters/CollabId' - - $ref: '#/components/parameters/Date' responses: '200': description: résultat de la recherche @@ -306,14 +303,13 @@ paths: '/collaborateurs/{mailApside}/referent': get: tags: - - référent - summary: rechercher le référent qui a le plus suivit - operationId: ChercherRefSuiviParDateCollabMail + - collaborateur + summary: rechercher le référent actuel + operationId: ChercherRefActuelMail description: | - rechercher le référent du collaborateur l’ayant le plus suivi depuis une date donnée à l'aide de son mail apside + rechercher le référent actuel du collaborateur l'aide de son mail apside parameters: - $ref: '#/components/parameters/MailApside' - - $ref: '#/components/parameters/Date' responses: '200': description: résultat de la recherche @@ -328,7 +324,7 @@ paths: '/collaborateurs/{collabId}/PeriodeEssai': put: tags: - - péridode d'essai + - periode d'essai summary: mettre à jour une péridode d'essai description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 @@ -347,7 +343,7 @@ paths: $ref: '#/components/responses/400' patch: tags: - - péridode d'essai + - periode d'essai summary: mettre à jour une péridode d'essai en cours description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 @@ -367,7 +363,7 @@ paths: '/collaborateurs/{collabId}/PremierePeriodeEssai': put: tags: - - péridode d'essai + - periode d'essai summary: mettre à jour la première partie de la péridode d'essai description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 @@ -386,7 +382,7 @@ paths: $ref: '#/components/responses/400' patch: tags: - - péridode d'essai + - periode d'essai summary: mettre à jour la première partie de la péridode d'essai description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 @@ -440,7 +436,7 @@ paths: $ref: '#/components/responses/200' '400': $ref: '#/components/responses/400' - '/agence/{agenceId}': + '/agences/{agenceId}': get: tags: - agence @@ -859,6 +855,15 @@ components: type: integer format: int64 example: 1 + BuIds: + in: query + name: buIds + description: Ce paramêtre permet de renseigner la liste des identifiants des BU auxquelles sont rattachés les collaborateur + schema: + type: array + items: + type: integer + format: int64 AdresseId: in: path name: adresseId @@ -900,6 +905,24 @@ components: type: string format: Date example: '2020-01-01' + Role: + in: query + name: roles + description: 'Ce paramêtre permet de renseigner la liste des rôles des collaborateurs à récupérer. Si elle est vide ou null, on récupère tout le monde.' + required: false + schema: + type: array + items: + type: string + enum: + - Collaborateur + - Assistant + - RH + - CP + - TechLead + - RA + - Commercial + - Delivery NomClient: in: path name: nomClient @@ -1227,5 +1250,7 @@ components: 404Projet: description: il n'y a pas de projet servers: + - description: local server + url: 'http://localhost:3000' - description: SwaggerHub API Auto Mocking url: 'https://virtserver.swaggerhub.com/LilianG/Service-Collaborateur/1.1.1' diff --git a/API/openapi.yaml b/API/openapi.yaml index bc3117b..e88dc2b 100644 --- a/API/openapi.yaml +++ b/API/openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: Api du service Collaborateur, utilisée pour récupérer les données des collaborateurs d'Apside - version: "1.1.2" + version: "1.1.3" title: Service Collaborateur API contact: email: lilian.gayet@apside-groupe.com @@ -19,5 +19,7 @@ components: $ref: "./responses/_index.yaml" servers: + - description: local server + url: http://localhost:3000 - description: SwaggerHub API Auto Mocking url: https://virtserver.swaggerhub.com/LilianG/Service-Collaborateur/1.1.1 diff --git a/API/parameters/BuIds.yaml b/API/parameters/BuIds.yaml new file mode 100644 index 0000000..3e7359d --- /dev/null +++ b/API/parameters/BuIds.yaml @@ -0,0 +1,8 @@ +in: query +name: buIds +description: Ce paramêtre permet de renseigner la liste des identifiants des BU auxquelles sont rattachés les collaborateur +schema: + type: array + items : + type: integer + format: int64 \ No newline at end of file diff --git a/API/parameters/Roles.yaml b/API/parameters/Roles.yaml new file mode 100644 index 0000000..a516f67 --- /dev/null +++ b/API/parameters/Roles.yaml @@ -0,0 +1,17 @@ +in: query +name: roles +description: Ce paramêtre permet de renseigner la liste des rôles des collaborateurs à récupérer. Si elle est vide ou null, on récupère tout le monde. +required: false +schema: + type: array + items: + type: string + enum: + - Collaborateur + - Assistant + - RH + - CP + - TechLead + - RA + - Commercial + - Delivery diff --git a/API/parameters/_index.yaml b/API/parameters/_index.yaml index 964f9cb..a1641de 100644 --- a/API/parameters/_index.yaml +++ b/API/parameters/_index.yaml @@ -12,6 +12,8 @@ AgenceId: $ref: "./AgenceId.yaml" BuId: $ref: "./BuId.yaml" +BuIds: + $ref: "./BuIds.yaml" AdresseId: $ref: "./AdresseId.yaml" ProjetId: @@ -24,6 +26,9 @@ Referent: $ref: "./Referent.yaml" Date: $ref: "./Date.yaml" +Role: + $ref: "./Roles.yaml" + # Specifique aux projets NomClient: diff --git a/API/routes/Collaborateur/Id/patchCollab.yaml b/API/routes/Collaborateur/Id/patchCollab.yaml index 8a5414d..4dc6e4f 100644 --- a/API/routes/Collaborateur/Id/patchCollab.yaml +++ b/API/routes/Collaborateur/Id/patchCollab.yaml @@ -1,5 +1,5 @@ tags: -- "collaborateur" + - "collaborateur" summary: mettre à jour un collaborateur description: "" operationId: MajCollabpatch diff --git a/API/routes/Collaborateur/Id/putCollab.yaml b/API/routes/Collaborateur/Id/putCollab.yaml index fda9458..26dae67 100644 --- a/API/routes/Collaborateur/Id/putCollab.yaml +++ b/API/routes/Collaborateur/Id/putCollab.yaml @@ -1,5 +1,5 @@ tags: -- "collaborateur" + - "collaborateur" summary: mettre à jour un collaborateur description: "" operationId: MajCollab diff --git a/API/routes/Collaborateur/Mail/patchCollab.yaml b/API/routes/Collaborateur/Mail/patchCollab.yaml index 77b7b4a..0fdeb3d 100644 --- a/API/routes/Collaborateur/Mail/patchCollab.yaml +++ b/API/routes/Collaborateur/Mail/patchCollab.yaml @@ -1,5 +1,5 @@ tags: -- "collaborateur" + - "collaborateur" summary: mettre à jour un collaborateur description: "" operationId: MajCollabpatchMail diff --git a/API/routes/Collaborateur/Mail/putCollab.yaml b/API/routes/Collaborateur/Mail/putCollab.yaml index 0ceb7bf..d2a47b0 100644 --- a/API/routes/Collaborateur/Mail/putCollab.yaml +++ b/API/routes/Collaborateur/Mail/putCollab.yaml @@ -1,5 +1,5 @@ tags: -- "collaborateur" + - "collaborateur" summary: mettre à jour un collaborateur description: "" operationId: MajCollabMail diff --git a/API/routes/Collaborateur/postCollabs.yaml b/API/routes/Collaborateur/postCollabs.yaml index 88c8bfd..1b5f83a 100644 --- a/API/routes/Collaborateur/postCollabs.yaml +++ b/API/routes/Collaborateur/postCollabs.yaml @@ -1,5 +1,5 @@ tags: -- "collaborateur" + - "collaborateur" summary: ajout d'un nouveau collaborateur description: "" operationId: AjoutCollab diff --git a/API/routes/Collaborateurs/getCollabs.yaml b/API/routes/Collaborateurs/getCollabs.yaml index 75079fe..9996399 100644 --- a/API/routes/Collaborateurs/getCollabs.yaml +++ b/API/routes/Collaborateurs/getCollabs.yaml @@ -1,6 +1,5 @@ tags: - - "collaborateurs" - - "référents" + - "collaborateur" summary: rechercher tous les collaborateurs operationId: ChercherCollab description: | @@ -8,7 +7,8 @@ description: | parameters: - $ref: '../../parameters/CollabsId.yaml' - $ref: '../../parameters/Anciens.yaml' -- $ref: '../../parameters/Referent.yaml' +- $ref: '../../parameters/Roles.yaml' +- $ref: '../../parameters/BuIds.yaml' responses: '200': description: résultats de la recherche diff --git a/API/routes/Collaborateurs/getCollabsAgence.yaml b/API/routes/Collaborateurs/getCollabsAgence.yaml index 99a116b..d9f5382 100644 --- a/API/routes/Collaborateurs/getCollabsAgence.yaml +++ b/API/routes/Collaborateurs/getCollabsAgence.yaml @@ -1,13 +1,12 @@ tags: - - "collaborateurs" - - "référents" + - "collaborateur" summary: rechercher tous les collaborateurs d'un Business-unit operationId: ChercherCollabAgence description: | Cette requette demande de récupérer tous les collaborateurs existant au sein d'une agence parameters: - $ref: '../../parameters/AgenceId.yaml' -- $ref: '../../parameters/Referent.yaml' +- $ref: '../../parameters/Roles.yaml' responses: '200': description: résultats de la recherche diff --git a/API/routes/Collaborateurs/getCollabsBU.yaml b/API/routes/Collaborateurs/getCollabsBU.yaml index 31b32b1..8321ae0 100644 --- a/API/routes/Collaborateurs/getCollabsBU.yaml +++ b/API/routes/Collaborateurs/getCollabsBU.yaml @@ -1,13 +1,12 @@ tags: - - "collaborateurs" - - "référents" + - "collaborateur" summary: rechercher tous les collaborateurs d'un Business-unit operationId: ChercherCollabBU description: | Cette requette demande de récupérer tous les collaborateurs existant au sein d'une business-unit parameters: - $ref: '../../parameters/BuId.yaml' -- $ref: '../../parameters/Referent.yaml' +- $ref: '../../parameters/Roles.yaml' responses: '200': description: résultats de la recherche diff --git a/API/routes/Collaborateurs/getCollabsRef.yaml b/API/routes/Collaborateurs/getCollabsRef.yaml index 4861f9c..d4b1c2b 100644 --- a/API/routes/Collaborateurs/getCollabsRef.yaml +++ b/API/routes/Collaborateurs/getCollabsRef.yaml @@ -1,9 +1,9 @@ tags: - - "collaborateurs" + - "collaborateur" summary: rechercher tous les collaborateurs d'un référent operationId: ChercherCollabRef description: | - Cette requette demande de récupérer tous les collaborateurs existant au sein d'une business-unit + Cette requette demande de récupérer tous les collaborateurs d'un référent parameters: - $ref: '../../parameters/RefId.yaml' responses: diff --git a/API/routes/PE/patch1Periode.yaml b/API/routes/PE/patch1Periode.yaml index 8475d44..6d8ce11 100644 --- a/API/routes/PE/patch1Periode.yaml +++ b/API/routes/PE/patch1Periode.yaml @@ -1,5 +1,5 @@ tags: -- "péridode d'essai" + - "periode d'essai" summary: mettre à jour la première partie de la péridode d'essai description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 diff --git a/API/routes/PE/patchPeriode.yaml b/API/routes/PE/patchPeriode.yaml index 5e67d6b..4a0d3a8 100644 --- a/API/routes/PE/patchPeriode.yaml +++ b/API/routes/PE/patchPeriode.yaml @@ -1,5 +1,5 @@ tags: -- "péridode d'essai" + - "periode d'essai" summary: mettre à jour une péridode d'essai en cours description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 diff --git a/API/routes/PE/put1Periode.yaml b/API/routes/PE/put1Periode.yaml index ce586cf..3a9a47b 100644 --- a/API/routes/PE/put1Periode.yaml +++ b/API/routes/PE/put1Periode.yaml @@ -1,5 +1,5 @@ tags: -- "péridode d'essai" + - "periode d'essai" summary: mettre à jour la première partie de la péridode d'essai description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 diff --git a/API/routes/PE/putPeriode.yaml b/API/routes/PE/putPeriode.yaml index 9522df1..b4bae39 100644 --- a/API/routes/PE/putPeriode.yaml +++ b/API/routes/PE/putPeriode.yaml @@ -1,5 +1,5 @@ tags: -- "péridode d'essai" + - "periode d'essai" summary: mettre à jour une péridode d'essai description: | La différence entre la première et celle en cours est que, si une période d'essai est prolongee, il y en a techniquement 2 diff --git a/API/routes/Referent/getRefCollabId.yaml b/API/routes/Referent/getRefCollabId.yaml index 96a9ea2..8ff8675 100644 --- a/API/routes/Referent/getRefCollabId.yaml +++ b/API/routes/Referent/getRefCollabId.yaml @@ -1,12 +1,11 @@ tags: - - "référent" -summary: rechercher le référent qui a le plus suivit -operationId: ChercherRefSuiviParDateCollabId + - "collaborateur" +summary: rechercher le référent actuel +operationId: ChercherRefActuelId description: | - rechercher le référent du collaborateur l’ayant le plus suivi depuis une date donnée à l'aide de son identifiant + rechercher le référent actuel du collaborateur à l'aide de son identifiant parameters: - $ref: '../../parameters/CollabId.yaml' -- $ref: '../../parameters/Date.yaml' responses: '200': description: résultat de la recherche diff --git a/API/routes/Referent/getRefCollabMail.yaml b/API/routes/Referent/getRefCollabMail.yaml index 6763b6c..fbf2289 100644 --- a/API/routes/Referent/getRefCollabMail.yaml +++ b/API/routes/Referent/getRefCollabMail.yaml @@ -1,12 +1,11 @@ tags: - - "référent" -summary: rechercher le référent qui a le plus suivit -operationId: ChercherRefSuiviParDateCollabMail + - "collaborateur" +summary: rechercher le référent actuel +operationId: ChercherRefActuelMail description: | - rechercher le référent du collaborateur l’ayant le plus suivi depuis une date donnée à l'aide de son mail apside + rechercher le référent actuel du collaborateur l'aide de son mail apside parameters: - $ref: '../../parameters/MailApside.yaml' -- $ref: '../../parameters/Date.yaml' responses: '200': description: résultat de la recherche diff --git a/API/routes/Referents/getRefsCollabId.yaml b/API/routes/Referents/getRefsCollabId.yaml index 971bc65..f2f8583 100644 --- a/API/routes/Referents/getRefsCollabId.yaml +++ b/API/routes/Referents/getRefsCollabId.yaml @@ -1,5 +1,5 @@ tags: - - "référents" + - "collaborateur" summary: rechercher les référents operationId: ChercherRefCollabId description: | diff --git a/API/routes/Referents/getRefsCollabMail.yaml b/API/routes/Referents/getRefsCollabMail.yaml index eb2e3c6..81d6ada 100644 --- a/API/routes/Referents/getRefsCollabMail.yaml +++ b/API/routes/Referents/getRefsCollabMail.yaml @@ -1,5 +1,5 @@ tags: - - "référents" + - "collaborateur" summary: rechercher les référents operationId: ChercherRefCollabMail description: | diff --git a/API/routes/_index.yaml b/API/routes/_index.yaml index 839d252..8f720d5 100644 --- a/API/routes/_index.yaml +++ b/API/routes/_index.yaml @@ -69,7 +69,7 @@ $ref: "./Agences/postAgence.yaml" # Endpoints agence unique -/agence/{agenceId}: +/agences/{agenceId}: get: $ref: "./Agences/getAgence.yaml" put: