Use cases

...

In the second phase, we could add new features so that a user could help the community by marking a Thread is helpful, and by marking a Reply is helpful or unhelpful. 

Mockups

Phase 1

Summary View

Paginated Threads

Thread View

...

New Thread

New Reply

Models

Image RemovedImage Added

API

...

	Action	Intended User	URI	Method	Request Parameters	Request Body	Response Body	Notification Sent to (P2)
1	Get Forum Metadata for a Project	authorized user	/forum/{projectId}	GET

  

Forum

 3

2

Update Forum DescriptionModerator/forum/{forumId}/descriptionPOST Description  

Get Threads of a Forum

authorized user

/forum/{forumId}/threads

GET

order, limit, offset

 PaginatedThreads 4Add ModeratorAdmin/moderatorPOST CreateModeratorModerator 5Remove ModeratorAdmin/moderator/{moderatorId}DELETE    6

	PaginatedThreads
3	Create a Thread	authorized user	/thread	POST

 7

CreateThread

Thread

 

4

Get a Thread by its ID

authorized user

/thread/{threadId}

GET

  

Thread

 

5

8

Create a Reply

authorized user

/reply

POST

 

CreateReply

Reply

Thread’s Author

9

6

Get a Reply by its ID

authorized user

/reply/{replyId}

GET

  

Reply

 

7

10Flag

Remove a Thread

authorized user

Moderator

/thread/{threadId}

/flagPUTFlag

DELETE

   Moderator11

8	Remove a Reply

authorized user

Moderator

/reply/{replyId}

/flagPUT

DELETE

   Moderator12Pin

9	Get Replies for a Thread

Moderator

authorized user

/thread/{threadId}/

pin13Unpin a ThreadModerator

replies

PUT    

GET	order, limit, offset		PaginatedReplies
10	Update a Thread’s Message	Author	/thread/{threadId}/

unpin

message

PUT

 14Remove a Flag on a ThreadModerator/thread/{threadId}/flagPUT    15Remove a Flag on a ReplyModerator/reply/{replyId}/flagPUT    16Remove a Thread

String

   

11	Update a Reply’s Message	Author	/reply/{replyId}/message	PUT		String
12	Update a Thread's title	Author	/thread/{threadId}/title	PUT		String
13	Restore a deleted thread	Moderator	/thread/{threadId}/restore

DELETEGet Replies for a Thread

PUT

    17Remove a ReplyModerator/reply/{replyId}DELETE    18

14

Retrieve a paginated list of moderator for a given forum

authorized user

/

thread

forum/{

threadId

forumId}/

replies

moderators

GET

order,

limit, offset

 

PaginatedModerators

PaginatedReplies

Future Potential Extensions

...

• Search

• Look for all discussions about an entity - DONE

• Search for content

• Tag / Category

• Notification

• Moderator gets notification when new thread is created - DONE

• Author gets notification when someone responds to their post - DONE

• Following - DONE

• Vote (up and down) on responses

• Flag a thread/ response as inappropriate  

• Mark a thread as helpful

• Be able to see that there are discussions on a file / table* - DONE

• Be able to link to a thread - DONE

• Moderator would be able to close a thread and link to another thread