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
...
| 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 | |||
| 2 | Update Forum Description | Moderator | /forum/{forumId}/description | POST | Description | |||
| 3 | Get Threads of a Forum | authorized user | /forum/{forumId}/threads | GET | order, limit, offset | PaginatedThreads | ||
| 4 | Create a Thread | authorized user | /thread | POST | CreateThread | Thread | ||
| 5 | Get a Thread by its ID | authorized user | /thread/{threadId} | GET | Thread | |||
| 6 | Create a Reply | authorized user | /reply | POST | CreateReply | Reply | Thread’s Author | |
| 7 | Get a Reply by its ID | authorized user | /reply/{replyId} | GET | Reply | |||
| 8 | Remove a Thread | Moderator | /thread/{threadId} | DELETE | ||||
| 9 | Remove a Reply | Moderator | /reply/{replyId} | DELETE | ||||
| 10 | Get Replies for a Thread | authorized user | /thread/{threadId}/replies | GET | order, limit, offset | PaginatedReplies | ||
| 11 | Update a Thread’s Message | Author | /thread/{threadId}/message | PUT | String | |||
| 12 | Update a Reply’s Message | Author | /reply/{replyId}/message | PUT | String |
Future Potential Extensions
Search
Look for all discussions about an entity
Search for content
Tag / Category
Notification
Moderator gets notification when someone posts something
Author gets notification when someone responds to their post
Following
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
Be able to link to a thread
- Moderator would be able to close a thread and link to another thread