feat: Ability to search conversation with message content (#1265)
- API end point which takes message content as search parameter - end point supports additional filtering with labels and inbox ids - swagger doc
This commit is contained in:
@@ -39,6 +39,48 @@ get:
|
||||
$ref: '#/definitions/bad_request_error'
|
||||
description: Access denied
|
||||
|
||||
get:
|
||||
tags:
|
||||
- Conversation
|
||||
operationId: conversationSearch
|
||||
description: Search for conversations containing a messages with the query string
|
||||
summary: Conversations Search
|
||||
parameters:
|
||||
- name: q
|
||||
in: query
|
||||
type: string
|
||||
- name: assignee_type
|
||||
in: query
|
||||
type: string
|
||||
enum: ['me', 'unassigned', 'all']
|
||||
- name: status
|
||||
in: query
|
||||
type: string
|
||||
enum: ['open', 'resolved', 'bot']
|
||||
- name: page
|
||||
in: query
|
||||
type: integer
|
||||
- name: inbox_id
|
||||
in: query
|
||||
type: integer
|
||||
- name: labels
|
||||
in: query
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/conversation_list'
|
||||
400:
|
||||
description: Bad Request Error
|
||||
schema:
|
||||
$ref: '#/definitions/bad_request_error'
|
||||
description: Access denied
|
||||
|
||||
|
||||
post:
|
||||
tags:
|
||||
- Conversation
|
||||
|
||||
@@ -283,10 +283,15 @@
|
||||
"tags": [
|
||||
"Conversation"
|
||||
],
|
||||
"operationId": "conversationList",
|
||||
"description": "List all the conversations with pagination",
|
||||
"summary": "Conversations List",
|
||||
"operationId": "conversationSearch",
|
||||
"description": "Search for conversations containing a messages with the query string",
|
||||
"summary": "Conversations Search",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "q",
|
||||
"in": "query",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "assignee_type",
|
||||
"in": "query",
|
||||
@@ -295,8 +300,7 @@
|
||||
"me",
|
||||
"unassigned",
|
||||
"all"
|
||||
],
|
||||
"required": true
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
@@ -306,14 +310,12 @@
|
||||
"open",
|
||||
"resolved",
|
||||
"bot"
|
||||
],
|
||||
"required": true
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"in": "query",
|
||||
"type": "integer",
|
||||
"required": true
|
||||
"type": "integer"
|
||||
},
|
||||
{
|
||||
"name": "inbox_id",
|
||||
|
||||
Reference in New Issue
Block a user