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

swagger/definitions/index.yml

@@ -25,6 +25,8 @@ contactable_inboxes:
   $ref: ./resource/contactable_inboxes.yml
 account:
   $ref: ./resource/account.yml
+platform_account:
+  $ref: ./resource/platform_account.yml
 team:
   $ref: ./resource/team.yml
 integrations_app:
@@ -78,6 +80,15 @@ extended_message:
 
 # REQUEST
 
+account_create_update_payload:
+  $ref: ./request/account/create_update_payload.yml
+
+agent_bot_create_update_payload:
+  $ref: ./request/agent_bot/create_update_payload.yml
+
+user_create_update_payload:
+  $ref: ./request/account/create_update_payload.yml
+
 ## contact
 contact_create:
   $ref: ./request/contact/create.yml

swagger/definitions/request/account/create_update_payload.yml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Name of the account

swagger/definitions/request/agent_bot/create_update_payload.yml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  name:
+    type: string
+    description: The name of the agent bot
+  description:
+    type: string
+    description: The description about the agent bot
+  outgoing_url:
+    type: string
+    description: The webhook URL for the bot

swagger/definitions/request/user/create_update_payload.yml

@@ -0,0 +1,12 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Name of the user
+  email:
+    type: string
+    description: Email of the user
+  password:
+    type: string
+    description: Password must contain uppercase, lowercase letters, number and a special character
+

swagger/definitions/resource/agent_bot.yml

@@ -3,12 +3,15 @@ properties:
   id:
     type: number
     description: ID of the agent bot
-  description:
-    type: string
-    description: The description about the agent bot
   name:
     type: string
     description: The name of the agent bot
+  description:
+    type: string
+    description: The description about the agent bot
+  account_id:
+    type: number
+    description: Account ID if it's an account specific bot
   outgoing_url:
     type: string
     description: The webhook URL for the bot

swagger/definitions/resource/platform_account.yml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  id:
+    type: number
+    description: Account ID
+  name:
+    type: string
+    description: Name of the account
+