doc: Swagger for conversation priority API (#7172)

This commit is contained in:
Muhsin Keloth
2023-05-23 20:39:15 +05:30
committed by GitHub
parent 44b1047b90
commit 4807052c37
3 changed files with 101 additions and 0 deletions

View File

@@ -0,0 +1,28 @@
tags:
- Conversations
operationId: toggle-priority-of-a-conversation
summary: Toggle Priority
description: Toggles the priority of conversation
security:
- userApiKey: []
- agentBotApiKey: []
parameters:
- name: data
in: body
required: true
schema:
type: object
required:
- priority
properties:
priority:
type: string
enum: ["urgent", "high", "medium", "low", "none"]
description: "The priority of the conversation"
responses:
200:
description: Success
404:
description: Conversation not found
401:
description: Unauthorized

View File

@@ -267,6 +267,12 @@
- $ref: '#/parameters/conversation_id'
post:
$ref: ./application/conversation/toggle_status.yml
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority:
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/conversation_id'
post:
$ref: ./application/conversation/toggle_priority.yml
# Conversations Assignments

View File

@@ -2877,6 +2877,73 @@
}
}
},
"/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority": {
"parameters": [
{
"$ref": "#/parameters/account_id"
},
{
"$ref": "#/parameters/conversation_id"
}
],
"post": {
"tags": [
"Conversations"
],
"operationId": "toggle-priority-of-a-conversation",
"summary": "Toggle Priority",
"description": "Toggles the priority of conversation",
"security": [
{
"userApiKey": [
]
},
{
"agentBotApiKey": [
]
}
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"priority"
],
"properties": {
"priority": {
"type": "string",
"enum": [
"urgent",
"high",
"medium",
"low",
"none"
],
"description": "The priority of the conversation"
}
}
}
}
],
"responses": {
"200": {
"description": "Success"
},
"404": {
"description": "Conversation not found"
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments": {
"parameters": [
{