Chore: User Friendly URLs on the swagger docs (#590)
Made the swagger documentation urls short and readable.
This commit is contained in:
@@ -1,5 +1,7 @@
|
|||||||
get:
|
get:
|
||||||
tags: [Contact]
|
tags:
|
||||||
|
- Contact
|
||||||
|
operationId: contactConversations
|
||||||
summary: Conversations
|
summary: Conversations
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
get:
|
get:
|
||||||
tags: [Contact]
|
tags:
|
||||||
|
- Contact
|
||||||
|
operationId: contactDetails
|
||||||
summary: Show Contact
|
summary: Show Contact
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
@@ -18,7 +20,9 @@ get:
|
|||||||
description: Access denied
|
description: Access denied
|
||||||
|
|
||||||
put:
|
put:
|
||||||
tags: [Contact]
|
tags:
|
||||||
|
- Contact
|
||||||
|
operationId: contactUpdate
|
||||||
summary: Update Contact
|
summary: Update Contact
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
get:
|
get:
|
||||||
tags: [Contact]
|
tags:
|
||||||
|
- Contact
|
||||||
|
operationId: contactList
|
||||||
description: Listing all the contacts with pagination
|
description: Listing all the contacts with pagination
|
||||||
summary: List Contacts
|
summary: List Contacts
|
||||||
parameters:
|
parameters:
|
||||||
@@ -17,7 +19,9 @@ get:
|
|||||||
$ref: '#/definitions/bad_request_error'
|
$ref: '#/definitions/bad_request_error'
|
||||||
|
|
||||||
post:
|
post:
|
||||||
tags: [Contact]
|
tags:
|
||||||
|
- Contact
|
||||||
|
operationId: contactCreate
|
||||||
description: Create New Contact
|
description: Create New Contact
|
||||||
parameters:
|
parameters:
|
||||||
- name: data
|
- name: data
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
|
- Conversation
|
||||||
|
operationId: conversationAssignment
|
||||||
summary: Assign Conversation
|
summary: Assign Conversation
|
||||||
description: Assign a conversation to an agent
|
description: Assign a conversation to an agent
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
get:
|
get:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
|
- Conversation
|
||||||
|
operationId: conversationDetails
|
||||||
summary: Conversation Details
|
summary: Conversation Details
|
||||||
description: Get all details regarding a conversation with all messages in the conversation
|
description: Get all details regarding a conversation with all messages in the conversation
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
get:
|
get:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
|
- Conversation
|
||||||
|
operationId: conversationLabelsList
|
||||||
summary: List Labels
|
summary: List Labels
|
||||||
description: Lists all the labels of a conversation
|
description: Lists all the labels of a conversation
|
||||||
parameters:
|
parameters:
|
||||||
@@ -19,9 +21,11 @@ get:
|
|||||||
description: Access denied
|
description: Access denied
|
||||||
|
|
||||||
post:
|
post:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
summary: Add Label
|
- Conversation
|
||||||
description: Creates a new label and associates it with the conversation
|
operationId: conversationAddLabels
|
||||||
|
summary: Add Labels
|
||||||
|
description: Creates new labels and associates it with the conversation
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
in: path
|
in: path
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
get:
|
get:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
|
- Conversation
|
||||||
|
operationId: conversationList
|
||||||
description: List all the conversations with pagination
|
description: List all the conversations with pagination
|
||||||
summary: Conversations List
|
summary: Conversations List
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
|
- Conversation
|
||||||
|
operationId: conversationNewMessage
|
||||||
summary: Create New Message
|
summary: Create New Message
|
||||||
description: All the agent replies are created as new messages through this endpoint
|
description: All the agent replies are created as new messages through this endpoint
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
|
- Conversation
|
||||||
|
operationId: conversationToggleStatus
|
||||||
summary: Toggle Status
|
summary: Toggle Status
|
||||||
description: Toggles the status of the conversation between open and resolved
|
description: Toggles the status of the conversation between open and resolved
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
post:
|
post:
|
||||||
tags: [Conversation]
|
tags:
|
||||||
|
- Conversation
|
||||||
|
operationId: conversationUpdateLastSeen
|
||||||
summary: Update Last Seen
|
summary: Update Last Seen
|
||||||
description: Updates the last seen of the conversation so that conversations will have the bubbles in the agents screen
|
description: Updates the last seen of the conversation so that conversations will have the bubbles in the agents screen
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@@ -21,6 +21,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Contact"
|
"Contact"
|
||||||
],
|
],
|
||||||
|
"operationId": "contactList",
|
||||||
"description": "Listing all the contacts with pagination",
|
"description": "Listing all the contacts with pagination",
|
||||||
"summary": "List Contacts",
|
"summary": "List Contacts",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -49,6 +50,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Contact"
|
"Contact"
|
||||||
],
|
],
|
||||||
|
"operationId": "contactCreate",
|
||||||
"description": "Create New Contact",
|
"description": "Create New Contact",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@@ -81,6 +83,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Contact"
|
"Contact"
|
||||||
],
|
],
|
||||||
|
"operationId": "contactDetails",
|
||||||
"summary": "Show Contact",
|
"summary": "Show Contact",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@@ -110,6 +113,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Contact"
|
"Contact"
|
||||||
],
|
],
|
||||||
|
"operationId": "contactUpdate",
|
||||||
"summary": "Update Contact",
|
"summary": "Update Contact",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@@ -149,6 +153,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Contact"
|
"Contact"
|
||||||
],
|
],
|
||||||
|
"operationId": "contactConversations",
|
||||||
"summary": "Conversations",
|
"summary": "Conversations",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@@ -180,6 +185,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
|
"operationId": "conversationList",
|
||||||
"description": "List all the conversations with pagination",
|
"description": "List all the conversations with pagination",
|
||||||
"summary": "Conversations List",
|
"summary": "Conversations List",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -210,6 +216,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
|
"operationId": "conversationDetails",
|
||||||
"summary": "Conversation Details",
|
"summary": "Conversation Details",
|
||||||
"description": "Get all details regarding a conversation with all messages in the conversation",
|
"description": "Get all details regarding a conversation with all messages in the conversation",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -242,6 +249,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
|
"operationId": "conversationToggleStatus",
|
||||||
"summary": "Toggle Status",
|
"summary": "Toggle Status",
|
||||||
"description": "Toggles the status of the conversation between open and resolved",
|
"description": "Toggles the status of the conversation between open and resolved",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -274,6 +282,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
|
"operationId": "conversationUpdateLastSeen",
|
||||||
"summary": "Update Last Seen",
|
"summary": "Update Last Seen",
|
||||||
"description": "Updates the last seen of the conversation so that conversations will have the bubbles in the agents screen",
|
"description": "Updates the last seen of the conversation so that conversations will have the bubbles in the agents screen",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -303,6 +312,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
|
"operationId": "conversationLabelsList",
|
||||||
"summary": "List Labels",
|
"summary": "List Labels",
|
||||||
"description": "Lists all the labels of a conversation",
|
"description": "Lists all the labels of a conversation",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -333,8 +343,9 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
"summary": "Add Label",
|
"operationId": "conversationAddLabels",
|
||||||
"description": "Creates a new label and associates it with the conversation",
|
"summary": "Add Labels",
|
||||||
|
"description": "Creates new labels and associates it with the conversation",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"name": "id",
|
"name": "id",
|
||||||
@@ -382,6 +393,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
|
"operationId": "conversationAssignment",
|
||||||
"summary": "Assign Conversation",
|
"summary": "Assign Conversation",
|
||||||
"description": "Assign a conversation to an agent",
|
"description": "Assign a conversation to an agent",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -427,6 +439,7 @@
|
|||||||
"tags": [
|
"tags": [
|
||||||
"Conversation"
|
"Conversation"
|
||||||
],
|
],
|
||||||
|
"operationId": "conversationNewMessage",
|
||||||
"summary": "Create New Message",
|
"summary": "Create New Message",
|
||||||
"description": "All the agent replies are created as new messages through this endpoint",
|
"description": "All the agent replies are created as new messages through this endpoint",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
|||||||
Reference in New Issue
Block a user