Practice App: Implement the Get Lesson By Category Endpoint

bahricanyesil commented 2 years ago

Issue Description

We determined the endpoints to be included in the practice app project in our weekly meeting-9.

After the determination of the complete list, we divided the tasks within the team. I took the responsibility for the get lesson by category endpoint.

Step Details

Steps that will be performed:

[x] Check whether the incoming data is valid
[x] Return the lessons with the given category
[x] Return an error message if an error occurs in any of the previous steps
[x] Test the endpoint with Postman
[x] Save requests as a collection in Postman
[x] Document the endpoint

Final Actions

After I created the get lesson by category endpoint, I will test it by using Postman. While testing, I will save my successful and failed requests and I will create a collection in Postman. I will also give the link to the collection under this as a comment to enable anyone to test the endpoint. Finally, I will document the endpoint and will share the documentation as a comment under this issue to add it to the corresponding wiki page in the future.

Deadline of the Issue

08.05.2022 - Sunday - 23:59

Reviewer

Altay Acar

Deadline for the Review

09.05.2022 - Monday - 23:59

bahricanyesil commented 2 years ago

Info

I checked the all required fields in the incoming data (category_id).
I controlled whether the input data is a valid object id.
I tested the endpoint with Postman, saved the requests, and created a collection. Here's the link to the documentation.

bahricanyesil commented 2 years ago

Handwritten Documentation

Endpoint: /lesson/byCategory
Definition: Fetches the lessons with the given category id.
Query Parameters: category_id
Body Data: none
Example request query parameter: { "category_id": "6273bc3b3a3750aa3aa141af" }
Example response body: { "resultMessage": "Lessons are successfully fetched.", "lessons": [ { "name": "Basketball", "category_id": "6273bc3b3a3750aa3aa141af", "createdAt": "2022-05-05T11:59:56.001Z", "updatedAt": "2022-05-05T11:59:56.001Z", "id": "6273bc3c3a3750aa3aa141b1" }, { "name": "Football", "category_id": "6273bc3b3a3750aa3aa141af", "createdAt": "2022-05-05T11:59:56.026Z", "updatedAt": "2022-05-05T11:59:56.026Z", "id": "6273bc3c3a3750aa3aa141b3" } ] }

Postman Documentation

bahricanyesil commented 2 years ago

I completed all of the steps mentioned in the issue description. I opened a pull request and requested reviews of primarily @xltvy and additionally @ezgy.

Now, this issue is linked to PR #161 and will be automatically closed after the pull request is merged.