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
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 | |||||||||||||||||||||
| 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 | 5 | 6 | Create a Thread | authorized user | /thread | POST | CreateThread | Thread | ||||||||||||||||||
| 75 | Get a Thread by its ID | authorized user | /thread/{threadId} | GET | Thread | |||||||||||||||||||||
| 86 | Create a Reply | authorized user | /reply | POST | CreateReply | Reply | Thread’s Author | |||||||||||||||||||
| 97 | Get a Reply by its ID | authorized user | /reply/{replyId} | GET | Reply | |||||||||||||||||||||
| 10 | Flag a Thread | authorized user | /thread/{threadId}/flag | PUT | Moderator | |||||||||||||||||||||
| 11 | Flag a Reply | authorized user | /reply/{replyId}/flag | PUT | Moderator | |||||||||||||||||||||
| 12 | Pin a Thread | Moderator | /thread/{threadId}/pin | PUT | ||||||||||||||||||||||
| 13 | Unpin a Thread | Moderator | /thread/{threadId}/unpin | PUT | ||||||||||||||||||||||
| 14 | Remove a Flag on a Thread | Moderator | /thread/{threadId}/flag | PUT | ||||||||||||||||||||||
| 15 | Remove a Flag on a Reply | Moderator | /reply/{replyId}/flag | PUT | ||||||||||||||||||||||
| 168 | Remove a Thread | Moderator | /thread/{threadId} | DELETE | ||||||||||||||||||||||
| 179 | Remove a Reply | Moderator | /reply/{replyId} | DELETE | ||||||||||||||||||||||
| 1810 | Get Replies for a Thread | authorized user | /thread/{threadId}/replies | GET | order, limit, offset | PaginatedReplies | ||||||||||||||||||||
| 1911 | Update a Thread’s Message | Author | /thread/{threadId}/message | PUT | String | |||||||||||||||||||||
| 2012 | Update a Reply’s Message | Author | /reply/{replyId}/message | PUT | String |