Minor changes for consistency

Author: mikehquan19

api/controllers/controller_utils.go

@@ -15,10 +15,17 @@ import (
 
 // Sets the API's response to a request, producing valid JSON given a status code and data.
 func respond[T any](c *gin.Context, status int, message string, data T) {
-	c.JSON(status, schema.APIResponse[T]{Status: status, Message: message, Data: data})
+	c.JSON(
+		status,
+		schema.APIResponse[T]{
+			Status:  status,
+			Message: message,
+			Data:    data,
+		},
+	)
 }
-// Builds a MongoDB filter for type T based on the given flag search or byid
 
+// Builds a MongoDB filter for type T based on the given flag search or byid
 func getQuery[T any](flag string, c *gin.Context) (bson.M, error) {
 	switch flag {
 	case "Search":
@@ -44,10 +51,10 @@ func getQuery[T any](flag string, c *gin.Context) (bson.M, error) {
 	}
 }
 
-
 // Helper function for logging and responding to a generic internal server error.
 func respondWithInternalError(c *gin.Context, err error) {
-	// Note that we use log.Output here to be able to set the stack depth to the frame above this one (2), which allows us to log the location this function was called from
+	// Note that we use log.Output here to be able to set the stack depth to the frame above this one (2),
+	// which allows us to log the location this function was called from
 	log.Output(2, fmt.Sprintf("INTERNAL SERVER ERROR: %s", err.Error()))
 	// Capture error with Sentry
 	if hub := sentrygin.GetHubFromContext(c); hub != nil {
@@ -58,14 +65,19 @@ func respondWithInternalError(c *gin.Context, err error) {
 	respond(c, http.StatusInternalServerError, "error", err.Error())
 }
 
-// Attempts to convert the given parameter to an ObjectID for use with MongoDB. Automatically responds with http.StatusBadRequest if conversion fails.
+// Attempts to convert the given parameter to an ObjectID for use with MongoDB.
+// Automatically responds with http.StatusBadRequest if conversion fails.
 func objectIDFromParam(c *gin.Context, paramName string) (*primitive.ObjectID, error) {
 	idHex := c.Param(paramName)
 	objectId, convertIdErr := primitive.ObjectIDFromHex(idHex)
 	if convertIdErr != nil {
 		// Respond with an error if we can't covert successfully
 		log.Println(convertIdErr)
-		respond(c, http.StatusBadRequest, fmt.Sprintf("Parameter \"%s\" is not a valid ObjectID.", paramName), convertIdErr.Error())
+		respond(c,
+			http.StatusBadRequest,
+			fmt.Sprintf("Parameter \"%s\" is not a valid ObjectID.", paramName),
+			convertIdErr.Error(),
+		)
 		return nil, convertIdErr
 	}
 	return &objectId, nil

api/controllers/professor.go

@@ -54,11 +54,10 @@ func ProfessorSearch(c *gin.Context) {
 
 	var professors []schema.Professor
 
-
 	// build query key value pairs (only one value per key)
 	query, err := getQuery[schema.Professor]("Search", c)
 	if err != nil {
-    	return
+		return
 	}
 
 	optionLimit, err := configs.GetOptionLimit(&query, c)
@@ -81,7 +80,7 @@ func ProfessorSearch(c *gin.Context) {
 	}
 
 	// return result
-	respond[[]schema.Professor](c, http.StatusOK, "success", professors)
+	respond(c, http.StatusOK, "success", professors)
 }
 
 // @Id				professorById
@@ -102,8 +101,8 @@ func ProfessorById(c *gin.Context) {
 	// parse object id from id parameter
 	query, err := getQuery[schema.Professor]("ById", c)
 	if err != nil {
-    	return
-}
+		return
+	}
 
 	// find and parse matching professor
 	err = professorCollection.FindOne(ctx, query).Decode(&professor)
@@ -210,7 +209,7 @@ func professorCourse(flag string, c *gin.Context) {
 	// determine the professor's query
 	professorQuery, err = getQuery[schema.Professor](flag, c)
 	if err != nil {
-    	return
+		return
 	}
 
 	// determine the offset and limit for pagination stage
@@ -343,7 +342,7 @@ func professorSection(flag string, c *gin.Context) {
 	// determine the professor's query
 	professorQuery, err = getQuery[schema.Professor](flag, c)
 	if err != nil {
-   		return
+		return
 	}
 
 	// determine the offset and limit for pagination stage
@@ -402,7 +401,7 @@ func professorSection(flag string, c *gin.Context) {
 		respondWithInternalError(c, err)
 		return
 	}
-	
+
 	respond(c, http.StatusOK, "success", professorSections)
 }
 
@@ -425,7 +424,7 @@ func TrendsProfessorSectionSearch(c *gin.Context) {
 
 	professorQuery, err := getQuery[schema.Professor]("Search", c)
 	if err != nil {
-    	return
+		return
 	}
 
 	trendsCollection := configs.GetCollection("trends_prof_sections")

api/controllers/section.go

@@ -101,13 +101,13 @@ func SectionById(c *gin.Context) {
 	var section schema.Section
 
 	// parse object id from id parameter
-	objId, err := objectIDFromParam(c, "id")
+	query, err := getQuery[schema.Section]("ById", c)
 	if err != nil {
 		return
 	}
 
 	// find and parse matching section
-	err = sectionCollection.FindOne(ctx, bson.M{"_id": objId}).Decode(&section)
+	err = sectionCollection.FindOne(ctx, query).Decode(&section)
 	if err != nil {
 		respondWithInternalError(c, err)
 		return
@@ -180,7 +180,7 @@ func sectionCourse(flag string, c *gin.Context) {
 	if sectionQuery, err = getQuery[schema.Section](flag, c); err != nil {
 		return
 	}
-	
+
 	paginateMap, err := configs.GetAggregateLimit(&sectionQuery, c)
 	if err != nil {
 		respond(c, http.StatusBadRequest, "Error offset is not type integer", err.Error())
@@ -310,7 +310,7 @@ func sectionProfessor(flag string, c *gin.Context) {
 	if sectionQuery, err = getQuery[schema.Section](flag, c); err != nil {
 		return
 	}
-	
+
 	paginateMap, err := configs.GetAggregateLimit(&sectionQuery, c)
 	if err != nil {
 		respond(c, http.StatusBadRequest, "Error offset is not type integer", err.Error())
@@ -357,7 +357,7 @@ func sectionProfessor(flag string, c *gin.Context) {
 		respondWithInternalError(c, err)
 		return
 	}
-	
+
 	respond(c, http.StatusOK, "success", sectionProfessors)
-	
-}
+
+}