Systers, an AnitaB.org community
Add query parameter to search users by user display name to GET /users API (Backend)
Introduction:
GET /users API needs a way to search users by user display name. This should be done by adding search=
parameter to url. Value of this parameter should be decode from url encoding.
Prerequisite:
- Have a GitHub account
- Know how to use git
- Setup and run the project on your local development environment
Steps:
- Create a copy of the project into your account GitHub by forking systers/mentorship-backend project.
- Clone the project onto your local development environment
- [Optional] Create a branch to make your changes
- Add a query parameter to extend
GET /users
by search parametersearch=
search_query. - Decode value of extra parameter from url encoding
- Return users which
display user name
match search query - Update Swagger UI documentation for this API.
- Write at least one test to prove your new feature is working.
- Commit your change through the interface using our Commit message Style Guide.
- Submit a Pull Request, targeting
gci-dev
branch, following the template provided in the description
Resources:
- If you need help or get lost, post a "New Topic" in the coding-backend-tasks stream.
- Pull request template at this link.
- Commit message Style Guide can be found here.
- How to fork, clone and setup remotes the project into your account wiki page can be found here.
Work Submission:
Submit a link to Pull Request (PR), referencing issue #389, created with the change.
Task tags
Students who completed this task
_daksha_, i_maier, HardikJH