chore: Add Swagger docs for Platform APIs (#2349)

This commit is contained in:
Sojan Jose
2021-05-31 10:58:43 +05:30
committed by GitHub
parent cc75a668cb
commit 9d16e52e33
37 changed files with 2315 additions and 837 deletions

View File

@@ -0,0 +1,19 @@
tags:
- Account AgentBots
operationId: create-an-account-agent-bot
summary: Create an Agent Bot
description: Create an agent bot in the account
parameters:
- $ref: '#/parameters/account_id'
- name: data
in: body
required: true
schema:
$ref: '#/definitions/agent_bot_create_update_payload'
responses:
200:
description: Success
schema:
$ref: '#/definitions/agent_bot'
401:
description: Unauthorized

View File

@@ -0,0 +1,12 @@
tags:
- Account AgentBots
operationId: delete-an-account-agent-bot
summary: Delete an AgentBot
description: Delete an AgentBot from the account
responses:
200:
description: Success
401:
description: Unauthorized
404:
description: The agent bot does not exist in the account

View File

@@ -1,17 +1,16 @@
get:
tags:
- AgentBot
operationId: listAgentBots
summary: List all agentbots
description: List all available agentbots for the current installation
responses:
200:
description: Success
schema:
type: Array
description: 'List of agent bots'
$ref: '#/definitions/agent_bot'
404:
description: Inbox not found, Agent bot not found
403:
description: Access denied
tags:
- Account AgentBots
operationId: list-all-account-agent-bots
summary: List all AgentBots
description: List all agent bots available for the current account
responses:
200:
description: Success
schema:
type: array
description: 'Array of agent bots'
items:
- $ref: '#/definitions/agent_bot'
401:
description: Unauthorized

View File

@@ -0,0 +1,14 @@
tags:
- Account AgentBots
operationId: get-details-of-a-single-account-agent-bot
summary: Get an agent bot details
description: Get the details of an agent bot in the account
responses:
200:
description: Success
schema:
$ref: '#/definitions/agent_bot'
401:
description: Unauthorized
404:
description: The given agent bot ID does not exist in the account

View File

@@ -0,0 +1,18 @@
tags:
- Account AgentBots
operationId: update-an-account-agent-bot
summary: Update an agent bot
description: Update an agent bot's attributes
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/agent_bot_create_update_payload'
responses:
200:
description: Success
schema:
$ref: '#/definitions/agent_bot'
401:
description: Unauthorized