Skip to content

Add pagination documentation for /course /professor and /section #250

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.

Sign up for GitHub

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

Merged
jpahm merged 3 commits into from
Feb 21, 2025
Merged

Add pagination documentation for /course /professor and /section #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d296b1
Add pagination documentation for /course /professor and /section
justinschwerdtfeger Feb 7, 2025
9ce29b8
Merge branch 'develop' into develop
jpahm Feb 16, 2025
49638b2
Merge branch 'develop' into develop
justinschwerdtfeger Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion api/controllers/course.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ var courseCollection *mongo.Collection = configs.GetCollection("courses")

// @Id courseSearch
// @Router /course [get]
// @Description "Returns all courses matching the query's string-typed key-value pairs"
// @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 staritng position of the current page of courses (e.g. For starting at the 17th course, offset=16)."
// @Param course_number query string false "The course's official number"
// @Param subject_prefix query string false "The course's subject prefix"
// @Param title query string false "The course's title"
Expand Down
3 changes: 2 additions & 1 deletion api/controllers/professor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ var professorCollection *mongo.Collection = configs.GetCollection("professors")

// @Id professorSearch
// @Router /professor [get]
// @Description "Returns all professors matching the query's string-typed key-value pairs"
// @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 staritng position of the current page of professors (e.g. For starting at the 17th professor, offset=16)."
// @Param first_name query string false "The professor's first name"
// @Param last_name query string false "The professor's last name"
// @Param titles query string false "One of the professor's title"
Expand Down
3 changes: 2 additions & 1 deletion api/controllers/section.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ var sectionCollection *mongo.Collection = configs.GetCollection("sections")

// @Id sectionSearch
// @Router /section [get]
// @Description "Returns all courses matching the query's string-typed key-value pairs"
// @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 staritng position of the current page of sections (e.g. For starting at the 17th professor, offset=16)."
// @Param section_number query string false "The section's official number"
// @Param course_reference query string false "An id that points to the course in MongoDB that this section is an instantiation of"
// @Param academic_session.name query string false "The name of the academic session of the section"
Expand Down