Rest API - User - Search - Due 4/23

[Code4SocialGood]

• Endpoint
  GET /api/users/search (refactor this existing endpoint)

• Background
  As shown in the attached wireframe, user could search for volunteers by combination of:
  Keyword
  Skills

• Current Implementation
  Currently, this endpoint searches users with keyword in userName, firstName or lastName. It accepts three input parameters.

• Requirement: Refactor Search Project Endpoint

• Input Parameters
  Keyword: this is a string, this is optional
  Skills list: this is a list, this is optional

• Business Logic

1. Search users that satisfy Both criteria of Keyword and Skill List, if they are provided in the input parameters
2. If neither keyword nor skills list is provided, return all users.
3. Keyword criteria: search in userName, firstName, lastName, title, introduction, skills
4. Skills criteria: search is skills (user_skill table)
5. Sort the result by userName in ascending order.

• Documentation
  Add the following comments to the endpoint operation:
  notes = Returns a list of users who has the keyword in user name / first name / last name / title / introduction / skills, AND, who has the skills. The search result is sorted by user name in ascending order.

• Wireframe
  

[Code4SocialGood]

Closed with PR