feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374)

swagger/paths/application/agent_bots/create.yml

@@ -3,17 +3,24 @@ tags:
 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'
+security:
+  - userApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/agent_bot_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      $ref: '#/definitions/agent_bot'
-  401:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/agent_bot'
+  '401':
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/agent_bots/delete.yml

@@ -3,10 +3,20 @@ tags:
 operationId: delete-an-account-agent-bot
 summary: Delete an AgentBot
 description: Delete an AgentBot from the account
+security:
+  - userApiKey: []
 responses:
   200:
     description: Success
   401:
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
   404:
     description: The agent bot does not exist in the account
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/agent_bots/index.yml

@@ -3,14 +3,21 @@ tags:
 operationId: list-all-account-agent-bots
 summary: List all AgentBots
 description: List all agent bots available for the current account
+security:
+  - userApiKey: []
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      type: array
-      description: 'Array of agent bots'
-      items:
-        $ref: '#/definitions/agent_bot'
-
-  401:
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of agent bots'
+          items:
+            $ref: '#/components/schemas/agent_bot'
+  '401':
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/agent_bots/show.yml

@@ -3,12 +3,24 @@ tags:
 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
+security:
+  - userApiKey: []
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      $ref: '#/definitions/agent_bot'
-  401:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/agent_bot'
+  '401':
     description: Unauthorized
-  404:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
     description: The given agent bot ID does not exist in the account
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

swagger/paths/application/agent_bots/update.yml

@@ -3,16 +3,24 @@ tags:
 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'
+security:
+  - userApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/agent_bot_create_update_payload'
 responses:
-  200:
+  '200':
     description: Success
-    schema:
-      $ref: '#/definitions/agent_bot'
-  401:
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/agent_bot'
+  '401':
     description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'