KumiSystems/Chatwoot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Chore: Custom filter api docs updated (#3668)

Browse source
This commit is contained in:
Tejaswini Chile 2022-01-04 13:10:29 +05:30 committed by GitHub
parent 3e8ae3865f
commit e304ad27cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 211 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
swagger/paths/application/contacts/filter.yml Normal file
View file

@ -0,0 +1,55 @@
tags:
- Contact
operationId: contactFilter
description: Filter contacts with custom filter options and pagination
summary: Contact Filter
security:
- userApiKey: []
- agentBotApiKey: []
parameters:
- name: page
in: query
type: integer
- name: payload
in: body
required: true
schema:
type: array
items:
type: object
properties:
attribute_key:
type: string
description: filter attribute name
filter_operator:
type: string
description: filter operator name
enum: [ equal_to, not_equal_to, contains, does_not_contain ]
values:
type: array
items:
type: string
description: array of the attribute values to filter
query_operator:
type: string
description: query operator name
enum: [ AND, OR ]
example:
- attribute_key: 'name'
filter_operator: 'equal_to'
values: ['en']
query_operator: 'AND'
- attribute_key: 'country_code'
filter_operator: 'equal_to'
values: ['us']
query_operator: nil
responses:
200:
description: Success
schema:
$ref: '#/definitions/contact_list'
400:
description: Bad Request Error
schema:
$ref: '#/definitions/bad_request_error'

12
swagger/paths/application/conversation/filter.yml
View file

@ -24,6 +24,7 @@ parameters:
filter_operator: filter_operator:
type: string type: string
description: filter operator name description: filter operator name
enum: [ equal_to, not_equal_to, contains, does_not_contain ]
values: values:
type: array type: array
items: items:
@ -32,6 +33,17 @@ parameters:
query_operator: query_operator:
type: string type: string
description: query operator name description: query operator name
enum: [ AND, OR ]
example:
- attribute_key: 'browser_language'
filter_operator: 'not_eq'
values: ['en']
query_operator: 'AND'
- attribute_key: 'status'
filter_operator: 'eq'
values: ['pending']
query_operator: nil
responses: responses:
200: 200:
description: Success description: Success

5
swagger/paths/index.yml
View file

@ -164,6 +164,11 @@
$ref: ./application/contacts/conversations.yml $ref: ./application/contacts/conversations.yml
/api/v1/accounts/{account_id}/contacts/search: /api/v1/accounts/{account_id}/contacts/search:
$ref: ./application/contacts/search.yml $ref: ./application/contacts/search.yml
/api/v1/accounts/{account_id}/contacts/filter:
parameters:
- $ref: '#/parameters/account_id'
post:
$ref: ./application/contacts/filter.yml
/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes: /api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes:
$ref: ./application/contact_inboxes/create.yml $ref: ./application/contact_inboxes/create.yml
/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes: /api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes:

140
swagger/swagger.json
View file

@ -1571,6 +1571,114 @@
} }
} }
}, },
"/api/v1/accounts/{account_id}/contacts/filter": {
"parameters": [
{
"$ref": "#/parameters/account_id"
}
],
"post": {
"tags": [
"Contact"
],
"operationId": "contactFilter",
"description": "Filter contacts with custom filter options and pagination",
"summary": "Contact Filter",
"security": [
{
"userApiKey": [
]
},
{
"agentBotApiKey": [
]
}
],
"parameters": [
{
"name": "page",
"in": "query",
"type": "integer"
},
{
"name": "payload",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_key": {
"type": "string",
"description": "filter attribute name"
},
"filter_operator": {
"type": "string",
"description": "filter operator name",
"enum": [
"equal_to",
"not_equal_to",
"contains",
"does_not_contain"
]
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "array of the attribute values to filter"
},
"query_operator": {
"type": "string",
"description": "query operator name",
"enum": [
"AND",
"OR"
]
}
}
},
"example": [
{
"attribute_key": "name",
"filter_operator": "equal_to",
"values": [
"en"
],
"query_operator": "AND"
},
{
"attribute_key": "country_code",
"filter_operator": "equal_to",
"values": [
"us"
],
"query_operator": "nil"
}
]
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/contact_list"
}
},
"400": {
"description": "Bad Request Error",
"schema": {
"$ref": "#/definitions/bad_request_error"
}
}
}
}
},
"/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes": { "/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes": {
"post": { "post": {
"tags": [ "tags": [
@ -1879,7 +1987,13 @@
}, },
"filter_operator": { "filter_operator": {
"type": "string", "type": "string",
"description": "filter operator name" "description": "filter operator name",
"enum": [
"equal_to",
"not_equal_to",
"contains",
"does_not_contain"
]
}, },
"values": { "values": {
"type": "array", "type": "array",
@ -1890,10 +2004,32 @@
}, },
"query_operator": { "query_operator": {
"type": "string", "type": "string",
"description": "query operator name" "description": "query operator name",
"enum": [
"AND",
"OR"
]
} }
} }
},
"example": [
{
"attribute_key": "browser_language",
"filter_operator": "not_eq",
"values": [
"en"
],
"query_operator": "AND"
},
{
"attribute_key": "status",
"filter_operator": "eq",
"values": [
"pending"
],
"query_operator": "nil"
} }
]
} }
} }
], ],