diff --git a/controllers/attendance_controller.go b/controllers/attendance_controller.go index 060900a..bd4ca3a 100644 --- a/controllers/attendance_controller.go +++ b/controllers/attendance_controller.go @@ -23,7 +23,7 @@ func NewAttendanceController(service services.AttendanceService) *AttendanceCont // CreateOrUpdateAttendance godoc // @Summary 出席情報を作成または更新 // @Description 出席情報を作成または更新 -// @Tags attendance +// @Tags Attendance // @Accept json // @Produce json // @Param cid path int true "Class ID" @@ -55,7 +55,7 @@ func (ac *AttendanceController) CreateOrUpdateAttendance(ctx *gin.Context) { // GetAllAttendances godoc // @Summary クラスの全ての出席情報を取得 // @Description クラスの全ての出席情報を取得 -// @Tags attendance +// @Tags Attendance // @Accept json // @Produce json // @Param classID path int true "Class ID" @@ -80,7 +80,7 @@ func (ac *AttendanceController) GetAllAttendances(ctx *gin.Context) { // GetAttendance godoc // @Summary 出席情報を取得 // @Description 指定されたIDの出席情報を取得 -// @Tags attendance +// @Tags Attendance // @Accept json // @Produce json // @Param id path int true "Attendance ID" @@ -100,7 +100,7 @@ func (ac *AttendanceController) GetAttendance(ctx *gin.Context) { // DeleteAttendance godoc // @Summary 出席情報を削除 // @Description 指定されたIDの出席情報を削除 -// @Tags attendance +// @Tags Attendance // @Accept json // @Produce json // @Param id path int true "Attendance ID" diff --git a/controllers/class_board_controller.go b/controllers/class_board_controller.go index 6ce9c2d..4ad2484 100644 --- a/controllers/class_board_controller.go +++ b/controllers/class_board_controller.go @@ -30,7 +30,7 @@ func NewClassBoardController(service services.ClassBoardService, uploader utils. // CreateClassBoard godoc // @Summary クラス掲示板を作成 // @Description クラス掲示板を作成します。 -// @Tags class_board +// @Tags Class Board // @Accept multipart/form-data // @Produce json // @Param title formData string true "Class board title" @@ -69,7 +69,7 @@ func (c *ClassBoardController) CreateClassBoard(ctx *gin.Context) { // GetClassBoardByID godoc // @Summary IDでグループ掲示板を取得 // @Description 指定されたIDのグループ掲示板の詳細を取得します。 -// @Tags class_board +// @Tags Class Board // @Accept json // @Produce json // @Param id path int true "グループ掲示板ID" @@ -97,7 +97,7 @@ func (c *ClassBoardController) GetClassBoardByID(ctx *gin.Context) { // GetAllClassBoards godoc // @Summary 全てのグループ掲示板を取得 // @Description cidに基づいて、グループの全ての掲示板を取得します。 -// @Tags class_board +// @Tags Class Board // @Accept json // @Produce json // @Param cid query int true "クラスID" @@ -121,7 +121,7 @@ func (c *ClassBoardController) GetAllClassBoards(ctx *gin.Context) { // GetAnnouncedClassBoards godoc // @Summary 公告されたグループ掲示板を取得 // @Description cidに基づいて、公告されたグループの掲示板を取得します。 -// @Tags class_board +// @Tags Class Board // @Accept json // @Produce json // @Param cid query int true "クラスID" @@ -146,7 +146,7 @@ func (c *ClassBoardController) GetAnnouncedClassBoards(ctx *gin.Context) { // UpdateClassBoard godoc // @Summary グループ掲示板を更新 // @Description 指定されたIDのグループ掲示板の詳細を更新します。 -// @Tags class_board +// @Tags Class Board // @Accept json // @Produce json // @Param id path int true "グループ掲示板ID" @@ -184,7 +184,7 @@ func (c *ClassBoardController) UpdateClassBoard(ctx *gin.Context) { // DeleteClassBoard godoc // @Summary グループ掲示板を削除 // @Description 指定されたIDのグループ掲示板を削除します。 -// @Tags class_board +// @Tags Class Board // @Accept json // @Produce json // @Param id path int true "グループ掲示板ID" diff --git a/controllers/class_code_controller.go b/controllers/class_code_controller.go index 68e53ed..8e6f592 100644 --- a/controllers/class_code_controller.go +++ b/controllers/class_code_controller.go @@ -22,7 +22,7 @@ func NewClassCodeController(classCodeService services.ClassCodeService, classUse // CheckSecretExists godoc // @Summary グループコードにシークレットが存在するかチェック // @Description 指定されたグループコードにシークレットがあるかどうかをチェックする。 -// @Tags class_code +// @Tags Class Code // @Accept json // @Produce json // @Param code query string true "Code to check" @@ -45,7 +45,7 @@ func (c *ClassCodeController) CheckSecretExists(ctx *gin.Context) { // VerifyClassCode godoc // @Summary グループコードとシークレットを検証＆ユーザーに役割を割り当てる // @Description グループコードと、該当する場合はそのシークレットを確認する。また、指定されたユーザーに役割を割り当てる。 -// @Tags class_code +// @Tags Class Code // @Accept json // @Produce json // @Param code query string true "Code to verify" diff --git a/controllers/class_schedule_controller.go b/controllers/class_schedule_controller.go index a932b97..934bdb7 100644 --- a/controllers/class_schedule_controller.go +++ b/controllers/class_schedule_controller.go @@ -25,7 +25,7 @@ func NewClassScheduleController(service services.ClassScheduleService) *ClassSch // CreateClassSchedule godoc // @Summary クラススケジュールを作成 // @Description 新しいクラススケジュールを作成する。 -// @Tags class_schedule +// @Tags Class Schedule // @Accept json // @Produce json // @Param classSchedule body dto.ClassScheduleDTO true "Class schedule to create" @@ -59,7 +59,7 @@ func (controller *ClassScheduleController) CreateClassSchedule(c *gin.Context) { // GetClassScheduleByID godoc // @Summary IDでクラススケジュールを取得 // @Description 指定されたIDのクラススケジュールを取得する。 -// @Tags class_schedule +// @Tags Class Schedule // @Accept json // @Produce json // @Param id path int true "Class schedule ID" @@ -86,7 +86,7 @@ func (controller *ClassScheduleController) GetClassScheduleByID(c *gin.Context) // GetAllClassSchedules godoc // @Summary 全てのクラススケジュールを取得 // @Description 指定されたクラスIDの全てのクラススケジュールを取得する。 -// @Tags class_schedule +// @Tags Class Schedule // @Accept json // @Produce json // @Param cid query uint false "Class ID" @@ -106,7 +106,7 @@ func (controller *ClassScheduleController) GetAllClassSchedules(c *gin.Context) // UpdateClassSchedule godoc // @Summary クラススケジュールを更新 // @Description 指定されたIDのクラススケジュールを更新する。 -// @Tags class_schedule +// @Tags Class Schedule // @Accept json // @Produce json // @Param id path int true "Class schedule ID" @@ -140,7 +140,7 @@ func (controller *ClassScheduleController) UpdateClassSchedule(c *gin.Context) { // DeleteClassSchedule godoc // @Summary クラススケジュールを削除 // @Description 指定されたIDのクラススケジュールを削除する。 -// @Tags class_schedule +// @Tags Class Schedule // @Accept json // @Produce json // @Param id path int true "Class schedule ID" @@ -166,7 +166,7 @@ func (controller *ClassScheduleController) DeleteClassSchedule(c *gin.Context) { // GetLiveClassSchedules godoc // @Summary ライブ中のクラススケジュールを取得 // @Description 指定されたクラスIDのライブ中のクラススケジュールを取得する。 -// @Tags class_schedule +// @Tags Class Schedule // @Accept json // @Produce json // @Param cid query uint true "Class ID" @@ -186,7 +186,7 @@ func (controller *ClassScheduleController) GetLiveClassSchedules(c *gin.Context) // GetClassSchedulesByDate godoc // @Summary 日付でクラススケジュールを取得 // @Description 指定されたクラスIDと日付のクラススケジュールを取得する。 -// @Tags class_schedule +// @Tags Class Schedule // @Accept json // @Produce json // @Param cid query uint true "Class ID" diff --git a/controllers/class_user_controller.go b/controllers/class_user_controller.go index d3136e6..e6028a6 100644 --- a/controllers/class_user_controller.go +++ b/controllers/class_user_controller.go @@ -22,6 +22,7 @@ func NewClassUserController(service services.ClassUserService) *ClassUserControl // ChangeUserRole godoc // @Summary ユーザーのロールを変更します。 // @Description ユーザーのロールを変更します。 +// @Tags Class User // @ID change-user-role // @Accept json // @Produce json diff --git a/docs/docs.go b/docs/docs.go index b009d18..4174268 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -25,7 +25,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "出席情報を取得", "parameters": [ @@ -61,7 +61,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "出席情報を削除", "parameters": [ @@ -99,7 +99,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "出席情報を作成または更新", "parameters": [ @@ -158,7 +158,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "クラスの全ての出席情報を取得", "parameters": [ @@ -199,7 +199,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "全てのグループ掲示板を取得", "parameters": [ @@ -241,7 +241,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "クラス掲示板を作成", "parameters": [ @@ -318,7 +318,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "公告されたグループ掲示板を取得", "parameters": [ @@ -362,7 +362,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "IDでグループ掲示板を取得", "parameters": [ @@ -410,7 +410,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "グループ掲示板を削除", "parameters": [ @@ -452,7 +452,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "グループ掲示板を更新", "parameters": [ @@ -511,7 +511,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_code" + "Class Code" ], "summary": "グループコードにシークレットが存在するかチェック", "parameters": [ @@ -555,7 +555,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_code" + "Class Code" ], "summary": "グループコードとシークレットを検証＆ユーザーに役割を割り当てる", "parameters": [ @@ -618,7 +618,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "全てのクラススケジュールを取得", "parameters": [ @@ -659,7 +659,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "クラススケジュールを作成", "parameters": [ @@ -705,7 +705,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "日付でクラススケジュールを取得", "parameters": [ @@ -762,7 +762,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "ライブ中のクラススケジュールを取得", "parameters": [ @@ -806,7 +806,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "IDでクラススケジュールを取得", "parameters": [ @@ -848,7 +848,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "クラススケジュールを更新", "parameters": [ @@ -899,7 +899,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "クラススケジュールを削除", "parameters": [ @@ -942,6 +942,9 @@ const docTemplate = `{ "produces": [ "application/json" ], + "tags": [ + "Class User" + ], "summary": "ユーザーのロールを変更します。", "operationId": "change-user-role", "parameters": [ diff --git a/docs/swagger.json b/docs/swagger.json index a0b4862..4ba25f5 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -14,7 +14,7 @@ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "出席情報を取得", "parameters": [ @@ -50,7 +50,7 @@ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "出席情報を削除", "parameters": [ @@ -88,7 +88,7 @@ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "出席情報を作成または更新", "parameters": [ @@ -147,7 +147,7 @@ "application/json" ], "tags": [ - "attendance" + "Attendance" ], "summary": "クラスの全ての出席情報を取得", "parameters": [ @@ -188,7 +188,7 @@ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "全てのグループ掲示板を取得", "parameters": [ @@ -230,7 +230,7 @@ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "クラス掲示板を作成", "parameters": [ @@ -307,7 +307,7 @@ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "公告されたグループ掲示板を取得", "parameters": [ @@ -351,7 +351,7 @@ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "IDでグループ掲示板を取得", "parameters": [ @@ -399,7 +399,7 @@ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "グループ掲示板を削除", "parameters": [ @@ -441,7 +441,7 @@ "application/json" ], "tags": [ - "class_board" + "Class Board" ], "summary": "グループ掲示板を更新", "parameters": [ @@ -500,7 +500,7 @@ "application/json" ], "tags": [ - "class_code" + "Class Code" ], "summary": "グループコードにシークレットが存在するかチェック", "parameters": [ @@ -544,7 +544,7 @@ "application/json" ], "tags": [ - "class_code" + "Class Code" ], "summary": "グループコードとシークレットを検証＆ユーザーに役割を割り当てる", "parameters": [ @@ -607,7 +607,7 @@ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "全てのクラススケジュールを取得", "parameters": [ @@ -648,7 +648,7 @@ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "クラススケジュールを作成", "parameters": [ @@ -694,7 +694,7 @@ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "日付でクラススケジュールを取得", "parameters": [ @@ -751,7 +751,7 @@ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "ライブ中のクラススケジュールを取得", "parameters": [ @@ -795,7 +795,7 @@ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "IDでクラススケジュールを取得", "parameters": [ @@ -837,7 +837,7 @@ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "クラススケジュールを更新", "parameters": [ @@ -888,7 +888,7 @@ "application/json" ], "tags": [ - "class_schedule" + "Class Schedule" ], "summary": "クラススケジュールを削除", "parameters": [ @@ -931,6 +931,9 @@ "produces": [ "application/json" ], + "tags": [ + "Class User" + ], "summary": "ユーザーのロールを変更します。", "operationId": "change-user-role", "parameters": [ diff --git a/docs/swagger.yaml b/docs/swagger.yaml index d3c58b9..66d1cd5 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -192,7 +192,7 @@ paths: type: string summary: 出席情報を作成または更新 tags: - - attendance + - Attendance /at/{classID}: get: consumes: @@ -219,7 +219,7 @@ paths: type: string summary: クラスの全ての出席情報を取得 tags: - - attendance + - Attendance /at/attendance/{id}: delete: consumes: @@ -244,7 +244,7 @@ paths: type: string summary: 出席情報を削除 tags: - - attendance + - Attendance get: consumes: - application/json @@ -268,7 +268,7 @@ paths: type: string summary: 出席情報を取得 tags: - - attendance + - Attendance /cb: get: consumes: @@ -297,7 +297,7 @@ paths: type: string summary: 全てのグループ掲示板を取得 tags: - - class_board + - Class Board post: consumes: - multipart/form-data @@ -348,7 +348,7 @@ paths: type: string summary: クラス掲示板を作成 tags: - - class_board + - Class Board /cb/{id}: delete: consumes: @@ -377,7 +377,7 @@ paths: type: string summary: グループ掲示板を削除 tags: - - class_board + - Class Board get: consumes: - application/json @@ -409,7 +409,7 @@ paths: type: string summary: IDでグループ掲示板を取得 tags: - - class_board + - Class Board patch: consumes: - application/json @@ -447,7 +447,7 @@ paths: type: string summary: グループ掲示板を更新 tags: - - class_board + - Class Board /cb/announced: get: consumes: @@ -476,7 +476,7 @@ paths: type: string summary: 公告されたグループ掲示板を取得 tags: - - class_board + - Class Board /cc/checkSecretExists: get: consumes: @@ -505,7 +505,7 @@ paths: type: string summary: グループコードにシークレットが存在するかチェック tags: - - class_code + - Class Code /cc/verifyClassCode: get: consumes: @@ -547,7 +547,7 @@ paths: type: string summary: グループコードとシークレットを検証＆ユーザーに役割を割り当てる tags: - - class_code + - Class Code /cs: get: consumes: @@ -575,7 +575,7 @@ paths: type: string summary: 全てのクラススケジュールを取得 tags: - - class_schedule + - Class Schedule post: consumes: - application/json @@ -604,7 +604,7 @@ paths: type: string summary: クラススケジュールを作成 tags: - - class_schedule + - Class Schedule /cs/{id}: delete: consumes: @@ -633,7 +633,7 @@ paths: type: string summary: クラススケジュールを削除 tags: - - class_schedule + - Class Schedule get: consumes: - application/json @@ -661,7 +661,7 @@ paths: type: string summary: IDでクラススケジュールを取得 tags: - - class_schedule + - Class Schedule put: consumes: - application/json @@ -695,7 +695,7 @@ paths: type: string summary: クラススケジュールを更新 tags: - - class_schedule + - Class Schedule /cs/date: get: consumes: @@ -733,7 +733,7 @@ paths: type: string summary: 日付でクラススケジュールを取得 tags: - - class_schedule + - Class Schedule /cs/live: get: consumes: @@ -762,7 +762,7 @@ paths: type: string summary: ライブ中のクラススケジュールを取得 tags: - - class_schedule + - Class Schedule /cu/{uid}/{cid}/{role}: patch: consumes: @@ -797,6 +797,8 @@ paths: schema: type: string summary: ユーザーのロールを変更します。 + tags: + - Class User /example/helloworld: get: consumes: