📝 docs: update Swagger summary and parameter descriptions

Modified summary, parameter descriptions, and names in Swagger to align with conventions.

Related issue: YJU-OKURA#9

controllers/chat_controller.go

@@ -29,7 +29,7 @@ func NewChatController(chatMgr *services.Manager, redisClient *redis.Client) *Ch
 // @Tags Chat Room
 // @Accept html
 // @Produce html
-// @Param scheduleId path string true "Schedule ID"
+// @Param scheduleId path string true "スケジュールID"
 // @Param userId path string true "User ID"
 // @Success 200 {string} string "チャットルームが正常にハンドルされました"
 // @Router /chat/room/{scheduleId}/{userId} [get]
@@ -50,7 +50,7 @@ func (c *ChatController) HandleChatRoom(ctx *gin.Context) {
 // @Tags Chat Room
 // @Accept json
 // @Produce json
-// @Param scheduleId path string true "Schedule ID"
+// @Param scheduleId path string true "スケジュールID"
 // @Success 200 {object} map[string]interface{} "Chat room created successfully."
 // @Failure 400 {object} map[string]interface{} "Failed to create chat room."
 // @Router /chat/create-room/{scheduleId} [post]
@@ -67,9 +67,9 @@ func (c *ChatController) CreateChatRoom(ctx *gin.Context) {
 // @Tags Chat Room
 // @Accept multipart/form-data
 // @Produce json
-// @Param scheduleId path int true "Schedule ID"
-// @Param user formData string true "User ID"
-// @Param message formData string true "Message"
+// @Param scheduleId path int true "スケジュールID"
+// @Param user formData string true "ユーザーID"
+// @Param message formData string true "メッセージ"
 // @Success 200 {object} map[string]interface{} "Message posted successfully."
 // @Router /chat/room/{scheduleId} [post]
 // @Security Bearer
@@ -90,7 +90,7 @@ func (c *ChatController) PostToChatRoom(ctx *gin.Context) {
 // @Tags Chat Room
 // @Accept json
 // @Produce json
-// @Param scheduleId path string true "Schedule ID"
+// @Param scheduleId path string true "スケジュールID"
 // @Success 200 {object} string "Chat room deleted successfully."
 // @Router /chat/room/{scheduleId} [delete]
 // @Security Bearer
@@ -106,7 +106,7 @@ func (c *ChatController) DeleteChatRoom(ctx *gin.Context) {
 // @Tags Chat Room
 // @Accept json
 // @Produce json
-// @Param scheduleId path int true "Schedule ID"
+// @Param scheduleId path int true "スケジュールID"
 // @Router /chat/stream/{scheduleId} [get]
 // @Security Bearer
 func (c *ChatController) StreamChat(ctx *gin.Context) {
@@ -131,7 +131,7 @@ func (c *ChatController) StreamChat(ctx *gin.Context) {
 // @Tags Chat Room
 // @Accept json
 // @Produce json
-// @Param roomid path string true "Room ID"
+// @Param roomid path string true "ルームID"
 // @Success 200 {object} string "success"
 // @Failure 404 {object} string "Chat room not found"
 // @Router /chat/messages/{roomid} [get]
@@ -161,8 +161,8 @@ func (c *ChatController) GetChatMessages(ctx *gin.Context) {
 // @Tags Direct Message
 // @Accept json
 // @Produce json
-// @Param senderId path string true "Sender ID"
-// @Param receiverId path string true "Receiver ID"
+// @Param senderId path string true "送信者ID"
+// @Param receiverId path string true "受信者ID"
 // @Param message formData string true "Message"
 // @Success 200 {object} string "Message sent successfully"
 // @Router /chat/dm/{senderId}/{receiverId} [post]
@@ -186,8 +186,8 @@ func (c *ChatController) SendDirectMessage(ctx *gin.Context) {
 // @Tags Direct Message
 // @Accept json
 // @Produce json
-// @Param senderId path string true "Sender ID"
-// @Param receiverId path string true "Receiver ID"
+// @Param senderId path string true "送信者ID"
+// @Param receiverId path string true "受信者ID"
 // @Success 200 {object} string "Messages fetched successfully"
 // @Router /chat/dm/{senderId}/{receiverId} [get]
 // @Security Bearer
@@ -207,8 +207,8 @@ func (c *ChatController) GetDirectMessages(ctx *gin.Context) {
 // @Tags Direct Message
 // @Accept json
 // @Produce json
-// @Param senderId path string true "Sender ID"
-// @Param receiverId path string true "Receiver ID"
+// @Param senderId path string true "送信者ID"
+// @Param receiverId path string true "受信者ID"
 // @Success 200 {object} string "Messages deleted successfully"
 // @Router /chat/dm/{senderId}/{receiverId} [delete]
 // @Security Bearer

controllers/class_controller.go

@@ -30,7 +30,7 @@ func NewCreateClassController(classService services.ClassService, uploader utils
 
 // GetClass godoc
 // @Summary クラスの情報を取得します
-// @Description 指定されたIDを持つクラスの情報を取得します。
+// @Description 指定されたIDを持つクラスの情報を取得
 // @Tags Class
 // @Accept  json
 // @Produce  json
@@ -62,7 +62,7 @@ func (cc *ClassController) GetClass(ctx *gin.Context) {
 }
 
 // CreateClass godoc
-// @Summary 新しいクラスを作成します
+// @Summary 新しいクラスを作成
 // @Description 名前、定員、説明、画像URL、作成者のUIDを持つ新しいクラスを作成します。画像はオプショナルです。
 // @Tags Class
 // @Accept multipart/form-data
@@ -131,7 +131,7 @@ func (c *ClassController) handleImageUpload(ctx *gin.Context) (string, error) {
 }
 
 // UpdateClass godoc
-// @Summary クラス情報を更新します
+// @Summary クラス情報を更新
 // @Description 指定されたIDを持つクラスの情報を更新します。
 // @Tags Class
 // @Accept multipart/form-data
@@ -181,7 +181,7 @@ func (cc *ClassController) UpdateClass(ctx *gin.Context) {
 }
 
 // DeleteClass godoc
-// @Summary クラスを削除します
+// @Summary クラスを削除
 // @Description 指定されたIDを持つクラスを削除します。
 // @Tags Class
 // @Accept json

controllers/class_user_controller.go

@@ -119,7 +119,7 @@ func (c *ClassUserController) GetUserClasses(ctx *gin.Context) {
 }
 
 // GetClassMembers godoc
-// @Summary クラスメンバーの情報を取得します
+// @Summary クラスメンバーの情報を取得
 // @Description 指定されたcidのクラスに所属しているメンバーの情報を取得します。
 // @Tags Class User
 // @Accept  json
@@ -250,14 +250,14 @@ func (c *ClassUserController) GetUserClassesByRole(ctx *gin.Context) {
 }
 
 // ChangeUserRole godoc
-// @Summary Change a user's role.
-// @Description Change the role of a user based on user ID and class ID.
+// @Summary ユーザーのロールを変更
+// @Description 指定されたユーザーIDとクラスIDに基づいて、ユーザーのロールを変更します。
 // @Tags Class User
 // @Accept json
 // @Produce json
-// @Param uid path int true "User ID"
-// @Param cid path int true "Class ID"
-// @Param roleName path string true "Role Name"
+// @Param uid path int true "ユーザーID"
+// @Param cid path int true "クラスID"
+// @Param roleName path string true "ロール名"
 // @Success 200 {string} string "Role updated successfully"
 // @Failure 400 {string} string "Invalid request"
 // @Failure 404 {string} string "User or class not found"
@@ -309,7 +309,7 @@ func isValidRoleName(roleName string) bool {
 }
 
 // UpdateUserName godoc
-// @Summary ユーザーの名前を更新します。
+// @Summary ユーザーの名前を更新
 // @Description 特定のユーザーIDとグループIDに対してユーザーの名前を更新します。
 // @Tags Class User
 // @ID update-user-name
@@ -350,7 +350,7 @@ func (c *ClassUserController) UpdateUserName(ctx *gin.Context) {
 }
 
 // ToggleFavorite godoc
-// @Summary お気に入りのクラスを切り替えます
+// @Summary お気に入りのクラスを切り替え
 // @Description ユーザーIDとクラスIDに基づいて、お気に入りのクラスを切り替えます。
 // @Tags Class User
 // @Accept json
@@ -385,7 +385,7 @@ func (c *ClassUserController) ToggleFavorite(ctx *gin.Context) {
 }
 
 // RemoveUserFromClass godoc
-// @Summary ユーザーをクラスから削除します。
+// @Summary ユーザーをクラスから削除
 // @Description 指定したユーザーIDとクラスIDに基づいて、ユーザーをクラスから削除します。
 // @Tags Class User
 // @Accept json
@@ -427,7 +427,7 @@ func (c *ClassUserController) RemoveUserFromClass(ctx *gin.Context) {
 }
 
 // SearchUserClassesByName godoc
-// @Summary クラス名でクラスを検索します
+// @Summary クラス名でクラスを検索
 // @Description 指定されたユーザーIDとクラス名に基づいて、クラスを検索します。
 // @Tags Class User
 // @Accept json

controllers/google_auth_controller.go

@@ -24,7 +24,7 @@ func NewGoogleAuthController(service services.GoogleAuthService, jwtService serv
 }
 
 // GoogleLoginHandler godoc
-// @Summary Googleのログインページへリダイレクトします。
+// @Summary Googleのログインページへリダイレクト
 // @Description ユーザーをGoogleのログインページへリダイレクトして認証を行います。
 // @Tags GoogleAuth
 // @ID google-login-handler
@@ -39,7 +39,7 @@ func (controller *GoogleAuthController) GoogleLoginHandler(c *gin.Context) {
 }
 
 // ProcessAuthCode godoc
-// @Summary 認可コードを処理します。
+// @Summary 認可コードを処理
 // @Description ユーザーがGoogleログイン後に受け取った認可コードを使って、ユーザー情報を照会し、トークンを生成します。
 // @Tags GoogleAuth
 // @Accept json