chore: Add Swagger docs for Platform APIs (#2349)
This commit is contained in:
20
swagger/paths/platform/agent_bots/create.yml
Normal file
20
swagger/paths/platform/agent_bots/create.yml
Normal 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
|
||||
14
swagger/paths/platform/agent_bots/delete.yml
Normal file
14
swagger/paths/platform/agent_bots/delete.yml
Normal 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
|
||||
17
swagger/paths/platform/agent_bots/index.yml
Normal file
17
swagger/paths/platform/agent_bots/index.yml
Normal 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
|
||||
16
swagger/paths/platform/agent_bots/show.yml
Normal file
16
swagger/paths/platform/agent_bots/show.yml
Normal 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
|
||||
20
swagger/paths/platform/agent_bots/update.yml
Normal file
20
swagger/paths/platform/agent_bots/update.yml
Normal 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
|
||||
Reference in New Issue
Block a user