chore: Add swagger docs for Canned Responses (#4295)

fixes: #3962
This commit is contained in:
Sojan Jose
2022-03-26 00:43:44 +05:30
committed by GitHub
parent 971755b845
commit e0f29b9d81
11 changed files with 328 additions and 3 deletions

View File

@@ -0,0 +1,21 @@
tags:
- Canned Response
operationId: add-new-canned-response-to-account
summary: Add a New Canned Response
description: Add a new Canned Response to Account
security:
- userApiKey: []
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/canned_response_create_update_payload'
responses:
200:
description: Success
schema:
description: 'Newly Created Canned Response'
$ref: '#/definitions/canned_response'
403:
description: Access denied

View File

@@ -0,0 +1,20 @@
tags:
- Canned Response
operationId: delete-canned-response-from-account
summary: Remove a Canned Response from Account
description: Remove a Canned Response from Account
security:
- userApiKey: []
parameters:
- in: path
name: id
type: integer
required: true
description: The ID of the canned response to be deleted
responses:
200:
description: Success
404:
description: Canned Response not found
403:
description: Access denied

View File

@@ -0,0 +1,17 @@
tags:
- Canned Response
operationId: get-account-canned-response
summary: List all Canned Responses in an Account
description: Get Details of Canned Responses in an Account
security:
- userApiKey: []
responses:
200:
description: Success
schema:
type: array
description: 'Array of all canned responses'
items:
$ref: '#/definitions/canned_response'
403:
description: Access denied

View File

@@ -0,0 +1,28 @@
tags:
- Canned Response
operationId: update-canned-response-in-account
summary: Update Canned Response in Account
description: Update a Canned Response in Account
security:
- userApiKey: []
parameters:
- in: path
name: id
type: integer
required: true
description: The ID of the canned response to be updated.
- name: data
in: body
required: true
schema:
$ref: '#/definitions/canned_response_create_update_payload'
responses:
200:
description: Success
schema:
description: 'The updated canned response'
$ref: '#/definitions/canned_response'
404:
description: Agent not found
403:
description: Access denied