Posts API

[arafaysaleem]

Description

This epic is a sub goal of the epic for Complete REST API and provides functionality surrounding posting memories. This epic requires multiple endpoints to be setup and tested along with their detailed documentation.

Initiative / goal

This API impacts our memories feed module as without posts the feed will show no data. We want to allow students to make new posts, optionally with some images or videos. We want to allow students to react to posts. We want to show all the reactions and uploads of a post. We should work on this immediately after setting up Hangout Requests API.

Hypothesis

We must have Students and Reaction Types API setup prior to this. The following is true by the end of this API

• We can query/manage possible posts and it's uploads
• We can query/manage possible reactions of a post

Acceptance criteria and must have scope

In the end we need to have a collection of following endpoints:

• [GET] All Posts #136
• [GET] A Single Post #137
• [POST] A New Post #140
• [PATCH] A Post #139
• [DELETE] A Post #138
• [GET] All Reactions Of A Post #144
• [POST] A Reaction On A Post #141
• [PATCH] A Reaction On A Post #143
• [DELETE] A Reaction From A Post #142
• Documentation For Each Endpoint
• Tests For Each Endpoint

Stakeholders

None

Timeline

3 weeks are needed to setup all the foundation, along with testing and documentation. No blockers expected.

[arafaysaleem]

This Epic has 3 stages:

1. First 7 starting days we will work on the base functionality of this API.
2. Sub goals will begin and continue till 3 days before the deadline.
3. Remaining 3 days, after sub goals are complete, will be used to check each of their functionalities in combination for this API's endpoints e.g. Get a post's reactions after Reaction Types API complete.

[arafaysaleem]

Completed In #145