docs(README): updating readme file for services (#613)

Co-authored-by: akshatdubeysf <77672713+akshatdubeysf@users.noreply.github.com>

Author: parul147

README.md

@@ -9,7 +9,7 @@
 
 [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=sourcefuse_loopback4-microservice-catalog)](https://sonarcloud.io/summary/new_code?id=sourcefuse_loopback4-microservice-catalog)
 
-The `Sourceloop` is a collection of pre-built microservices that aim to reduce time to market for Enterprise projects. Large enterprises usually face a similar set of challenges when developing cloud native platforms as part of digital transformation efforts or the creation of new products. The services are implemented as [LoopBack Extensions](https://loopback.io/doc/en/lb4/Extending-LoopBack-4.html), allowing you to install them into existing LoopBack applications or use the [LoopBack Command-line interface](https://loopback.io/doc/en/lb4/Command-line-interface.html) to generate standalone services. Our recommended approach is to deploy these services as standalone micro-services in Docker.
+The `Sourceloop` is a collection of pre-built microservices that aim to reduce time to market for enterprise projects. Large enterprises usually face a similar set of challenges when developing cloud native platforms as part of digital transformation efforts or the creation of new products. The services are implemented as [LoopBack Extensions](https://loopback.io/doc/en/lb4/Extending-LoopBack-4.html), allowing you to install them into existing LoopBack applications or use the [LoopBack Command-line interface](https://loopback.io/doc/en/lb4/Command-line-interface.html) to generate standalone services. Our recommended approach is to deploy these services as standalone micro-services in Docker.
 
 The current catalog consists of the following services:
 
@@ -21,6 +21,9 @@ The current catalog consists of the following services:
 - [video-conferencing-service](services/video-conferencing-service)
 - [bpmn-service](services/bpmn-service)
 - [chat-service](services/chat-service)
+- [feature-toggle-service](services/feature-toggle-service)
+- [payment-service](services/payment-service)
+- [search-service](services/search-service)
 
 This repository also contains a set of example projects in the [sandbox](sandbox) directory that can be run from `docker-compose`.
 
@@ -33,6 +36,12 @@ This repository also contains a set of example projects in the [sandbox](sandbox
 - [in-mail-example](sandbox/in-mail-example)
 - [scheduler-example](sandbox/scheduler-example)
 - [video-conferencing-ms-example](sandbox/video-conferencing-ms-example)
+- [chat-notification-pubnub-example](sandbox/chat-notification-pubnub-example)
+- [feature-toggle-example](sandbox/feature-toggle-example)
+- [payment-example](sandbox/payment-example)
+- [search-client-example](sandbox/search-client-example)
+- [search-ms-example](sandbox/search-ms-example)
+- [user-onboarding-example](sandbox/user-onboarding-example)
 
 ## Table of Contents
 
@@ -267,9 +276,9 @@ export class ExampleApplicationApplication extends BootMixin(
 
 ### DataSources and Migrations
 
-The `Sourceloop` can support any Loopback 4 [DataSource](https://loopback.io/doc/en/lb4/DataSource.html). While you may see existing `DataSource`s, it is not mandatory to use them.
+The `Sourceloop` can support any Loopback 4 [DataSource](https://loopback.io/doc/en/lb4/DataSource.html). While you may see existing `DataSources`, it is not mandatory to use them.
 
-The migrations required for this service are processed during the installation automatically if you set the `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or databases, they may be affected. In such a scenario, it is advised that you copy the migration files in your project root, using the `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### Production Deployment
 
@@ -279,6 +288,10 @@ Inside of the `sandbox` folder, you will find example applications and Dockerfil
 
 `sandbox` folder contains example applications and docker files that can be run independently to see the services in action. You can use [Docker Compose](https://docs.docker.com/compose/) to run the sandbox applications.
 
+## Sourceloop CLI
+
+The Sourceloop CLI is a command-line interface tool that one use to initialize, develop, scaffold, and maintain sourceloop applications directly from a command shell. Learn more about [Sourceloop CLI](packages/cli/README.md).
+
 ### Related Projects
 
 The `Sourceloop` utilizes many extensions created by SourceFuse.

services/audit-service/README.md

@@ -116,7 +116,7 @@ export  class  AuditDbDataSource  extends  juggler.DataSource implements  LifeCy
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `AUDIT_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `AUDIT_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `AUDIT_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or databases, they may be affected. In such a scenario, it is advised that you copy the migration files in your project root, using the `AUDIT_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### API Documentation
 

services/authentication-service/README.md

@@ -169,7 +169,7 @@ export class AuthenticationDbDataSource
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `AUTH_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `AUTH_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `AUTH_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or databases, they may be affected. In such a scenario, it is advised that you copy the migration files in your project root, using the `AUTH_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### Database Schema
 

services/bpmn-service/README.md

@@ -168,15 +168,15 @@ export class WorkflowProvider implements Provider<WorflowManager> {
 
 #### WorkerImplementationProvider
 
-Your workers are automatically initiated once a workflow is executed, to provide the implementation details of workers, you need to give implementation template of one such worker using the `WorkflowServiceBindings.WorkerImplementationFunction`, a default implementation is provided [here](/src/providers/worker-implementation.provider.ts). You also need to register individual worker commands using the `WorkflowServiceBindings.RegisterWorkerFunction` function;
+Your workers are automatically initiated once a workflow is executed, to provide the implementation details of workers, you need to give an implementation template of one such worker using the `WorkflowServiceBindings.WorkerImplementationFunction`, a default implementation is provided [here](/src/providers/worker-implementation.provider.ts). You also need to register individual worker commands using the `WorkflowServiceBindings.RegisterWorkerFunction` function;
 
 #### ExecutionInputValidationProvider
 
 If you need to validate the inputs of a workflow execution, you can bind a custom validation provider using `WorkflowServiceBindings.ExecutionInputValidatorFn` key. The microservice comes with a default implementation using [AJV](https://www.npmjs.com/package/ajv).
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `WORKFLOW_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `WORKFLOW_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `WORKFLOW_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or databases, they may be affected. In such a scenario, it is advised that you copy the migration files in your project root, using the `WORKFLOW_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 This project includes no migrations to seed your BPMN engine. If you are using Camunda BPM Run, you can use either the `resources` folder to seed a model, or you can config it to use a custom DB where you can seed your data. The steps to config Platform Run are given [here](https://camunda.com/blog/2020/03/introducing-camunda-bpm-run/).
 

services/chat-service/README.md

@@ -128,7 +128,7 @@ export class ChatDataSource
 
 ### Migrations
 
-The migrations required for this service are processed during the installation automatically if you set the `CHAT_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `CHAT_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `CHAT_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or databasea, they may be affected. In such a scenario, it is advised that you copy the migration files in your project root, using the `CHAT_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 ### API Documentation
 
@@ -150,4 +150,6 @@ Authorization: Bearer <token> where <token> is a JWT token signed using JWT issu
 400: Bad Request (Error message varies w.r.t API)
 201: No content: Empty Response
 
-#### API Details
+## API Details
+
+Visit the [OpenAPI spec docs](./openapi.md)

services/feature-toggle-service/README.md

@@ -64,7 +64,6 @@ npm i @sourceloop/feature-toggle-service
   ```
 - Set up a [Loopback4 Datasource](https://loopback.io/doc/en/lb4/DataSource.html) with `dataSourceName` property set to
   `FeatureToggleDbName`. You can see an example datasource [here](#setting-up-a-datasource).
-
 - Start the application
   `npm start`
 

services/in-mail-service/README.md

@@ -76,7 +76,7 @@ export class InmailDataSource
 
 ### Migration
 
-The migrations required for this service are processed during the installation automatically if you set the `INMAIL_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `INMAIL_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+The migrations required for this service are processed during the installation automatically if you set the `INMAIL_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or databases, they may be affected. In such a scenario, it is advised that you copy the migration files in your project root, using the `INMAIL_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
 
 #### Database Model
 
@@ -147,7 +147,7 @@ Authorization: Bearer <token> where <token> is a JWT token signed using JWT issu
 ```javascript
 {
   "threadId": "string", // Optional, add if you want the messages in a same thread
-  "groups": [ // You can define one or more receipients in a group array.
+  "groups": [ // You can define one or more recipients in a group array.
     {
       "party": "string", // email of the recipient
       "type": "to", // type can be to | cc | bcc
@@ -180,13 +180,13 @@ Authorization: Bearer <token> where <token> is a JWT token signed using JWT issu
 ```javascript
 {
   "id": "string", // id of the message
-  "version": "string" // API vewrsion
+  "version": "string" // API version
 }
 ```
 
 ##### PUT /mails/{messageId}
 
-**Description:** Update Drafted Messages such as modifying attachment, receipients, message body, subject etc.
+**Description:** Update Drafted Messages such as modifying attachment, recipients, message body, subject etc.
 
 **Request path Parameters:**
 
@@ -196,7 +196,7 @@ Authorization: Bearer <token> where <token> is a JWT token signed using JWT issu
 
 ```javascript
 {
-  "groups": [ // You can define one or more receipients in a group array.
+  "groups": [ // You can define one or more recipients in a group array.
     {
       "party": "string", // email of the recipient
       "type": "to", // type can be to | cc | bcc
@@ -229,7 +229,7 @@ Success Response:
 ```javascript
 {
   "id": "string", // id of the message
-  "version": "string" // API vewrsion
+  "version": "string" // API version
 }
 ```
 
@@ -309,13 +309,13 @@ Success Response:
 ```javascript
 {
   "version": "string", // the API version
-  "items": "Array<object>" // receipient/sender details which was restored from trash
+  "items": "Array<object>" // recipient/sender details which was restored from trash
 }
 ```
 
 ##### PATCH /mails/{messageId}/forward
 
-**Description:** Forward the mail to another receipient
+**Description:** Forward the mail to another recipient
 
 **Request path Parameter:**
 
@@ -328,7 +328,7 @@ Success Response:
   "groups": [ // you can specify more recipients in groups array for forwarding the mail to multiple recipients
     {
       "party": "string", // email of the recipient
-      "type": "to" | "bcc" | "cc", // receipient type
+      "type": "to" | "bcc" | "cc", // recipient type
     }
   ]
 }
@@ -345,7 +345,7 @@ Success Response:
 
 ##### PATCH /mails/{messageId}/send
 
-**Description:** Send the drafted mail to the receipent
+**Description:** Send the drafted mail to the recipient
 
 **Request path Parameter:**
 
@@ -391,7 +391,7 @@ filter: Object which contains attribute(s) key value pairs of thread model which
 ```javascript
 {
   "version": "string", // the API version
-  "item": "object" // item containg the thread and the related message, attachment and/or meta-data details
+  "item": "object" // item containing the thread and the related message, attachment and/or meta-data details
 }
 ```