feat: success message 수정

tukcomCD2024 · Jun 30, 2024 · 86c8b0a · 86c8b0a
1 parent 7c4567d
commit 86c8b0a
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 19 deletions.
diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/bookmark/api/BookmarkApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/bookmark/api/BookmarkApi.java
@@ -21,7 +21,7 @@ public interface BookmarkApi {
     )
     @ApiResponse(
             responseCode = "200",
-            description = "OK"
+            description = "북마크 전체 조회를 성공했습니다."
     )
     SuccessResponse<List<NewsResponse>> getAllBookmarkedNews(
             Pageable pageable
@@ -35,7 +35,7 @@ SuccessResponse<List<NewsResponse>> getAllBookmarkedNews(
     )
     @ApiResponse(
             responseCode = "200",
-            description = "OK"
+            description = "뉴스가 북마크 여부 조회를 성공했습니다."
     )
     SuccessResponse<BookmarkResponse> getIsBookmarked(
             @Parameter(in = ParameterIn.PATH, description = "뉴스 ID", required = true)
@@ -51,7 +51,7 @@ SuccessResponse<BookmarkResponse> getIsBookmarked(
     )
     @ApiResponse(
             responseCode = "201",
-            description = "Created"
+            description = "북마크 저장에 성공했습니다."
     )
     SuccessResponse<String> saveBookmark(
             @Parameter(in = ParameterIn.PATH, description = "뉴스 ID", required = true)
@@ -66,7 +66,7 @@ SuccessResponse<String> saveBookmark(
     )
     @ApiResponse(
             responseCode = "204",
-            description = "No Content"
+            description = "북마크 삭제에 성공했습니다."
     )
     SuccessResponse<String> deleteBookmark(
             @Parameter(in = ParameterIn.PATH, description = "뉴스 ID", required = true)

diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateApi.java
@@ -29,7 +29,7 @@ public interface DebateApi {
     )
     @ApiResponse(
             responseCode = "201",
-            description = "Created"
+            description = "토론방 생성에 성공했습니다."
     )
     SuccessResponse<DebateRoomSaveResponse> saveDebateRoom(@RequestBody DebateRoomRequest request);
 
@@ -41,7 +41,7 @@ public interface DebateApi {
     )
     @ApiResponse(
             responseCode = "200",
-            description = "요청에 성공하였습니다."
+            description = "토론방 전체 조회에 성공했습니다"
     )
     SuccessResponse<List<DebateRoomResponse>> getDebateRooms(Pageable pageable);
 
@@ -53,7 +53,7 @@ public interface DebateApi {
     )
     @ApiResponse(
             responseCode = "204",
-            description = "토론방 삭제에 성공하였으며, 응답값은 없습니다."
+            description = "토론방 삭제에 성공했습니다."
     )
     SuccessResponse<String> deleteDebateRoom(@Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
                           Long roomId
@@ -67,7 +67,7 @@ SuccessResponse<String> deleteDebateRoom(@Parameter(in = ParameterIn.PATH, descr
     )
     @ApiResponse(
             responseCode = "201",
-            description = "Created"
+            description = "사용자가 보낸 토론 메세지 저장에 성공했습니다."
     )
     SuccessResponse<String> saveHumanDebateMessage(
             @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
@@ -84,7 +84,7 @@ SuccessResponse<String> saveHumanDebateMessage(
     )
     @ApiResponse(
             responseCode = "201",
-            description = "Created"
+            description = "AI가 보낸 토론 메세지 저장에 성공했습니다."
     )
     SuccessResponse<String> saveAIDebateMessage(
             @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
@@ -102,7 +102,7 @@ SuccessResponse<String> saveAIDebateMessage(
     @ApiResponses(value = {
             @ApiResponse(
                     responseCode = "204",
-                    description = "요청에 성공하였으며 응답값은 없습니다."
+                    description = "토론 종료에 성공했습니다."
             ),
             @ApiResponse(
                     responseCode = "404",
@@ -122,7 +122,7 @@ SuccessResponse<String> finishDebate(
     )
     @ApiResponse(
             responseCode = "200",
-            description = "요청에 성공하였습니다."
+            description = "토론 메세지 조회에 성공했습니다."
     )
     SuccessResponse<List<DebateMessageResponse>> getDebateMessages(
             @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
@@ -138,7 +138,7 @@ SuccessResponse<List<DebateMessageResponse>> getDebateMessages(
     @ApiResponses(value = {
             @ApiResponse(
                     responseCode = "201",
-                    description = "토론 요약이 성공하였습니다."
+                    description = "토론 요약에 성공했습니다."
             ),
             @ApiResponse(
                     responseCode = "404",
@@ -159,7 +159,7 @@ SuccessResponse<DebateSummaryResponse> summarizeDebate(
     @ApiResponses(value = {
             @ApiResponse(
                     responseCode = "200",
-                    description = "요청에 성공하였습니다."
+                    description = "토론 요약 조회에 성공했습니다."
             ),
             @ApiResponse(
                     responseCode = "404",

diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/member/api/MemberApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/member/api/MemberApi.java
@@ -15,7 +15,7 @@ public interface MemberApi {
     )
     @ApiResponse(
             responseCode = "200",
-            description = "OK"
+            description = "사용자 정보 조회에 성공했습니다."
     )
     SuccessResponse<MemberResponse> getMemberInfo();
 }
diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java
@@ -23,7 +23,7 @@ public interface NewsApi {
     )
     @ApiResponse(
             responseCode = "200",
-            description = "요청에 성공하였습니다."
+            description = "전체 뉴스 조회에 성공했습니다."
     )
     SuccessResponse<List<NewsResponse>> getNews(Pageable pageable);
 
@@ -36,7 +36,7 @@ public interface NewsApi {
     @ApiResponses(value = {
         @ApiResponse(
                 responseCode = "200",
-                description = "요청에 성공하였습니다."
+                description = "요약 뉴스 상세 조회에 성공했습니다."
         ),
         @ApiResponse(
                 responseCode = "404",

diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/readNews/api/ReadNewsApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/readNews/api/ReadNewsApi.java
@@ -17,7 +17,7 @@ public interface ReadNewsApi {
     )
     @ApiResponse(
             responseCode = "200",
-            description = "요청에 성공하였습니다."
+            description = "최근 읽은 뉴스 조회에 성공했습니다."
     )
     SuccessResponse<List<ReadNewsResponse>> getReadNews();
 }
diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/statistics/api/StatisticsApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/statistics/api/StatisticsApi.java
@@ -18,7 +18,7 @@ public interface StatisticsApi {
     )
     @ApiResponse(
             responseCode = "200",
-            description = "요청에 성공하였습니다."
+            description = "최근 일주일 날짜별 뉴스 조회수 조회에 성공했습니다."
     )
     SuccessResponse<List<DateViewStatisticsResponse>> getViewsOfDates();
 
@@ -30,7 +30,7 @@ public interface StatisticsApi {
     )
     @ApiResponse(
             responseCode = "200",
-            description = "요청에 성공하였습니다."
+            description = "카테고리별 조회수 조회에 성공했습니다."
     )
     SuccessResponse<List<CategoryStatisticsResponse>> getCategoryStatistics();
 }