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 | String | 3 | Get Threads of a Forum | authorized user | /forum/{forumId}/threads | GET | order, limit, offset | PaginatedThreads | |||||
| 43 | Create a Thread | authorized user | /thread | POST | CreateThread | Thread | |||||||||||
| 54 | Get a Thread by its ID | authorized user | /thread/{threadId} | GET | Thread | ||||||||||||
| 65 | Create a Reply | authorized user | /reply | POST | CreateReply | Reply | Thread’s Author | ||||||||||
| 76 | Get a Reply by its ID | authorized user | /reply/{replyId} | GET | Reply | ||||||||||||
| 87 | Remove a Thread | Moderator, Author | /thread/{threadId} | DELETE | |||||||||||||
| 98 | Remove a Reply | Moderator, Author | /reply/{replyId} | DELETE | |||||||||||||
| 109 | Get Replies for a Thread | authorized user | /thread/{threadId}/replies | GET | order, limit, offset | PaginatedReplies | |||||||||||
| 1110 | Update a Thread’s Message | Author | /thread/{threadId}/message | PUT | String | ||||||||||||
| 1211 | Update a Reply’s Message | Author | /reply/{replyId}/message | PUT | String | ||||||||||||
| 1312 | Update a Thread's title | Author | /thread/{threadId}/title | PUT | String |
Future Potential Extensions
...