Merge pull request #269 from UTDNebula/tag-grouping

Tag grouping

Author: mikehquan19

api/controllers/astra.go

@@ -19,6 +19,7 @@ var astraCollection *mongo.Collection = configs.GetCollection("astra")
 
 // @Id				AstraEvents
 // @Router			/astra/{date} [get]
+// @Tags			Events
 // @Description	"Returns AstraEvent based on the input date"
 // @Produce		json
 // @Param			date	path		string																true	"date (ISO format) to retrieve astra events"

api/controllers/autocomplete.go

@@ -19,6 +19,7 @@ var DAGCollection *mongo.Collection = configs.GetCollection("DAG")
 
 // @Id				autocompleteDAG
 // @Router			/autocomplete/dag [get]
+// @Tags			Other
 // @Description	"Returns an aggregation of courses for use in generating autocomplete DAGs"
 // @Produce		json
 // @Success		200	{object}	schema.APIResponse[[]schema.Autocomplete]	"An aggregation of courses for use in generating autocomplete DAGs"

api/controllers/course.go

@@ -20,6 +20,7 @@ var courseCollection *mongo.Collection = configs.GetCollection("courses")
 
 // @Id				courseSearch
 // @Router			/course [get]
+// @Tags			Courses
 // @Description	"Returns paginated list of courses matching the query's string-typed key-value pairs. See offset for more details on pagination."
 // @Produce		json
 // @Param			offset					query		number								false	"The starting position of the current page of courses (e.g. For starting at the 17th course, offset=16)."
@@ -79,6 +80,7 @@ func CourseSearch(c *gin.Context) {
 
 // @Id				courseById
 // @Router			/course/{id} [get]
+// @Tags			Courses
 // @Description	"Returns the course with given ID"
 // @Produce		json
 // @Param			id	path		string								true	"ID of the course to get"
@@ -109,6 +111,7 @@ func CourseById(c *gin.Context) {
 
 // @Id				courseAll
 // @Router			/course/all [get]
+// @Tags			Courses
 // @Description	"Returns all courses"
 // @Produce		json
 // @Success		200	{object}	schema.APIResponse[[]schema.Course]	"All courses"
@@ -139,6 +142,7 @@ func CourseAll(c *gin.Context) {
 
 // @Id				courseSectionSearch
 // @Router			/course/sections [get]
+// @Tags			Courses
 // @Description	"Returns paginated list of sections of all the courses matching the query's string-typed key-value pairs. See former_offset and latter_offset for pagination details."
 // @Produce		json
 // @Param			former_offset			query		number									false	"The starting position of the current page of courses (e.g. For starting at the 17th course, former_offset=16)."
@@ -166,6 +170,7 @@ func CourseSectionSearch() gin.HandlerFunc {
 
 // @Id				courseSectionById
 // @Router			/course/{id}/sections [get]
+// @Tags			Courses
 // @Description	"Returns the all of the sections of the course with given ID"
 // @Produce		json
 // @Param			id	path		string									true	"ID of the course to get"
@@ -248,6 +253,7 @@ func courseSection(flag string, c *gin.Context) {
 
 // @Id				courseProfessorSearch
 // @Router			/course/professors [get]
+// @Tags			Courses
 // @Description	"Returns paginated list of professors of all the courses matching the query's string-typed key-value pairs. See former_offset and latter_offset for pagination details."
 // @Produce		json
 // @Param			former_offset			query		number									false	"The starting position of the current page of courses (e.g. For starting at the 17th course, former_offset=16)."
@@ -273,6 +279,7 @@ func CourseProfessorSearch(c *gin.Context) {
 
 // @Id				courseProfessorById
 // @Router			/course/{id}/professors [get]
+// @Tags			Courses
 // @Description	"Returns the all of the professors of the course with given ID"
 // @Produce		json
 // @Param			id	path		string									true	"ID of the course to get"
@@ -394,6 +401,7 @@ func getCourseQuery(flag string, c *gin.Context) (bson.M, error) {
 
 // @Id				trendsCourseSectionSearch
 // @Router			/course/sections/trends [get]
+// @Tags			Courses
 // @Description	"Returns all of the given course's sections. Specialized high-speed convenience endpoint for UTD Trends internal use; limited query flexibility."
 // @Produce		json
 // @Param			course_number	query		string									true	"The course's official number"

api/controllers/events.go

@@ -19,6 +19,7 @@ var eventsCollection *mongo.Collection = configs.GetCollection("events")
 
 // @Id				events
 // @Router			/events/{date} [get]
+// @Tags			Events
 // @Description	"Returns all sections with meetings on the specified date"
 // @Produce		json
 // @Param			date	path		string																	true	"ISO date of the set of events to get"
@@ -45,6 +46,7 @@ func Events(c *gin.Context) {
 
 // @Id				eventsByBuilding
 // @Router			/events/{date}/{building} [get]
+// @Tags			Events
 // @Description	"Returns all sections with meetings on the specified date in the specified building"
 // @Produce		json
 // @Param			date		path		string																	true	"ISO date of the set of events to get"

api/controllers/grades.go

@@ -53,6 +53,7 @@ import (
 
 // @Id				gradeAggregationBySemester
 // @Router			/grades/semester [get]
+// @Tags			Grades
 // @Description	"Returns grade distributions aggregated by semester"
 // @Produce		json
 // @Param			prefix			query		string									false	"The course's subject prefix"
@@ -71,6 +72,7 @@ func GradeAggregationSemester() gin.HandlerFunc {
 
 // @Id				gradeAggregationSectionType
 // @Router			/grades/semester/sectionType [get]
+// @Tags			Grades
 // @Description	"Returns the grade distributions aggregated by semester and broken down into section type"
 // @Produce		json
 // @Param			prefix			query		string										false	"The course's subject prefix"
@@ -89,6 +91,7 @@ func GradesAggregationSectionType() gin.HandlerFunc {
 
 // @Id				gradeAggregationOverall
 // @Router			/grades/overall [get]
+// @Tags			Grades
 // @Description	"Returns the overall grade distribution"
 // @Produce		json
 // @Param			prefix			query		string						false	"The course's subject prefix"
@@ -107,6 +110,7 @@ func GradesAggregationOverall() gin.HandlerFunc {
 
 // @Id				GradesByCourseID
 // @Router			/course/{id}/grades [get]
+// @Tags			Courses
 // @Description	"Returns the overall grade distribution for a course"
 // @Produce		json
 // @Param			id	path		string						true	"ID of course to get grades for"
@@ -121,6 +125,7 @@ func GradesByCourseID() gin.HandlerFunc {
 
 // @Id				GradesBySectionID
 // @Router			/section/{id}/grades [get]
+// @Tags			Sections
 // @Description	"Returns the overall grade distribution for a section"
 // @Produce		json
 // @Param			id	path		string						true	"ID of section to get grades for"
@@ -135,6 +140,7 @@ func GradesBySectionID() gin.HandlerFunc {
 
 // @Id				GradesByProfessorID
 // @Router			/professor/{id}/grades [get]
+// @Tags			Professors
 // @Description	"Returns the overall grade distribution for a professor"
 // @Produce		json
 // @Param			id	path		string						true	"ID of professor to get grades for"

api/controllers/mazevo.go

@@ -19,6 +19,7 @@ var mazevoCollection *mongo.Collection = configs.GetCollection("mazevo")
 
 // @Id				MazevoEvents
 // @Router			/mazevo/{date} [get]
+// @Tags			Events
 // @Description	"Returns MazevoEvent based on the input date"
 // @Produce		json
 // @Param			date	path		string																true	"date (ISO format) to retrieve mazevo events"

api/controllers/professor.go

@@ -20,6 +20,7 @@ var professorCollection *mongo.Collection = configs.GetCollection("professors")
 
 // @Id				professorSearch
 // @Router			/professor [get]
+// @Tags			Professors
 // @Description	"Returns paginated list of professors matching the query's string-typed key-value pairs. See offset for more details on pagination."
 // @Produce		json
 // @Param			offset							query		number									false	"The starting position of the current page of professors (e.g. For starting at the 17th professor, offset=16)."
@@ -87,6 +88,7 @@ func ProfessorSearch(c *gin.Context) {
 
 // @Id				professorById
 // @Router			/professor/{id} [get]
+// @Tags			Professors
 // @Description	"Returns the professor with given ID"
 // @Produce		json
 // @Param			id	path		string									true	"ID of the professor to get"
@@ -119,6 +121,7 @@ func ProfessorById(c *gin.Context) {
 
 // @Id				professorAll
 // @Router			/professor/all [get]
+// @Tags			Professors
 // @Description	"Returns all professors"
 // @Produce		json
 // @Success		200	{object}	schema.APIResponse[[]schema.Professor]	"All professors"
@@ -149,6 +152,7 @@ func ProfessorAll(c *gin.Context) {
 
 // @Id				professorCourseSearch
 // @Router			/professor/courses [get]
+// @Tags			Professors
 // @Description	"Returns paginated list of the courses of all the professors matching the query's string-typed key-value pairs. See former_offset and latter_offset for pagination details."
 // @Produce		json
 // @Param			former_offset					query		number									false	"The starting position of the current page of professors (e.g. For starting at the 17th professor, former_offset=16)."
@@ -184,6 +188,7 @@ func ProfessorCourseSearch() gin.HandlerFunc {
 
 // @Id				professorCourseById
 // @Router			/professor/{id}/courses [get]
+// @Tags			Professors
 // @Description	"Returns all the courses taught by the professor with given ID"
 // @Produce		json
 // @Param			id	path		string								true	"ID of the professor to get"
@@ -282,6 +287,7 @@ func professorCourse(flag string, c *gin.Context) {
 
 // @Id				professorSectionSearch
 // @Router			/professor/sections [get]
+// @Tags			Professors
 // @Description	"Returns paginated list of the sections of all the professors matching the query's string-typed key-value pairs. See former_offset and latter_offset for pagination details."
 // @Produce		json
 // @Param			former_offset					query		number									false	"The starting position of the current page of professors (e.g. For starting at the 17th professor, former_offset=16)."
@@ -316,6 +322,7 @@ func ProfessorSectionSearch() gin.HandlerFunc {
 
 // @Id				professorSectionById
 // @Router			/professor/{id}/sections [get]
+// @Tags			Professors
 // @Description	"Returns all the sections taught by the professor with given ID"
 // @Produce		json
 // @Param			id	path		string									true	"ID of the professor to get"
@@ -433,6 +440,7 @@ func getProfessorQuery(flag string, c *gin.Context) (bson.M, error) {
 
 // @Id				trendsProfessorSectionSearch
 // @Router			/professor/sections/trends [get]
+// @Tags			Professors
 // @Description	"Returns all of the given professor's sections. Specialized high-speed convenience endpoint for UTD Trends internal use; limited query flexibility."
 // @Produce		json
 // @Param			first_name	query		string									true	"The professor's first name"

api/controllers/rooms.go

@@ -19,6 +19,7 @@ var buildingCollection *mongo.Collection = configs.GetCollection("rooms")
 
 // @Id				rooms
 // @Router			/rooms [get]
+// @Tags			Events
 // @Description	"Returns all schedulable rooms being used in the current and futures semesters from CourseBook, Astra, and Mazevo"
 // @Produce		json
 // @Success		200	{object}	schema.APIResponse[[]schema.BuildingRooms]	"All schedulable rooms being used in the current and futures semesters from CourseBook, Astra, and Mazevo"

api/controllers/section.go

@@ -20,6 +20,7 @@ var sectionCollection *mongo.Collection = configs.GetCollection("sections")
 
 // @Id				sectionSearch
 // @Router			/section [get]
+// @Tags			Sections
 // @Description	"Returns paginated list of sections matching the query's string-typed key-value pairs. See offset for more details on pagination."
 // @Produce		json
 // @Param			offset							query		number									false	"The starting position of the current page of sections (e.g. For starting at the 17th professor, offset=16)."
@@ -89,6 +90,7 @@ func SectionSearch(c *gin.Context) {
 
 // @Id				sectionById
 // @Router			/section/{id} [get]
+// @Tags			Sections
 // @Description	"Returns the section with given ID"
 // @Produce		json
 // @Param			id	path		string								true	"ID of the section to get"
@@ -121,6 +123,7 @@ func SectionById(c *gin.Context) {
 
 // @Id				sectionCourseSearch
 // @Router			/section/courses [get]
+// @Tags			Sections
 // @Description	"Returns paginated list of courses of all the sections matching the query's string-typed key-value pairs. See former_offset and latter_offset for pagination details."
 // @Produce		json
 // @Param			former_offset					query		number								false	"The starting position of the current page of sections (e.g. For starting at the 16th section, former_offset=16)."
@@ -157,6 +160,7 @@ func SectionCourseSearch() gin.HandlerFunc {
 
 // @Id				sectionCourseById
 // @Router			/section/{id}/course [get]
+// @Tags			Sections
 // @Description	"Returns the course of the section with given ID"
 // @Produce		json
 // @Param			id	path		string								true	"ID of the section to get"
@@ -248,6 +252,7 @@ func sectionCourse(flag string, c *gin.Context) {
 
 // @Id				sectionProfessorSearch
 // @Router			/section/professors [get]
+// @Tags			Sections
 // @Description	"Returns paginated list of professors of all the sections matching the query's string-typed key-value pairs. See former_offset and latter_offset for pagination details."
 // @Produce		json
 // @Param			former_offset					query		number									false	"The starting position of the current page of sections (e.g. For starting at the 16th sections, former_offset=16)."
@@ -284,6 +289,7 @@ func SectionProfessorSearch() gin.HandlerFunc {
 
 // @Id				sectionProfessorById
 // @Router			/section/{id}/professors [get]
+// @Tags			Sections
 // @Description	"Returns the paginated list of professors of the section with given ID"
 // @Produce		json
 // @Param			id	path		string									true	"ID of the section to get"

api/controllers/storage.go

@@ -45,6 +45,7 @@ func getOrCreateBucket(client *storage.Client, bucket string) (*storage.BucketHa
 
 // @Id				bucketInfo
 // @Router			/storage/{bucket} [get]
+// @Tags			Internal
 // @Description	"Get info on a bucket. This route is restricted to only Nebula Labs internal Projects."
 // @Param			bucket			path		string									true	"Name of the bucket"
 // @Param			x-storage-key	header		string									true	"The internal storage key"
@@ -92,6 +93,7 @@ func BucketInfo(c *gin.Context) {
 
 // @Id				deleteBucket
 // @Router			/storage/{bucket} [delete]
+// @Tags			Internal
 // @Description	"Delete a bucket. This route is restricted to only Nebula Labs internal Projects."
 // @Param			bucket			path		string						true	"Name of the bucket"
 // @Param			x-storage-key	header		string						true	"The internal storage key"
@@ -138,6 +140,7 @@ func DeleteBucket(c *gin.Context) {
 
 // @Id				objectInfo
 // @Router			/storage/{bucket}/{objectID} [get]
+// @Tags			Internal
 // @Description	"Get info on an object in a bucket. This route is restricted to only Nebula Labs internal Projects."
 // @Param			bucket			path		string									true	"Name of the bucket"
 // @Param			objectID		path		string									true	"ID of the object"
@@ -175,6 +178,7 @@ func ObjectInfo(c *gin.Context) {
 
 // @Id				postObject
 // @Router			/storage/{bucket}/{objectID} [post]
+// @Tags			Internal
 // @Description	"Upload an object to a bucket. This route is restricted to only Nebula Labs internal Projects."
 // @Param			bucket			path		string									true	"Name of the bucket"
 // @Param			objectID		path		string									true	"ID of the object"
@@ -236,6 +240,7 @@ func PostObject(c *gin.Context) {
 
 // @Id				deleteObject
 // @Router			/storage/{bucket}/{objectID} [delete]
+// @Tags			Internal
 // @Description	"Delete an object from a bucket. This route is restricted to only Nebula Labs internal Projects."
 // @Param			bucket			path		string						true	"Name of the bucket"
 // @Param			objectID		path		string						true	"ID of the object"
@@ -270,6 +275,7 @@ func DeleteObject(c *gin.Context) {
 
 // @Id				objectUploadURL
 // @Router			/storage/{bucket}/{objectID}/url [put]
+// @Tags			Internal
 // @Accept			json
 // @Description	"Create's a new signed URL for target object"
 // @Param			bucket			path		string						true	"Name of the bucket"