Hobbies API

[arafaysaleem]

Description

This epic is a goal of the larger epic of Students API and contains functionality for hobbies assignment in our project. This epic requires multiple endpoints to be setup and tested along with their detailed documentation.

Initiative / goal

We want to be able to manage hobbies so that students can choose from them while creating accounts. These hobbies are also used to match similar students.

Hypothesis

The API must provide management of hobbies. This epic is considered complete when the following features are complete:

• Hobbies Management
• Documentation
• Tests

Acceptance criteria and must have scope

We must have Authentication API setup prior to this. In the end we need to have a collection of following endpoints:

• GET All Hobbies As a student, I should be able to get all possible hobbies, so that I can choose from them in while signing up #39
• GET A Single Hobby As a student, I should be able to get details of a hobby, so that I can understand what information it represents #38
• POST A New Hobby 🔒 As a admin, I should be able to create hobbies, so that students can choose them while registering #32
• PATCH A Hobby 🔒 As a admin, I should be able to update the details of a hobby, so that I can fix old or inconsistent hobby entries #36
• DELETE A Hobby 🔒 As an admin, I should be able to delete hobbies, so that I can remove old or inconsistent entries #37

Note: 🔒 symbol indicates the route is protected and accessible to admin only

Stakeholders

None

Timeline

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

[arafaysaleem]

Completed