Mentorship-backend: Add to List Users API the ability to filter users who need or want to provide mentoring

[isabelcosta]

Description

As a member of the app,
I need be able to filter other members for their availability,
so that I can choose the member I want to create a mentorship relation with.

APIs used to fetch Users, don't have an option to filter users by need_mentoring and available_to_mentor attributes.

Acceptance Criteria

Update [Required]

• [ ] Add a query parameter support to GET /users and GET /users/verified, to filter users by need_mentoring and available_to_mentor attributes.
• [ ] Update Swagger UI documentation for this API.
• [ ] Write at least one test to prove your new feature is working.

Definition of Done

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

Estimation

4 hours

[srivastava9]

Can I work on this @isabelcosta ?

[srivastava9]

Hey @isabelcosta ,could you please confirm may i work on this issue ?
Thanks :)

[isabelcosta]

Sure @srivastava9 go ahead :)

[lmcicat]

Hey @isabelcosta . @brianguo98 and I need to make open source contributions for our final homework assignment in one of our college classes. We were hoping to contribute to this repo! We both have taken college courses about web dev which focused on python / flask. Would it be possible for us to work on this issue?

[isabelcosta]

@lmcicat since we have no updates here for a while, I will assume @srivastava9 is not working on this, go ahead @lmcicat :) I will assign this to you.

@brianguo98 may you can look into another issue, there are several issue open. Can you check this filter of available issues: https://github.com/anitab-org/mentorship-backend/labels/Status%3A%20Available

[lmcicat]

thanks @isabelcosta !! @brianguo98 is my partner for the homework assignment, so we were hoping to tag along on the same issues. Is it possible for him to be assigned to this one too? We are going to try to tackle multiple issues in the repo before the assignment is due.

[isabelcosta]

@lmcicat just don't forget to follow the Contributing Guidelines ;) Very important step from contributing in open source

[lmcicat]

Hey @isabelcosta ! @brianguo98 and I just submitted a PR for this found here: https://github.com/anitab-org/mentorship-backend/pull/535 . What are the next steps? Do we just wait until someone reviews it?

[isabelcosta]

To anyone who is interested in contributing to this issue, this was almost completed in this PR #535 due to @lmcicat great work 🤗

[aditya2499]

@isabelcosta I would like to work on it.

[isabelcosta]

@aditya2499 sure go ahead :)

[aditya2499]

@isabelcosta What should be the default behavior if the values of attributes are not specified in the request?
And if false is passed, a list of all users should be returned or only those users whose attribute value is set to false in the database?

[aditya2499]

@isabelcosta I have made a pull request. Have a review