Merge pull request #186 from panoratech/annotate-docs-crmcontact

📝 Adding exmaples for GET crm/contact query
panoratech · Dec 20, 2023 · fca393c · fca393c
2 parents 20f7a30 + ef30d60
commit fca393c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git 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
@@ -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"
             }