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/agents/create.yml
+++ b/swagger/paths/application/agents/create.yml
@@ -1,5 +1,5 @@
 tags:
-  - Agent
+  - Agents
 operationId: add-new-agent-to-account
 summary: Add a New Agent
 description: Add a new Agent to Account
--- a/swagger/paths/application/agents/delete.yml
+++ b/swagger/paths/application/agents/delete.yml
@@ -1,5 +1,5 @@
 tags:
-  - Agent
+  - Agents
 operationId: delete-agent-from-account
 summary: Remove an Agent from Account
 description: Remove an Agent from Account
--- a/swagger/paths/application/agents/index.yml
+++ b/swagger/paths/application/agents/index.yml
@@ -1,5 +1,5 @@
 tags:
-  - Agent
+  - Agents
 operationId: get-account-agents
 summary: List Agents in Account
 description: Get Details of Agents in an Account
--- a/swagger/paths/application/agents/update.yml
+++ b/swagger/paths/application/agents/update.yml
@@ -1,5 +1,5 @@
 tags:
-  - Agent
+  - Agents
 operationId: update-agent-in-account
 summary: Update Agent in Account
 description: Update an Agent in Account
--- a/swagger/paths/application/canned_responses/create.yml
+++ b/swagger/paths/application/canned_responses/create.yml
@@ -1,5 +1,5 @@
 tags:
-  - Canned Response
+  - Canned Responses
 operationId: add-new-canned-response-to-account
 summary: Add a New Canned Response
 description: Add a new Canned Response to Account
--- a/swagger/paths/application/canned_responses/delete.yml
+++ b/swagger/paths/application/canned_responses/delete.yml
@@ -1,5 +1,5 @@
 tags:
-  - Canned Response
+  - Canned Responses
 operationId: delete-canned-response-from-account
 summary: Remove a Canned Response from Account
 description: Remove a Canned Response from Account
--- a/swagger/paths/application/canned_responses/index.yml
+++ b/swagger/paths/application/canned_responses/index.yml
@@ -1,5 +1,5 @@
 tags:
-  - Canned Response
+  - Canned Responses
 operationId: get-account-canned-response
 summary: List all Canned Responses in an Account
 description: Get Details of Canned Responses in an Account
--- a/swagger/paths/application/contacts/conversations.yml
+++ b/swagger/paths/application/contacts/conversations.yml
@@ -1,6 +1,6 @@
 get:
  tags:
-    - Contact
+    - Contacts
  operationId: contactConversations
  summary: Contact Conversations
  description: Get conversations associated to that contact
--- a/swagger/paths/application/contacts/crud.yml
+++ b/swagger/paths/application/contacts/crud.yml
@@ -8,7 +8,7 @@ parameters:

 get:
  tags:
-    - Contact
+    - Contacts
  operationId: contactDetails
  summary: Show Contact
  description: Get a contact belonging to the account using ID
@@ -24,7 +24,7 @@ get:

 put:
  tags:
-    - Contact
+    - Contacts
  operationId: contactUpdate
  summary: Update Contact
  description: Update a contact belonging to the account using ID
@@ -46,7 +46,7 @@ put:

 delete:
  tags:
-    - Contact
+    - Contacts
  operationId: contactDelete
  summary: Delete Contact
  responses:
--- a/swagger/paths/application/contacts/filter.yml
+++ b/swagger/paths/application/contacts/filter.yml
@@ -1,5 +1,5 @@
 tags:
-  - Contact
+  - Contacts
 operationId: contactFilter
 description: Filter contacts with custom filter options and pagination
 summary: Contact Filter
--- a/swagger/paths/application/contacts/list_create.yml
+++ b/swagger/paths/application/contacts/list_create.yml
@@ -1,6 +1,6 @@
 get:
  tags:
-    - Contact
+    - Contacts
  operationId: contactList
  description: Listing all the resolved contacts with pagination (Page size = 15) . Resolved contacts are the ones with a value for identifier, email or phone number
  summary: List Contacts
@@ -20,7 +20,7 @@ get:

 post:
  tags:
-    - Contact
+    - Contacts
  operationId: contactCreate
  description: Create a new Contact
  summary: Create Contact
--- a/swagger/paths/application/contacts/search.yml
+++ b/swagger/paths/application/contacts/search.yml
@@ -1,6 +1,6 @@
 get:
  tags:
-    - Contact
+    - Contacts
  operationId: contactSearch
  description: Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
  summary: Search Contacts
--- a/swagger/paths/application/conversation/filter.yml
+++ b/swagger/paths/application/conversation/filter.yml
@@ -1,5 +1,5 @@
 tags:
-  - Conversation
+  - Conversations
 operationId: conversationFilter
 description: Filter conversations with custom filter options and pagination
 summary: Conversations Filter
--- a/swagger/paths/application/conversation/index.yml
+++ b/swagger/paths/application/conversation/index.yml
@@ -3,7 +3,7 @@ parameters:

 get:
  tags:
-    - Conversation
+    - Conversations
  operationId: conversationList
  description: List all the conversations with pagination
  summary: Conversations List
@@ -43,7 +43,7 @@ get:

 post:
  tags:
-    - Conversation
+    - Conversations
  operationId: newConversation
  summary: Create New Conversation
  description: "Creating a conversation in chatwoot requires a source id. \n\n Learn more about source_id: https://github.com/chatwoot/chatwoot/wiki/Building-on-Top-of-Chatwoot:-Importing-Existing-Contacts-and-Creating-Conversations"
--- a/swagger/paths/application/conversation/show.yml
+++ b/swagger/paths/application/conversation/show.yml
@@ -1,5 +1,5 @@
 tags:
-  - Conversation
+  - Conversations
 operationId: get-details-of-a-conversation
 summary: Conversation Details
 description: Get all details regarding a conversation with all messages in the conversation
--- a/swagger/paths/application/conversation/toggle_status.yml
+++ b/swagger/paths/application/conversation/toggle_status.yml
@@ -1,5 +1,5 @@
 tags:
-  - Conversation
+  - Conversations
 operationId: toggle-status-of-a-conversation
 summary: Toggle Status
 description: Toggles the status of the conversation between open and resolved
--- a/swagger/paths/application/conversation/update_last_seen.yml
+++ b/swagger/paths/application/conversation/update_last_seen.yml
@@ -1,6 +1,6 @@
 post:
  tags:
-    - Conversation
+    - Conversations
  operationId: conversationUpdateLastSeen
  summary: Update Last Seen
  description: Updates the last seen of the conversation so that conversations will have the bubbles in the agents screen
--- a/swagger/paths/application/custom_filters/create.yml
+++ b/swagger/paths/application/custom_filters/create.yml
@@ -1,5 +1,5 @@
 tags:
-  - Custom Filter
+  - Custom Filters
 operationId: create-a-custom-filter
 summary: Create a custom filter
 description: Create a custom filter in the account
--- a/swagger/paths/application/custom_filters/delete.yml
+++ b/swagger/paths/application/custom_filters/delete.yml
@@ -1,5 +1,5 @@
 tags:
-  - Custom Filter
+  - Custom Filters
 operationId: delete-a-custom-filter
 summary: Delete a custom filter
 description: Delete a custom filter from the account
--- a/swagger/paths/application/custom_filters/index.yml
+++ b/swagger/paths/application/custom_filters/index.yml
@@ -1,5 +1,5 @@
 tags:
-  - Custom Filter
+  - Custom Filters
 operationId: list-all-filters
 summary: List all custom filters
 description: List all custom filters in a category of a user
--- a/swagger/paths/application/custom_filters/show.yml
+++ b/swagger/paths/application/custom_filters/show.yml
@@ -1,5 +1,5 @@
 tags:
-  - Custom Filter
+  - Custom Filters
 operationId: get-details-of-a-single-custom-filter
 summary: Get a custom filter details
 description: Get the details of a custom filter in the account
--- a/swagger/paths/application/custom_filters/update.yml
+++ b/swagger/paths/application/custom_filters/update.yml
@@ -1,5 +1,5 @@
 tags:
-  - Custom Filter
+  - Custom Filters
 operationId: update-a-custom-filter
 summary: Update a custom filter
 description: Update a custom filter's attributes
--- 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
--- a/swagger/paths/application/team_members/create.yml
+++ b/swagger/paths/application/team_members/create.yml
@@ -0,0 +1,35 @@
+tags:
+  - Teams
+operationId: add-new-agent-to-team
+summary: Add a New Agent
+description: Add a new Agent to Team
+security:
+  - userApiKey: []
+parameters:
+  - name: data
+    in: body
+    required: true
+    schema:
+      type: object
+      required:
+          - user_ids
+      properties:
+        user_ids:
+          type: array
+          items:
+            type: integer
+          description: IDs of users to be added to the team
+responses:
+  200:
+    description: Success
+    schema:
+        type: array
+        description: 'Array of all active agents'
+        items:
+          $ref: '#/definitions/agent'
+  404:
+    description: Team not found
+  403:
+    description: Access denied
+  422:
+    description: User must exist
--- a/swagger/paths/application/team_members/delete.yml
+++ b/swagger/paths/application/team_members/delete.yml
@@ -0,0 +1,31 @@
+tags:
+  - Teams
+operationId: delete-agent-in-team
+summary: Remove an Agent from Team
+description: Remove an Agent from Team
+security:
+  - userApiKey: []
+parameters:
+  - name: data
+    in: body
+    required: true
+    schema:
+      type: object
+      required:
+        - team_id
+        - user_ids
+      properties:
+        user_ids:
+          type: array
+          items:
+            type: integer
+          description: IDs of users to be deleted from the team
+responses:
+  200:
+    description: Success
+  404:
+    description: Team not found
+  403:
+    description: Access denied
+  422:
+    description: User must exist
--- a/swagger/paths/application/team_members/index.yml
+++ b/swagger/paths/application/team_members/index.yml
@@ -0,0 +1,21 @@
+tags:
+  - Teams
+operationId: get-team-members
+summary: List Agents in Team
+description: Get Details of Agents in an Team
+security:
+  - userApiKey: []
+parameters:
+  - $ref: '#/parameters/team_id'
+responses:
+  200:
+    description: Success
+    schema:
+        type: array
+        description: 'Array of all agents in the team'
+        items:
+          $ref: '#/definitions/agent'
+  404:
+    description: Inbox not found
+  403:
+    description: Access denied
--- a/swagger/paths/application/team_members/update.yml
+++ b/swagger/paths/application/team_members/update.yml
@@ -0,0 +1,35 @@
+tags:
+  - Teams
+operationId: update-agents-in-team
+summary: Update Agents in Team
+description: All agents except the one passed in params will be removed
+security:
+  - userApiKey: []
+parameters:
+  - name: data
+    in: body
+    required: true
+    schema:
+      type: object
+      required:
+        - user_ids
+      properties:
+        user_ids:
+          type: array
+          items:
+            type: integer
+          description: IDs of users to be added to the team
+responses:
+  200:
+    description: Success
+    schema:
+        type: array
+        description: 'Array of all agents in the team'
+        items:
+          $ref: '#/definitions/agent'
+  404:
+    description: Team not found
+  403:
+    description: Access denied
+  422:
+    description: User must exist