📝 Docs : API docs 수정

<footer> - 관련: #294
Namo-log · Sep 18, 2024 · ed4cf69 · ed4cf69
1 parent 2e114dd
commit ed4cf69
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 9 deletions.
diff --git a/...i-v2/src/main/java/com/namo/spring/application/external/api/record/dto/DiaryResponse.java b/...i-v2/src/main/java/com/namo/spring/application/external/api/record/dto/DiaryResponse.java
@@ -51,7 +51,7 @@ public static class DiaryArchiveDto {
         @Schema(description = "스케줄 제목", example = "저녁 약속")
         private String title;
         private DiarySummaryDto diarySummary;
-        @Schema(description = "개인 스케줄 : 0, 모임 스케줄 : 1", example = "0")
+        @Schema(description = "개인 일정 : 0, 모임 일정 : 1, 생일 일정 : 2", example = "0")
         private int scheduleType;
         private ParticipantInfo participantInfo;
     }
@@ -95,7 +95,7 @@ public static class DiaryExistDateDto {
     @AllArgsConstructor
     @Schema(description = "일별 일기에 대한 스케줄 DTO")
     public static class DayOfDiaryDto {
-        @Schema(description = "개인 스케줄 : 0, 모임 스케줄 : 1", example = "0")
+        @Schema(description = "개인 일정 : 0, 모임 일정 : 1, 생일 일정 : 2", example = "0")
         private int scheduleType;
         private CategoryInfoDto categoryInfo;
         private LocalDateTime scheduleStartDate;

diff --git a/.../main/java/com/namo/spring/application/external/api/schedule/api/PersonalScheduleApi.java b/.../main/java/com/namo/spring/application/external/api/schedule/api/PersonalScheduleApi.java
@@ -43,6 +43,12 @@ ResponseDto<List<PersonalScheduleResponse.GetMonthlyScheduleDto>> getMyMonthlySc
             @Parameter(description = "월") @RequestParam Integer month,
             @AuthenticationPrincipal SecurityUserDetails member);
 
+    @Operation(summary = "개인 월간 일정 - 친구 생일 조회", description = "월간 친구 생일을 조회합니다.")
+    ResponseDto<List<PersonalScheduleResponse.GetMonthlyFriendBirthdayDto>> getMonthlyFriendsBirthday(
+            @Parameter(description = "연도") @RequestParam Integer year,
+            @Parameter(description = "월") @RequestParam Integer month,
+            @AuthenticationPrincipal SecurityUserDetails member);
+
     @Operation(summary = "친구 월간 일정 조회", description = "친구의 월간 일정을 조회합니다.")
     @ApiErrorCodes(value = {ErrorStatus.NOT_FRIENDSHIP_MEMBER})
     ResponseDto<List<PersonalScheduleResponse.GetFriendMonthlyScheduleDto>> getFriendMonthlySchedules(

diff --git a/.../namo/spring/application/external/api/schedule/controller/PersonalScheduleController.java b/.../namo/spring/application/external/api/schedule/controller/PersonalScheduleController.java
@@ -58,7 +58,7 @@ public ResponseDto<List<PersonalScheduleResponse.GetMonthlyScheduleDto>> getMyMo
     }
 
     /**
-     * 내 월간 캘린더 조회 시
+     * 내 월간 캘린더 -
      * 친구의 생일 목록 조회 API
      */
     @GetMapping("/calendar/friends/birthdays")

diff --git a/...n/java/com/namo/spring/application/external/api/schedule/dto/MeetingScheduleResponse.java b/...n/java/com/namo/spring/application/external/api/schedule/dto/MeetingScheduleResponse.java
@@ -86,7 +86,7 @@ public static class GetMonthlyMembersScheduleDto {
         private Long interval;
         @Schema(description = "일정 참여자 목록")
         private List<MemberParticipantDto> participants;
-        @Schema(description = "개인 스케줄 : 0, 모임 스케줄 : 1, 생일 스케줄 : 3", example = "0")
+        @Schema(description = "개인 스케줄 : 0, 모임 스케줄 : 1, 생일 스케줄 : 2", example = "0")
         private int scheduleType;
     }
 
@@ -109,7 +109,7 @@ public static class GetMonthlyMeetingParticipantScheduleDto {
         private List<UserParticipantDto> participants;
         @Schema(description = "현재 조회하는 모임 일정인지의 여부")
         private Boolean isCurMeetingSchedule = false;
-        @Schema(description = "개인 스케줄 : 0, 모임 스케줄 : 1, 생일 스케줄 : 3", example = "0")
+        @Schema(description = "개인 일정 : 0, 모임 일정 : 1, 생일 일정 : 2", example = "0")
         private int scheduleType;
     }
 

diff --git a/.../java/com/namo/spring/application/external/api/schedule/dto/PersonalScheduleResponse.java b/.../java/com/namo/spring/application/external/api/schedule/dto/PersonalScheduleResponse.java
@@ -34,7 +34,7 @@ public static class GetMonthlyScheduleDto {
         private LocationDto locationInfo;
         @Schema(description = "기록 작성 여부")
         private Boolean hasDiary;
-        @Schema(description = "개인 일정 : 0, 모임 일정 : 1, 생일 일정: 3", example = "0")
+        @Schema(description = "개인 일정 : 0, 모임 일정 : 1, 생일 일정: 2", example = "0")
         private int scheduleType;
         @Schema(description = "모임 일정 정보, 모임 일정이 아닐 시에는 null")
         private MeetingInfoDto meetingInfo;
@@ -97,11 +97,11 @@ public static class NotificationDto {
     @Builder
     @Schema(title = "친구 일정 월간 조회 응답 DTO")
     public static class GetMonthlyFriendBirthdayDto {
-        @Schema(description = "친구 이름", example = "나모 정기 회의")
+        @Schema(description = "친구 이름", example = "나몽")
         private String nickname;
         @Schema(description = "생일 카테고리 정보")
         private CategoryDto categoryInfo;
-        @Schema(description = "친구의 생일, unix 타임스탬프 형식")
+        @Schema(description = "친구의 생일(현재 년도 기준), unix 타임스탬프 형식")
         private Long birthdayDate;
     }
 
@@ -122,7 +122,7 @@ public static class GetFriendMonthlyScheduleDto {
         private Long endDate;
         @Schema(description = "시작일과 종료일 차이")
         private Long interval;
-        @Schema(description = "개인 일정 : 0, 모임 일정 : 1, 친구의 생일 일정 : 3", example = "0")
+        @Schema(description = "개인 일정 : 0, 모임 일정 : 1, 친구의 생일 일정 : 2", example = "0")
         private int scheduleType;
     }