From f7d1428c6f3aeff5d17065bfaf8e0d7ac67fc5e1 Mon Sep 17 00:00:00 2001 From: PEDROLI Benjamin <benjamin.pedroli@soprasteria.com> Date: Thu, 11 Mar 2021 10:36:18 +0100 Subject: [PATCH] add back information --- docs/pilote/Pilote - TS - Back/application/deploy.md | 4 +++- docs/pilote/Pilote - TS - Back/functionalities/routes.md | 3 ++- .../getting_started/launch_local_application.md | 2 ++ docs/pilote/Pilote - TS - Front/functionalities/functions.md | 4 +++- 4 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/pilote/Pilote - TS - Back/application/deploy.md b/docs/pilote/Pilote - TS - Back/application/deploy.md index cf41a3f..9b1701f 100644 --- a/docs/pilote/Pilote - TS - Back/application/deploy.md +++ b/docs/pilote/Pilote - TS - Back/application/deploy.md @@ -2,4 +2,6 @@ For each environment, the CI-CD is implemented. -Once, you commit on 'dev' branch or 'rec' branch, the pipeline linked is running. \ No newline at end of file +Once, you commit on 'dev' branch or 'rec' branch, the pipeline linked is running. + +On master branch, only build is set on the pipeline. \ No newline at end of file diff --git a/docs/pilote/Pilote - TS - Back/functionalities/routes.md b/docs/pilote/Pilote - TS - Back/functionalities/routes.md index ea55a46..0a93486 100644 --- a/docs/pilote/Pilote - TS - Back/functionalities/routes.md +++ b/docs/pilote/Pilote - TS - Back/functionalities/routes.md @@ -21,8 +21,9 @@ This section explains the different API route. - `/api/beneficiaire`: Get all usager known from Postgre database. -- `/api/beneficiaire/create'`: This rotue is used in order to store Usager domain and his trigger proccess from Cozy. +- `/api/beneficiaire/create'`: This rotue is used in order to store Usager domain and his trigger proccess from Cozy. This route is protected by a COZY_SECRET env variable token. This token is generated by us. If you change it, you need to inform Cozy team because this token is store in their side also. +- `/api/beneficiaire/remove'`: This rotue is used in order to remove Usager domain and his trigger proccess. Only availabe by POST. This route is not accessible from any part of TS FRONT application. Protected rout by the same token of create route. # Cozy diff --git a/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md b/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md index 942de67..7efb6e2 100644 --- a/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md +++ b/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md @@ -37,3 +37,5 @@ To start test defined just run the command in a PowerShell or Windows Powershell ``` yarn test:watch ``` + +Don't forget to uncomment ending row into beneficiary.service.ts file before to run the above command. \ No newline at end of file diff --git a/docs/pilote/Pilote - TS - Front/functionalities/functions.md b/docs/pilote/Pilote - TS - Front/functionalities/functions.md index e48e624..71ca1f2 100644 --- a/docs/pilote/Pilote - TS - Front/functionalities/functions.md +++ b/docs/pilote/Pilote - TS - Front/functionalities/functions.md @@ -8,4 +8,6 @@ You are getting all usager known. # Sharing -For each beneficiary, you can ask the sharing. It means that you will be redirect into the public page of the cozy usager. In the same time, one process is running in order to send the sms. This sms contain one sharecode in order to provide some right on the cozy usager. \ No newline at end of file +For each beneficiary, you can ask the sharing. It means that you will be redirect into the public page of the cozy usager. In the same time, one process is running in order to send the sms. This sms contain one sharecode in order to provide some right on the cozy usager. + +In order to help you to understand this process, you can check : Pilote - TS - Back/project_architecture/Partage_SMS.png \ No newline at end of file -- GitLab