Skip to content

Commit daa0cb1

Browse files
committed
Add the tagging for new events endpoints
1 parent 32d893b commit daa0cb1

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

api/controllers/events.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ func EventsByBuilding(c *gin.Context) {
106106

107107
// @Id eventsByRoom
108108
// @Router /events/{date}/{building}/{room} [get]
109+
// @Tags Events
109110
// @Description "Returns all sections with meetings on the specified date in the specified building and room"
110111
// @Produce json
111112
// @Param date path string true "ISO date of the set of events to get"
@@ -164,6 +165,7 @@ func EventsByRoom(c *gin.Context) {
164165

165166
// @Id sectionsByRoomDetailed
166167
// @Router /events/{date}/{building}/{room}/sections [get]
168+
// @Tags Events
167169
// @Description "Returns full section objects with meetings on the specified date in the specified building and room"
168170
// @Produce json
169171
// @Param date path string true "ISO date of the set of events to get"

api/docs/docs.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -739,6 +739,9 @@ const docTemplate = `{
739739
"produces": [
740740
"application/json"
741741
],
742+
"tags": [
743+
"Events"
744+
],
742745
"operationId": "eventsByRoom",
743746
"parameters": [
744747
{
@@ -791,6 +794,9 @@ const docTemplate = `{
791794
"produces": [
792795
"application/json"
793796
],
797+
"tags": [
798+
"Events"
799+
],
794800
"operationId": "sectionsByRoomDetailed",
795801
"parameters": [
796802
{

api/docs/swagger.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1234,6 +1234,8 @@ paths:
12341234
description: A string describing the error
12351235
schema:
12361236
$ref: '#/definitions/schema.APIResponse-string'
1237+
tags:
1238+
- Events
12371239
/events/{date}/{building}/{room}/sections:
12381240
get:
12391241
description: '"Returns full section objects with meetings on the specified date
@@ -1271,6 +1273,8 @@ paths:
12711273
description: A string describing the error
12721274
schema:
12731275
$ref: '#/definitions/schema.APIResponse-string'
1276+
tags:
1277+
- Events
12741278
/grades/overall:
12751279
get:
12761280
description: '"Returns the overall grade distribution"'

0 commit comments

Comments
 (0)