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,20 @@
tags:
- AgentBots
operationId: create-an-agent-bot
summary: Create an Agent Bot
description: Create an agent bot
security:
- platformAppApiKey: []
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

View File

@@ -0,0 +1,14 @@
tags:
- AgentBots
operationId: delete-an-agent-bot
summary: Delete an AgentBot
description: Delete an AgentBot
security:
- platformAppApiKey: []
responses:
200:
description: Success
401:
description: Unauthorized
404:
description: The agent bot does not exist

View File

@@ -0,0 +1,17 @@
tags:
- AgentBots
operationId: list-all-agent-bots
summary: List all AgentBots
description: List all agent bots available
security:
- platformAppApiKey: []
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,16 @@
tags:
- AgentBots
operationId: get-details-of-a-single-agent-bot
summary: Get an agent bot details
description: Get the details of an agent bot
security:
- platformAppApiKey: []
responses:
200:
description: Success
schema:
$ref: '#/definitions/agent_bot'
401:
description: Unauthorized
404:
description: The given agent bot ID does not exist

View File

@@ -0,0 +1,20 @@
tags:
- AgentBots
operationId: update-an-agent-bot
summary: Update an agent bot
description: Update an agent bot's attributes
security:
- platformAppApiKey: []
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