From ef30d603c3e6d1a1da1060401115c552cd40d5b9 Mon Sep 17 00:00:00 2001
From: Rachid F <rf@artesi.xyz>
Date: Wed, 20 Dec 2023 15:20:14 +0100
Subject: [PATCH] :memo: Adding exmaples for GET crm/contact query

---
 packages/api/src/crm/contact/contact.controller.ts | 6 +++---
 packages/api/swagger/swagger-spec.json             | 3 +++
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/packages/api/src/crm/contact/contact.controller.ts b/packages/api/src/crm/contact/contact.controller.ts
index c16a3271f..2da12677f 100644
--- a/packages/api/src/crm/contact/contact.controller.ts
+++ b/packages/api/src/crm/contact/contact.controller.ts
@@ -34,7 +34,7 @@ export class ContactController {
   })
   @ApiQuery({ name: 'integrationId', required: true, type: String })
   @ApiQuery({ name: 'linkedUserId', required: true, type: String })
-  @ApiQuery({ name: 'remote_data', required: false, type: Boolean })
+  @ApiQuery({ name: 'remote_data', required: false, type: Boolean, description: 'Set to true to include data from the original CRM software.' })
   @ApiCustomResponse(ContactResponse)
   @Get()
   getContacts(
@@ -55,7 +55,7 @@ export class ContactController {
     description: 'Retrive a contact in any supported CRM',
   })
   @ApiParam({ name: 'id', required: true, type: String })
-  @ApiQuery({ name: 'remote_data', required: false, type: Boolean })
+  @ApiQuery({ name: 'remote_data', required: false, type: Boolean, description: 'Set to true to include data from the original CRM software.' })
   @ApiCustomResponse(ContactResponse)
   @Get(':id')
   getContact(
@@ -96,7 +96,7 @@ export class ContactController {
   })
   @ApiQuery({ name: 'integrationId', required: true, type: String })
   @ApiQuery({ name: 'linkedUserId', required: true, type: String })
-  @ApiQuery({ name: 'remote_data', required: false, type: Boolean })
+  @ApiQuery({ name: 'remote_data', required: false, type: Boolean, description: 'Set to true to include data from the original CRM software.' })
   @ApiBody({ type: UnifiedContactInput, isArray: true })
   @ApiCustomResponse(ContactResponse)
   @Post('batch')
diff --git a/packages/api/swagger/swagger-spec.json b/packages/api/swagger/swagger-spec.json
index 8eeb584fc..cafb9af39 100644
--- a/packages/api/swagger/swagger-spec.json
+++ b/packages/api/swagger/swagger-spec.json
@@ -658,6 +658,7 @@
             "name": "remote_data",
             "required": false,
             "in": "query",
+            "description": "Set to true to include data from the original CRM software.",
             "schema": {
               "type": "boolean"
             }
@@ -803,6 +804,7 @@
             "name": "remote_data",
             "required": false,
             "in": "query",
+            "description": "Set to true to include data from the original CRM software.",
             "schema": {
               "type": "boolean"
             }
@@ -861,6 +863,7 @@
             "name": "remote_data",
             "required": false,
             "in": "query",
+            "description": "Set to true to include data from the original CRM software.",
             "schema": {
               "type": "boolean"
             }