akadmin/chatwoot
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

add tags to swagger

Browse Source
This commit is contained in:
Tanmay Deep Sharma
2025-05-20 16:43:22 +07:00
parent 019a596a3e
commit 3b42191705
12 changed files with 87 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
developer-docs/docs.json
+3
View File
@@ -36,6 +36,9 @@
"Agents",
"Canned Responses",
"Contacts",
"Contact Labels",
"Conversation Assignments",
"Conversation Labels",
"Conversations",
"Custom Attributes",
"Custom Filters",
swagger/index.yml
+14 -5
View File
@@ -38,9 +38,9 @@ tags:
- name: Accounts
description: Account management APIs
- name: Account Users
description: Account Users management APIs
description: Account user management APIs
- name: AgentBots
description: Bot management APIs
description: Bot integrations
- name: Users
description: User management APIs
- name: Account AgentBots
@@ -51,6 +51,12 @@ tags:
description: Pre-defined responses for common queries
- name: Contacts
description: Contact management APIs
- name: Contact Labels
description: Manage contact labels
- name: Conversation Assignments
description: Manage conversation assignments
- name: Conversation Labels
description: Manage conversation labels
- name: Conversations
description: Conversation management APIs
- name: Custom Attributes
@@ -76,11 +82,11 @@ tags:
- name: Help Center
description: Knowledge base management
- name: Contacts API
description: Public APIs for contacts
description: Public contact APIs
- name: Conversations API
description: Public APIs for conversations
description: Public conversation APIs
- name: Messages API
description: Public APIs for messages
description: Public message APIs
- name: CSAT Survey Page
description: Customer satisfaction survey
x-tagGroups:
@@ -96,6 +102,9 @@ x-tagGroups:
- Agents
- Canned Responses
- Contacts
- Contact Labels
- Conversation Assignments
- Conversation Labels
- Conversations
- Custom Attributes
- Custom Filters
swagger/paths/application/contacts/labels.yml
+2 -2
View File
@@ -9,7 +9,7 @@ parameters:
get:
tags:
- Contacts
- Contact Labels
operationId: list-all-labels-of-a-contact
summary: List Labels
description: Lists all the labels of a contact
@@ -37,7 +37,7 @@ get:
post:
tags:
- Contacts
- Contact Labels
operationId: contact-add-labels
summary: Add Labels
description: Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.
swagger/paths/application/conversation/assignments.yml
+1 -1
View File
@@ -1,5 +1,5 @@
tags:
- Conversations
- Conversation Assignments
operationId: assign-a-conversation
summary: Assign Conversation
description: Assign a conversation to an agent or a team
swagger/paths/application/conversation/labels/create.yml
+1 -1
View File
@@ -1,5 +1,5 @@
tags:
- Conversations
- Conversation Labels
operationId: conversation-add-labels
summary: Add Labels
security:
swagger/paths/application/conversation/labels/index.yml
+1 -1
View File
@@ -1,5 +1,5 @@
tags:
- Conversations
- Conversation Labels
operationId: list-all-labels-of-a-conversation
summary: List Labels
security:
swagger/swagger.json
+25 -10
View File
@@ -2881,7 +2881,7 @@
],
"get": {
"tags": [
"Contacts"
"Contact Labels"
],
"operationId": "list-all-labels-of-a-contact",
"summary": "List Labels",
@@ -2928,7 +2928,7 @@
},
"post": {
"tags": [
"Contacts"
"Contact Labels"
],
"operationId": "contact-add-labels",
"summary": "Add Labels",
@@ -4862,7 +4862,7 @@
],
"post": {
"tags": [
"Conversations"
"Conversation Assignments"
],
"operationId": "assign-a-conversation",
"summary": "Assign Conversation",
@@ -4946,7 +4946,7 @@
],
"get": {
"tags": [
"Conversations"
"Conversation Labels"
],
"operationId": "list-all-labels-of-a-conversation",
"summary": "List Labels",
@@ -4993,7 +4993,7 @@
},
"post": {
"tags": [
"Conversations"
"Conversation Labels"
],
"operationId": "conversation-add-labels",
"summary": "Add Labels",
@@ -11929,11 +11929,11 @@
},
{
"name": "Account Users",
"description": "Account Users management APIs"
"description": "Account user management APIs"
},
{
"name": "AgentBots",
"description": "Bot management APIs"
"description": "Bot integrations"
},
{
"name": "Users",
@@ -11955,6 +11955,18 @@
"name": "Contacts",
"description": "Contact management APIs"
},
{
"name": "Contact Labels",
"description": "Manage contact labels"
},
{
"name": "Conversation Assignments",
"description": "Manage conversation assignments"
},
{
"name": "Conversation Labels",
"description": "Manage conversation labels"
},
{
"name": "Conversations",
"description": "Conversation management APIs"
@@ -12005,15 +12017,15 @@
},
{
"name": "Contacts API",
"description": "Public APIs for contacts"
"description": "Public contact APIs"
},
{
"name": "Conversations API",
"description": "Public APIs for conversations"
"description": "Public conversation APIs"
},
{
"name": "Messages API",
"description": "Public APIs for messages"
"description": "Public message APIs"
},
{
"name": "CSAT Survey Page",
@@ -12037,6 +12049,9 @@
"Agents",
"Canned Responses",
"Contacts",
"Contact Labels",
"Conversation Assignments",
"Conversation Labels",
"Conversations",
"Custom Attributes",
"Custom Filters",
swagger/tag_groups/application.yml
+6
View File
@@ -20,6 +20,12 @@ tags:
description: Manage canned responses
- name: Contacts
description: Manage contacts
- name: Contact Labels
description: Manage contact labels
- name: Conversation Assignments
description: Manage conversation assignments
- name: Conversation Labels
description: Manage conversation labels
- name: Conversations
description: Manage conversations
- name: Custom Attributes
swagger/tag_groups/application_swagger.json
+20 -5
View File
@@ -1362,7 +1362,7 @@
],
"get": {
"tags": [
"Contacts"
"Contact Labels"
],
"operationId": "list-all-labels-of-a-contact",
"summary": "List Labels",
@@ -1409,7 +1409,7 @@
},
"post": {
"tags": [
"Contacts"
"Contact Labels"
],
"operationId": "contact-add-labels",
"summary": "Add Labels",
@@ -3193,7 +3193,7 @@
],
"post": {
"tags": [
"Conversations"
"Conversation Assignments"
],
"operationId": "assign-a-conversation",
"summary": "Assign Conversation",
@@ -3277,7 +3277,7 @@
],
"get": {
"tags": [
"Conversations"
"Conversation Labels"
],
"operationId": "list-all-labels-of-a-conversation",
"summary": "List Labels",
@@ -3324,7 +3324,7 @@
},
"post": {
"tags": [
"Conversations"
"Conversation Labels"
],
"operationId": "conversation-add-labels",
"summary": "Add Labels",
@@ -10234,6 +10234,18 @@
"name": "Contacts",
"description": "Contact management APIs"
},
{
"name": "Contact Labels",
"description": "Manage contact labels"
},
{
"name": "Conversation Assignments",
"description": "Manage conversation assignments"
},
{
"name": "Conversation Labels",
"description": "Manage conversation labels"
},
{
"name": "Conversations",
"description": "Conversation management APIs"
@@ -10300,6 +10312,9 @@
"Agents",
"Canned Responses",
"Contacts",
"Contact Labels",
"Conversation Assignments",
"Conversation Labels",
"Conversations",
"Custom Attributes",
"Custom Filters",
swagger/tag_groups/client_swagger.json
+6 -3
View File
@@ -4895,15 +4895,15 @@
"tags": [
{
"name": "Contacts API",
"description": "Public APIs for contacts"
"description": "Public contact APIs"
},
{
"name": "Conversations API",
"description": "Public APIs for conversations"
"description": "Public conversation APIs"
},
{
"name": "Messages API",
"description": "Public APIs for messages"
"description": "Public message APIs"
}
],
"x-tagGroups": [
@@ -4923,6 +4923,9 @@
"Agents",
"Canned Responses",
"Contacts",
"Contact Labels",
"Conversation Assignments",
"Conversation Labels",
"Conversations",
"Custom Attributes",
"Custom Filters",
swagger/tag_groups/other_swagger.json
+3
View File
@@ -4308,6 +4308,9 @@
"Agents",
"Canned Responses",
"Contacts",
"Contact Labels",
"Conversation Assignments",
"Conversation Labels",
"Conversations",
"Custom Attributes",
"Custom Filters",
swagger/tag_groups/platform_swagger.json
+5 -2
View File
@@ -5085,11 +5085,11 @@
},
{
"name": "Account Users",
"description": "Account Users management APIs"
"description": "Account user management APIs"
},
{
"name": "AgentBots",
"description": "Bot management APIs"
"description": "Bot integrations"
},
{
"name": "Users",
@@ -5113,6 +5113,9 @@
"Agents",
"Canned Responses",
"Contacts",
"Contact Labels",
"Conversation Assignments",
"Conversation Labels",
"Conversations",
"Custom Attributes",
"Custom Filters",