chore: Swagger doc for Conversation meta API (#4394)

fixes: https://github.com/chatwoot/chatwoot/issues/4327
This commit is contained in:
Sojan Jose
2022-04-11 16:43:09 +05:30
committed by GitHub
parent 9b5eb98c59
commit 1194188f13
6 changed files with 212 additions and 40 deletions

View File

@@ -12,17 +12,22 @@ get:
in: query
type: string
enum: ['me', 'unassigned', 'all', 'assigned']
required: true
default: 'all'
description: Filter conversations by assignee type.
- name: status
in: query
type: string
enum: ['open', 'resolved', 'pending']
required: true
- name: page
enum: ['open', 'resolved', 'pending', 'snoozed']
default: 'open'
description: Filter by conversation status.
- name: q
in: query
type: string
description: Filters conversations with messages containing the search term
- name: inbox_id
in: query
type: integer
required: true
- name: inbox_id
- name: team_id
in: query
type: integer
- name: labels
@@ -30,7 +35,12 @@ get:
type: array
items:
type: string
- name: page
in: query
type: integer
default: 1
description: paginate through conversations
responses:
200:
description: Success

View File

@@ -0,0 +1,53 @@
parameters:
- $ref: '#/parameters/account_id'
get:
tags:
- Conversations
operationId: conversationListMeta
description: Get open, unassigned and all Conversation counts
summary: Get Conversation Counts
parameters:
- name: status
in: query
type: string
enum: ['open', 'resolved', 'pending', 'snoozed']
default: 'open'
description: Filter by conversation status.
- name: q
in: query
type: string
description: Filters conversations with messages containing the search term
- name: inbox_id
in: query
type: integer
- name: team_id
in: query
type: integer
- name: labels
in: query
type: array
items:
type: string
responses:
200:
description: Success
schema:
type: object
properties:
meta:
type: object
properties:
mine_count:
type: number
unassigned_count:
type: number
assigned_count:
type: number
all_count:
type: number
400:
description: Bad Request Error
schema:
$ref: '#/definitions/bad_request_error'