Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement the logic of the matchBuddy endpoint #49

Closed
f-fromont opened this issue Mar 14, 2022 · 2 comments · Fixed by #99
Closed

Implement the logic of the matchBuddy endpoint #49

f-fromont opened this issue Mar 14, 2022 · 2 comments · Fixed by #99
Assignees
Labels
Priority: High Status: Review Needed The implementation has finished and someone has been approached for review. Type: Feature The issue is about a new feature being introduced to the project.
Projects

Comments

@f-fromont
Copy link
Contributor

f-fromont commented Mar 14, 2022

Describe the task that needs to be done.
After the blank endpoint is created for the matchBuddy endpoint in the Pairing service, the actual logic and implementation needs to be complete with appropriate testing

Depends on #30 #22
Blocking: #50

Describe how a solution to your proposed task might look like (and any alternatives considered).
The endpoint takes in a list of courses from a JSON body that is passed in with the post request.

The matchBuddy endpoint needs to:

  • (TBC with user team) Authorize that the user who is sending the request is the user
  • Check that the courses passed in are all valid courses
  • Query the database to get back all students who are in the courses, remove any duplicates, and students who don't want to be paired
  • Get all relevant information of the students returned, and format them into a JSON list to be sent back to the frontend
  • Corresponding response code is returned based on success/failure

Response codes:
200 Ok, with list of possible buddies
204 No Content, if no buddies found
404 Not Found, if courses passed in are not valid
(TBD) 403 not authorized, if the user authentication system is set up (added as a later issue)

Notes

  • Authorization will be confirmed with user team, and added in a later issue
  • Communication team will be consulted in regards to welcome message, added in a later issue
@f-fromont f-fromont added Priority: High Status: Review Needed The implementation has finished and someone has been approached for review. Type: Feature The issue is about a new feature being introduced to the project. labels Mar 14, 2022
@f-fromont f-fromont added this to To do in Project via automation Mar 14, 2022
@f-fromont f-fromont added Status: In Progress The issue is currently been worked on by someone. and removed Status: Review Needed The implementation has finished and someone has been approached for review. labels Mar 17, 2022
@f-fromont f-fromont self-assigned this Mar 17, 2022
@f-fromont
Copy link
Contributor Author

@scorpionknifes does this issue SGTY?

@f-fromont f-fromont added Status: Review Needed The implementation has finished and someone has been approached for review. and removed Status: In Progress The issue is currently been worked on by someone. labels Mar 17, 2022
@scorpionknifes
Copy link
Member

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: High Status: Review Needed The implementation has finished and someone has been approached for review. Type: Feature The issue is about a new feature being introduced to the project.
Projects
2 participants