|
@@ -3,12 +3,12 @@ x-stoplight:
|
|
|
id: okoe8mh50pjec
|
|
id: okoe8mh50pjec
|
|
|
info:
|
|
info:
|
|
|
title: chat
|
|
title: chat
|
|
|
- version: '1.0'
|
|
|
|
|
|
|
+ version: "1.0"
|
|
|
servers:
|
|
servers:
|
|
|
- - url: 'http://chat:3010'
|
|
|
|
|
|
|
+ - url: "http://chat:3010"
|
|
|
x-exegesis-controller: messagesController
|
|
x-exegesis-controller: messagesController
|
|
|
paths:
|
|
paths:
|
|
|
- '/project/{projectId}/messages':
|
|
|
|
|
|
|
+ "/project/{projectId}/messages":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -19,14 +19,14 @@ paths:
|
|
|
summary: Get Global messages
|
|
summary: Get Global messages
|
|
|
tags: []
|
|
tags: []
|
|
|
responses:
|
|
responses:
|
|
|
- '201':
|
|
|
|
|
|
|
+ "201":
|
|
|
description: OK
|
|
description: OK
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
|
type: array
|
|
type: array
|
|
|
items:
|
|
items:
|
|
|
- $ref: '#/components/schemas/Message'
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Message"
|
|
|
operationId: getGlobalMessages
|
|
operationId: getGlobalMessages
|
|
|
description: Get global messages for the project with Project ID provided
|
|
description: Get global messages for the project with Project ID provided
|
|
|
parameters:
|
|
parameters:
|
|
@@ -42,21 +42,21 @@ paths:
|
|
|
summary: Send Global message
|
|
summary: Send Global message
|
|
|
operationId: sendGlobalMessage
|
|
operationId: sendGlobalMessage
|
|
|
responses:
|
|
responses:
|
|
|
- '201':
|
|
|
|
|
|
|
+ "201":
|
|
|
description: OK
|
|
description: OK
|
|
|
requestBody:
|
|
requestBody:
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
|
- $ref: '#/components/schemas/Message'
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Message"
|
|
|
examples:
|
|
examples:
|
|
|
example-1:
|
|
example-1:
|
|
|
value:
|
|
value:
|
|
|
user_id: string
|
|
user_id: string
|
|
|
content: string
|
|
content: string
|
|
|
- description: 'UserID and Content of the message to be posted. '
|
|
|
|
|
|
|
+ description: "UserID and Content of the message to be posted. "
|
|
|
description: Send global message for the project with Project ID provided
|
|
description: Send global message for the project with Project ID provided
|
|
|
- '/project/{projectId}/messages/{messageId}':
|
|
|
|
|
|
|
+ "/project/{projectId}/messages/{messageId}":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -72,13 +72,13 @@ paths:
|
|
|
summary: Get single global message
|
|
summary: Get single global message
|
|
|
tags: []
|
|
tags: []
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
description: OK
|
|
description: OK
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
|
- $ref: '#/components/schemas/Message'
|
|
|
|
|
- '404':
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Message"
|
|
|
|
|
+ "404":
|
|
|
description: Message not found
|
|
description: Message not found
|
|
|
operationId: getGlobalMessage
|
|
operationId: getGlobalMessage
|
|
|
description: Get a single global message by message ID for the project with Project ID provided
|
|
description: Get a single global message by message ID for the project with Project ID provided
|
|
@@ -86,10 +86,10 @@ paths:
|
|
|
summary: Delete global message
|
|
summary: Delete global message
|
|
|
operationId: deleteGlobalMessage
|
|
operationId: deleteGlobalMessage
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
- description: 'Delete global message'
|
|
|
|
|
- '/project/{projectId}/thread/{threadId}/messages':
|
|
|
|
|
|
|
+ description: "Delete global message"
|
|
|
|
|
+ "/project/{projectId}/thread/{threadId}/messages":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -105,19 +105,19 @@ paths:
|
|
|
summary: Send message
|
|
summary: Send message
|
|
|
operationId: sendMessage
|
|
operationId: sendMessage
|
|
|
responses:
|
|
responses:
|
|
|
- '201':
|
|
|
|
|
|
|
+ "201":
|
|
|
description: Created
|
|
description: Created
|
|
|
description: Add a message to the thread with thread ID provided from the Project with Project ID provided.
|
|
description: Add a message to the thread with thread ID provided from the Project with Project ID provided.
|
|
|
requestBody:
|
|
requestBody:
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
|
- $ref: '#/components/schemas/Message'
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Message"
|
|
|
description: |-
|
|
description: |-
|
|
|
JSON object with :
|
|
JSON object with :
|
|
|
- user_id: Id of the user
|
|
- user_id: Id of the user
|
|
|
- content: Content of the message
|
|
- content: Content of the message
|
|
|
- '/project/{projectId}/threads':
|
|
|
|
|
|
|
+ "/project/{projectId}/threads":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -128,20 +128,20 @@ paths:
|
|
|
summary: Get Threads
|
|
summary: Get Threads
|
|
|
tags: []
|
|
tags: []
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
description: OK
|
|
description: OK
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
|
type: array
|
|
type: array
|
|
|
items:
|
|
items:
|
|
|
- $ref: '#/components/schemas/Thread'
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Thread"
|
|
|
examples: {}
|
|
examples: {}
|
|
|
- '404':
|
|
|
|
|
|
|
+ "404":
|
|
|
description: Not Found
|
|
description: Not Found
|
|
|
operationId: getThreads
|
|
operationId: getThreads
|
|
|
description: Get the list of threads for the project with Project ID provided
|
|
description: Get the list of threads for the project with Project ID provided
|
|
|
- '/project/{projectId}/thread/{threadId}/messages/{messageId}/edit':
|
|
|
|
|
|
|
+ "/project/{projectId}/thread/{threadId}/messages/{messageId}/edit":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -162,9 +162,9 @@ paths:
|
|
|
summary: Edit message
|
|
summary: Edit message
|
|
|
operationId: editMessage
|
|
operationId: editMessage
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
- '404':
|
|
|
|
|
|
|
+ "404":
|
|
|
description: Not Found
|
|
description: Not Found
|
|
|
requestBody:
|
|
requestBody:
|
|
|
content:
|
|
content:
|
|
@@ -186,7 +186,7 @@ paths:
|
|
|
- user_id: Id of the user (optional)
|
|
- user_id: Id of the user (optional)
|
|
|
description: |
|
|
description: |
|
|
|
Update message with Message ID provided from the Thread ID and Project ID provided
|
|
Update message with Message ID provided from the Thread ID and Project ID provided
|
|
|
- '/project/{projectId}/messages/{messageId}/edit':
|
|
|
|
|
|
|
+ "/project/{projectId}/messages/{messageId}/edit":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -202,9 +202,9 @@ paths:
|
|
|
summary: Edit global message
|
|
summary: Edit global message
|
|
|
operationId: editGlobalMessage
|
|
operationId: editGlobalMessage
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
- '404':
|
|
|
|
|
|
|
+ "404":
|
|
|
description: Not Found
|
|
description: Not Found
|
|
|
requestBody:
|
|
requestBody:
|
|
|
content:
|
|
content:
|
|
@@ -226,7 +226,7 @@ paths:
|
|
|
- user_id: Id of the user (optional)
|
|
- user_id: Id of the user (optional)
|
|
|
description: |
|
|
description: |
|
|
|
Update global message with Message ID provided from the Project ID provided
|
|
Update global message with Message ID provided from the Project ID provided
|
|
|
- '/project/{projectId}/thread/{threadId}/messages/{messageId}':
|
|
|
|
|
|
|
+ "/project/{projectId}/thread/{threadId}/messages/{messageId}":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -247,13 +247,13 @@ paths:
|
|
|
summary: Get thread message
|
|
summary: Get thread message
|
|
|
tags: []
|
|
tags: []
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
description: OK
|
|
description: OK
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
|
- $ref: '#/components/schemas/Message'
|
|
|
|
|
- '404':
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Message"
|
|
|
|
|
+ "404":
|
|
|
description: Message not found
|
|
description: Message not found
|
|
|
operationId: getThreadMessage
|
|
operationId: getThreadMessage
|
|
|
description: Get a specific message by message ID from the thread with Thread ID and Project ID provided
|
|
description: Get a specific message by message ID from the thread with Thread ID and Project ID provided
|
|
@@ -261,10 +261,10 @@ paths:
|
|
|
summary: Delete message
|
|
summary: Delete message
|
|
|
operationId: deleteMessage
|
|
operationId: deleteMessage
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
- description: 'Delete message with Message ID provided, from the Thread with ThreadID and ProjectID provided'
|
|
|
|
|
- '/project/{projectId}/thread/{threadId}/user/{userId}/messages/{messageId}':
|
|
|
|
|
|
|
+ description: "Delete message with Message ID provided, from the Thread with ThreadID and ProjectID provided"
|
|
|
|
|
+ "/project/{projectId}/thread/{threadId}/user/{userId}/messages/{messageId}":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -290,9 +290,9 @@ paths:
|
|
|
summary: Delete message written by a given user
|
|
summary: Delete message written by a given user
|
|
|
operationId: deleteUserMessage
|
|
operationId: deleteUserMessage
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
- '/project/{projectId}/thread/{threadId}/resolve':
|
|
|
|
|
|
|
+ "/project/{projectId}/thread/{threadId}/resolve":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -308,7 +308,7 @@ paths:
|
|
|
summary: Resolve Thread
|
|
summary: Resolve Thread
|
|
|
operationId: resolveThread
|
|
operationId: resolveThread
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
requestBody:
|
|
requestBody:
|
|
|
content:
|
|
content:
|
|
@@ -324,7 +324,7 @@ paths:
|
|
|
JSON object with :
|
|
JSON object with :
|
|
|
- user_id: Id of the user.
|
|
- user_id: Id of the user.
|
|
|
description: Mark Thread with ThreadID and ProjectID provided owned by the user with UserID provided as resolved.
|
|
description: Mark Thread with ThreadID and ProjectID provided owned by the user with UserID provided as resolved.
|
|
|
- '/project/{projectId}/thread/{threadId}/reopen':
|
|
|
|
|
|
|
+ "/project/{projectId}/thread/{threadId}/reopen":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -340,12 +340,12 @@ paths:
|
|
|
summary: Reopen Thread
|
|
summary: Reopen Thread
|
|
|
operationId: reopenThread
|
|
operationId: reopenThread
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
description: |-
|
|
description: |-
|
|
|
Reopen Thread with ThreadID and ProjectID provided.
|
|
Reopen Thread with ThreadID and ProjectID provided.
|
|
|
i.e unmark it as resolved.
|
|
i.e unmark it as resolved.
|
|
|
- '/project/{projectId}/thread/{threadId}':
|
|
|
|
|
|
|
+ "/project/{projectId}/thread/{threadId}":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -361,13 +361,13 @@ paths:
|
|
|
summary: Get Thread
|
|
summary: Get Thread
|
|
|
tags: []
|
|
tags: []
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
description: OK
|
|
description: OK
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
|
- $ref: '#/components/schemas/Thread'
|
|
|
|
|
- '404':
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Thread"
|
|
|
|
|
+ "404":
|
|
|
description: Thread not found
|
|
description: Thread not found
|
|
|
operationId: getThread
|
|
operationId: getThread
|
|
|
description: Get a thread with ThreadID and ProjectID provided
|
|
description: Get a thread with ThreadID and ProjectID provided
|
|
@@ -375,10 +375,10 @@ paths:
|
|
|
summary: Delete thread
|
|
summary: Delete thread
|
|
|
operationId: deleteThread
|
|
operationId: deleteThread
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
description: Delete thread with ThreadID and ProjectID provided
|
|
description: Delete thread with ThreadID and ProjectID provided
|
|
|
- '/project/{projectId}/resolved-thread-ids':
|
|
|
|
|
|
|
+ "/project/{projectId}/resolved-thread-ids":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -389,9 +389,9 @@ paths:
|
|
|
summary: Get resolved thread ids
|
|
summary: Get resolved thread ids
|
|
|
operationId: getResolvedThreadIds
|
|
operationId: getResolvedThreadIds
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
description: Resolved thread ids
|
|
description: Resolved thread ids
|
|
|
- '/project/{projectId}':
|
|
|
|
|
|
|
+ "/project/{projectId}":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -402,15 +402,15 @@ paths:
|
|
|
summary: Destroy project
|
|
summary: Destroy project
|
|
|
operationId: destroyProject
|
|
operationId: destroyProject
|
|
|
responses:
|
|
responses:
|
|
|
- '204':
|
|
|
|
|
|
|
+ "204":
|
|
|
description: No Content
|
|
description: No Content
|
|
|
- description: 'Delete all threads from Project with Project ID provided, and all messages in those threads.'
|
|
|
|
|
|
|
+ description: "Delete all threads from Project with Project ID provided, and all messages in those threads."
|
|
|
/status:
|
|
/status:
|
|
|
get:
|
|
get:
|
|
|
summary: Check status
|
|
summary: Check status
|
|
|
tags: []
|
|
tags: []
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
description: OK
|
|
description: OK
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
@@ -423,7 +423,7 @@ paths:
|
|
|
summary: Check status
|
|
summary: Check status
|
|
|
tags: []
|
|
tags: []
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
description: OK
|
|
description: OK
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
@@ -432,7 +432,7 @@ paths:
|
|
|
description: chat is alive
|
|
description: chat is alive
|
|
|
operationId: getStatus
|
|
operationId: getStatus
|
|
|
description: Check that the Chat service is alive
|
|
description: Check that the Chat service is alive
|
|
|
- '/project/{projectId}/duplicate-comment-threads':
|
|
|
|
|
|
|
+ "/project/{projectId}/duplicate-comment-threads":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -453,7 +453,7 @@ paths:
|
|
|
items:
|
|
items:
|
|
|
type: string
|
|
type: string
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
@@ -463,7 +463,7 @@ paths:
|
|
|
type: object
|
|
type: object
|
|
|
description: Mapping of old thread ids to their duplicated thread ids
|
|
description: Mapping of old thread ids to their duplicated thread ids
|
|
|
description: Duplicate a list of comment threads
|
|
description: Duplicate a list of comment threads
|
|
|
- '/project/{projectId}/generate-thread-data':
|
|
|
|
|
|
|
+ "/project/{projectId}/generate-thread-data":
|
|
|
parameters:
|
|
parameters:
|
|
|
- schema:
|
|
- schema:
|
|
|
type: string
|
|
type: string
|
|
@@ -484,7 +484,7 @@ paths:
|
|
|
items:
|
|
items:
|
|
|
type: string
|
|
type: string
|
|
|
responses:
|
|
responses:
|
|
|
- '200':
|
|
|
|
|
|
|
+ "200":
|
|
|
content:
|
|
content:
|
|
|
application/json:
|
|
application/json:
|
|
|
schema:
|
|
schema:
|
|
@@ -514,4 +514,4 @@ components:
|
|
|
id: 0ppt3jw4h5bua
|
|
id: 0ppt3jw4h5bua
|
|
|
type: array
|
|
type: array
|
|
|
items:
|
|
items:
|
|
|
- $ref: '#/components/schemas/Message'
|
|
|
|
|
|
|
+ $ref: "#/components/schemas/Message"
|