Create test cases docs table for `GET /categories/{id}/sections`

anitab-org / stem-diverse-tv

STEM Diverse TV is a project which gather and provide inspiring, motivating, informative, educational and supportive videos about diversity in STEM. This is a backend which provide content for multiple frontend applications build with Applicaster Zapp platform.

https://stem-diverse-tv.herokuapp.com/

GNU General Public License v3.0

13 stars 49 forks source link

Create test cases docs table for `GET /categories/{id}/sections` #214

Open Rahulm2310 opened 3 years ago

Rahulm2310 commented 3 years ago

Description

As a developer or tester, I need to know some test cases examples, so that I can have an idea of how I can test the app.

Creating test cases will help everyone understand how to use the API.

References:

Quality Assurance test cases for mentorship-backend project
Check out the API Swagger definition here: https://stem-diverse-tv.herokuapp.com/

Acceptance Criteria

Update [Required]

[ ] Create quality assurance documentation on /docs folder.
[ ] Create test cases documentation table for GET /categories/{id}/sections API endpoint.

Definition of Done

[ ] All of the required items are completed.
[ ] Approval by 1 mentor.

Estimation

30 mins

Krishna841 commented 3 years ago

@Rahulm2310 I wish to work on this issue and solve it... Can you guide me?? A brief explanation of the task that I have to perform will be extremely helpful. Thanks

Rahulm2310 commented 3 years ago

@Krishna841 You can refer to the references provides in the issue description. You need to create quality assurance documentation similar to how it is done here and add a table of test cases for GET /categories/{id}/sections endpoint similar to this.

Let me know when you are ready and I will assign you ☺️.

Krishna841 commented 3 years ago

@Rahulm2310 I got the documentation part but I want some more clarification in making the table. In the table, we need to think of different possible test cases and their outcomes, right? If so, can you explain what "GET /categories/{id}/sections" means so that I can think which test cases would be possible? Thank you very much. Also, I'm ready to take this project, kindly assign me this one.

annabauza commented 3 years ago

@Rahulm2310 please reply ☝️

Rahulm2310 commented 3 years ago

@Krishna841 GET /categories/{id}/sections is an api endpoint that returns an array of sections({id,title}) related to a category with category id=id . For example we have the following categories:

Now, when I make a GET request to /categories/1/sections i.e. sections related to category 1, I get:

Feel free to play around with the Swagger UI. For more info, have a look at the database design as well as the Response Data Structure. Hope it helps 🙂

Assigning you 🎉. Happy testing and documenting!

Krishna841 commented 3 years ago

@Rahulm2310 Can you tell me how to test the api?

Krishna841 commented 3 years ago

I'm so sorry I won't be able to fix the issue...U can remove me from this issue @Rahulm2310

Rahulm2310 commented 3 years ago

Okay. No worries @Krishna841. Thanks anyway 😊