Chore: API Improvements (#2956)

- API to fetch info of a single inbox
- Document passing custom_attributes in the API
- Ability to filter contacts with contact identifier in search API

swagger/paths/contact/conversations.yml

@@ -2,8 +2,10 @@ get:
   tags:
     - Contact
   operationId: contactConversations
-  summary: Conversations
+  summary: Contact Conversations
+  description: Get conversations associated to that contact
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: id
       in: path
       type: number

swagger/paths/contact/crud.yml

@@ -3,7 +3,9 @@ get:
     - Contact
   operationId: contactDetails
   summary: Show Contact
+  description: Get a contact belonging to the account using ID
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: id
       in: path
       type: number
@@ -24,7 +26,9 @@ put:
     - Contact
   operationId: contactUpdate
   summary: Update Contact
+  description: Update a contact belonging to the account using ID
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: id
       in: path
       type: number

swagger/paths/contact/list_create.yml

@@ -2,9 +2,10 @@ get:
   tags:
     - Contact
   operationId: contactList
-  description: Listing all the contacts with pagination (Page size = 15)
+  description: Listing all the resolved contacts with pagination (Page size = 15) . Resolved contacts are the ones with a value for identifier, email or phone number
   summary: List Contacts
   parameters:
+    - $ref: '#/parameters/account_id'
     - $ref: '#/parameters/contact_sort_param'
     - $ref: '#/parameters/page'
   responses:
@@ -21,9 +22,10 @@ post:
   tags:
     - Contact
   operationId: contactCreate
-  description: Create New Contact
+  description: Create a new Contact
   summary: Create Contact
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: data
       in: body
       required: true

swagger/paths/contact/search.yml

@@ -2,9 +2,10 @@ get:
   tags:
     - Contact
   operationId: contactSearch
-  description: Search the contacts using a search key, currently supports email search (Page size = 15)
+  description: Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
   summary: Search Contacts
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: q
       in: query
       type: string