chore: Add Swagger Doc for Team Members (#4390)

Add swagger documentation for Team Members APIs
2022-04-05 16:05:49 +05:30
parent 2595e774e5
commit 7a8aa4ca2e
41 changed files with 440 additions and 94 deletions
--- a/swagger/paths/application/inboxes/create.yml
+++ b/swagger/paths/application/inboxes/create.yml
@@ -1,6 +1,6 @@
 post:
  tags:
-    - Inbox
+    - Inboxes
  operationId: inboxCreation
  summary: Create an inbox
  description: You can create more than one website inbox in each account
--- a/swagger/paths/application/inboxes/get_agent_bot.yml
+++ b/swagger/paths/application/inboxes/get_agent_bot.yml
@@ -1,6 +1,6 @@
 get:
  tags:
-    - Inbox
+    - Inboxes
  operationId: getInboxAgentBot
  summary: Show Inbox Agent Bot
  description: See if an agent bot is associated to the Inbox
--- a/swagger/paths/application/inboxes/inbox_members/create.yml
+++ b/swagger/paths/application/inboxes/inbox_members/create.yml
@@ -1,5 +1,5 @@
 tags:
-  - Inbox
+  - Inboxes
 operationId: add-new-agent-to-inbox
 summary: Add a New Agent
 description: Add a new Agent to Inbox
--- a/swagger/paths/application/inboxes/inbox_members/delete.yml
+++ b/swagger/paths/application/inboxes/inbox_members/delete.yml
@@ -1,5 +1,5 @@
 tags:
-  - Inbox
+  - Inboxes
 operationId: delete-agent-in-inbox
 summary: Remove an Agent from Inbox
 description: Remove an Agent from Inbox
--- a/swagger/paths/application/inboxes/inbox_members/show.yml
+++ b/swagger/paths/application/inboxes/inbox_members/show.yml
@@ -1,5 +1,5 @@
 tags:
-  - Inbox
+  - Inboxes
 operationId: get-inbox-members
 summary: List Agents in Inbox
 description: Get Details of Agents in an Inbox
--- a/swagger/paths/application/inboxes/inbox_members/update.yml
+++ b/swagger/paths/application/inboxes/inbox_members/update.yml
@@ -1,5 +1,5 @@
 tags:
-  - Inbox
+  - Inboxes
 operationId: update-agents-in-inbox
 summary: Update Agents in Inbox
 description: All agents except the one passed in params will be removed
--- a/swagger/paths/application/inboxes/index.yml
+++ b/swagger/paths/application/inboxes/index.yml
@@ -1,6 +1,6 @@
 get:
  tags:
-    - Inbox
+    - Inboxes
  operationId: listAllInboxes
  summary: List all inboxes
  description: List all inboxes available in the current account
--- a/swagger/paths/application/inboxes/set_agent_bot.yml
+++ b/swagger/paths/application/inboxes/set_agent_bot.yml
@@ -1,6 +1,6 @@
 post:
  tags:
-    - Inbox
+    - Inboxes
  operationId: updateAgentBot
  summary: Add or remove agent bot
  description: To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null
--- a/swagger/paths/application/inboxes/show.yml
+++ b/swagger/paths/application/inboxes/show.yml
@@ -1,6 +1,6 @@
 get:
  tags:
-    - Inbox
+    - Inboxes
  operationId: GetInbox
  summary: Get an inbox
  description: Get an inbox available in the current account
--- a/swagger/paths/application/inboxes/update.yml
+++ b/swagger/paths/application/inboxes/update.yml
@@ -1,6 +1,6 @@
 patch:
  tags:
-    - Inbox
+    - Inboxes
  operationId: updateInbox
  summary: Update Inbox
  description: Add avatar and disable auto assignment for an inbox