Create test cases docs table for `POST /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 `POST /categories/{id}/sections` #213

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 POST /categories/{id}/sections API endpoint.

Definition of Done

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

Estimation

30 mins

annabauza commented 3 years ago

approved

Ln11211 commented 3 years ago

hello, I am a first timer and I want to try working on this issue, but I haven't fully understood what should I be documenting, any help ? (p.s I have really very little knowledge right now but I'll learn anything asap)

isabelcosta commented 3 years ago

@Ln11211 I just saw this now. Sure so, the idea is to explore this endpoint capabilities and potential test scenarios and create a similar table to inform contributors of how to test this endpoint. For example, maybe you have to be logged in for the endpoint to return successfully 🤔

Here's a document example: https://github.com/anitab-org/mentorship-backend/blob/cf6df094e4fef735e135674e4d5697ded5060d7d/docs/quality-assurance-test-cases.md

Does that help? I've assigned this to you, let me know if you have more doubts

Ln11211 commented 3 years ago

@isabelcosta , Should I document the quality assurance and test cases table in the same file you shared, or should I make a new one with the name "quality assurance documentation" ?

If I am not wrong, I have to document different test cases so somebody can test the service(POST/Categories/ {id}/Sections) right ? so to begin with different test cases, I was wondering what does this service do ? For example, I understood that POST/users/login and /register can be used to create a user account and to login, but what does POST/Categories/ {id}/Sections do ?

P.S I have seen your mentorship GSoc18 video and I created a user account too..

isabelcosta commented 3 years ago

should I make a new one with the name "quality assurance documentation" ?

Yes please :)

If I am not wrong, I have to document different test cases so somebody can test the service(POST/Categories/ {id}/Sections) right ? so to begin with different test cases, I was wondering what does this service do ? For example, I understood that POST/users/login and /register can be used to create a user account and to login, but what does POST/Categories/ {id}/Sections do ?

@Ln11211 those are great questions! I don't know exactly how it works. But I think you can understand more if you look at the code that implements that request. Are you familiar with programming and navigating a codebase, or would you need help? @annabauza @vatsalkul can you help here?

P.S I have seen your mentorship GSoc18 video and I created a user account too...

Nice :D