passage des urls référent vers les urls collaborateurs et ajouts de paramètres pour récupérer une liste de collaborateurs en fonction des roles et business units

modification_yanael
Yanaël GRETTE 4 years ago
parent f9af2e20d3
commit 6e9366b3dc
  1. 83
      API/_build/openapi.yaml
  2. 4
      API/openapi.yaml
  3. 8
      API/parameters/BuIds.yaml
  4. 17
      API/parameters/Roles.yaml
  5. 5
      API/parameters/_index.yaml
  6. 2
      API/routes/Collaborateur/Id/patchCollab.yaml
  7. 2
      API/routes/Collaborateur/Id/putCollab.yaml
  8. 2
      API/routes/Collaborateur/Mail/patchCollab.yaml
  9. 2
      API/routes/Collaborateur/Mail/putCollab.yaml
  10. 2
      API/routes/Collaborateur/postCollabs.yaml
  11. 6
      API/routes/Collaborateurs/getCollabs.yaml
  12. 5
      API/routes/Collaborateurs/getCollabsAgence.yaml
  13. 5
      API/routes/Collaborateurs/getCollabsBU.yaml
  14. 4
      API/routes/Collaborateurs/getCollabsRef.yaml
  15. 2
      API/routes/PE/patch1Periode.yaml
  16. 2
      API/routes/PE/patchPeriode.yaml
  17. 2
      API/routes/PE/put1Periode.yaml
  18. 2
      API/routes/PE/putPeriode.yaml
  19. 9
      API/routes/Referent/getRefCollabId.yaml
  20. 9
      API/routes/Referent/getRefCollabMail.yaml
  21. 2
      API/routes/Referents/getRefsCollabId.yaml
  22. 2
      API/routes/Referents/getRefsCollabMail.yaml
  23. 2
      API/routes/_index.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'

@ -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

@ -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

@ -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

@ -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:

@ -1,5 +1,5 @@
tags:
- "collaborateur"
- "collaborateur"
summary: mettre à jour un collaborateur
description: ""
operationId: MajCollabpatch

@ -1,5 +1,5 @@
tags:
- "collaborateur"
- "collaborateur"
summary: mettre à jour un collaborateur
description: ""
operationId: MajCollab

@ -1,5 +1,5 @@
tags:
- "collaborateur"
- "collaborateur"
summary: mettre à jour un collaborateur
description: ""
operationId: MajCollabpatchMail

@ -1,5 +1,5 @@
tags:
- "collaborateur"
- "collaborateur"
summary: mettre à jour un collaborateur
description: ""
operationId: MajCollabMail

@ -1,5 +1,5 @@
tags:
- "collaborateur"
- "collaborateur"
summary: ajout d'un nouveau collaborateur
description: ""
operationId: AjoutCollab

@ -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

@ -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

@ -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

@ -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:

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -1,5 +1,5 @@
tags:
- "référents"
- "collaborateur"
summary: rechercher les référents
operationId: ChercherRefCollabId
description: |

@ -1,5 +1,5 @@
tags:
- "référents"
- "collaborateur"
summary: rechercher les référents
operationId: ChercherRefCollabMail
description: |

@ -69,7 +69,7 @@
$ref: "./Agences/postAgence.yaml"
# Endpoints agence unique
/agence/{agenceId}:
/agences/{agenceId}:
get:
$ref: "./Agences/getAgence.yaml"
put:

Loading…
Cancel
Save