Open benjaminkostiuk opened 3 years ago
@youcefs21 Just take this one step at a time. You can reference the exisiting code or ask me for anything you don't understand. Most of the code should be fairly similar to what's already there but no guarantees.
Overview
Implement
/user
endpoints for the course-management microservice defined in https://github.com/puffproject/docs/blob/master/API_ARCHITECTURE.md.The task breaks down into the following steps:
PR#1 should be:
AssignmentEnrollment
entity based on theASSIGNMENT_ENROLLMENT
table. This is the table that keeps track of if a user is tracking an assignment, i.e. they are working on it. This includes a column where they can pin the assignment for easy access. Should join on the assignment id (SeeAssignment.java
to see example of join column)AssignmentEnrollment
entity with swagger annotations (@Model etc.) + ignore the id and user id fields.AssignmentEnrollmentRepository
for the JPA database connection.AssignmentEnrollmentPage
model (extendBasePage
) to define the data model we want to return to the user. Add necessary swagger annotations.bootstrap_data.sql
file to automatically populate the database when the service is loaded.PR#2 should be:
restApi
package with all the right annotations. Don't forget to include thePrincipal
argument to get the user's token (it represents their identity)/user/assignments
: pageable endpoint that returnsAssignmentEnrollmentPage
objects. (Double check here that we can sort to the have the pinned ones at the top, I'm not sure if it's possible)/user/assignment/{assignmentId}/enroll?pin={true|false}
/user/assignment/{assignmentId}/unenroll
/user/engagement/{sourceType}/{sourceItemId}/vote
: Check if a user has voted on something (Might need to create a new model to return)PR#3 should be: