Skip to content

Commit 73842a3

Browse files
committed
📝 docs: Swagger Convention에 맞게 설명 변경
1 parent 4baf150 commit 73842a3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/main/java/org/withtime/be/withtimebe/domain/member/controller/AlarmController.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,38 +23,38 @@ public class AlarmController {
2323
private final AlarmCommandService alarmCommandService;
2424
private final AlarmQueryService alarmQueryService;
2525

26-
@Operation(summary = "알림 테스트용 API", description = "알림 테스트하기 위해 생성한 API")
26+
@Operation(summary = "알림 테스트용 API by 요시", description = "알림 테스트하기 위해 생성한 API")
2727
@ApiResponse(responseCode = "204", description = "알림 전송 성공, 해당 API는 일림 전송 실패로 따로 에러 메시지를 전송하지 않습니다.")
2828
@PostMapping
2929
public DefaultResponse<Void> alarm(@AuthenticatedMember Member member, @RequestBody AlarmRequestDTO.SendAlarm request) {
3030
alarmCommandService.send(member, request);
3131
return DefaultResponse.noContent();
3232
}
3333

34-
@Operation(summary = "푸시알림 기기 업데이트 API", description = "푸시 알림 받을 기기에서 얻은 토큰을 적용하여 해당 기기로 받도록 하는 API")
34+
@Operation(summary = "푸시알림 기기 업데이트 API by 요시", description = "푸시 알림 받을 기기에서 얻은 토큰을 적용하여 해당 기기로 받도록 하는 API")
3535
@ApiResponse(responseCode = "204", description = "알림 받을 기기 변경에 성공했습니다.")
3636
@PostMapping("/device-tokens")
3737
public DefaultResponse<Void> updateDeviceToken(@AuthenticatedMember Member member, @RequestBody AlarmRequestDTO.UpdateDeviceToken request) {
3838
alarmCommandService.updateDeviceToken(member, request);
3939
return DefaultResponse.noContent();
4040
}
4141

42-
@Operation(summary = "알림 설정 업데이트 API", description = "사용자의 알림 설정을 변경하는 API")
42+
@Operation(summary = "알림 설정 업데이트 API by 요시", description = "사용자의 알림 설정을 변경하는 API")
4343
@ApiResponse(responseCode = "200", description = "알림 설정 변경에 성공하였습니다.")
4444
@PatchMapping("/settings")
4545
public DefaultResponse<AlarmResponseDTO.UpdateSetting> updateAlarmSetting(@AuthenticatedMember Member member, @RequestBody AlarmRequestDTO.UpdateSetting request) {
4646
AlarmResponseDTO.UpdateSetting response = alarmCommandService.updateAlarmSetting(member, request);
4747
return DefaultResponse.ok(response);
4848
}
4949

50-
@Operation(summary = "알림 설정 조회 API", description = "사용자 알림 설정 상태를 조회합니다.")
50+
@Operation(summary = "알림 설정 조회 API by 요시", description = "사용자 알림 설정 상태를 조회합니다.")
5151
@ApiResponse(responseCode = "200", description = "알림 설정 조회에 성공하였습니다.")
5252
@GetMapping("/settings")
5353
public DefaultResponse<AlarmResponseDTO.SettingInfo> findSettingInfo(@AuthenticatedMember Member member) {
5454
return DefaultResponse.ok(AlarmConverter.toSettingInfo(member));
5555
}
5656

57-
@Operation(summary = "알림 조회 API", description = "알림 조회 API")
57+
@Operation(summary = "알림 조회 API by 요시", description = "알림 조회 API")
5858
@ApiResponse(responseCode = "200", description = "알림 조회에 성공했습니다.")
5959
@GetMapping
6060
public DefaultResponse<AlarmResponseDTO.FindAlarmList> findAlarms(@RequestParam(defaultValue = "10") Integer size,

0 commit comments

Comments
 (0)