Skip to content

Commit

Permalink
docs: Javadoc 버전 수정
Browse files Browse the repository at this point in the history
  • Loading branch information
GIVEN53 committed Nov 12, 2023
1 parent 8dd3ccb commit 4385902
Show file tree
Hide file tree
Showing 13 changed files with 81 additions and 81 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ public class LoginController {
* @param params 카카오 accessToken
* @return ResponseEntity 로그인을 성공하면, JWT TOKEN과 사용자 정보(nickname, auth id)를 전달한다.
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PostMapping("/kakao")
public ResponseEntity<SuccessSingleResponse<LoginResponse>> loginKakao(@Valid @RequestBody KakaoLoginRequest params) {
LoginResponse loginResponse = oauthLoginService.login(params);
Expand All @@ -54,7 +54,7 @@ public ResponseEntity<SuccessSingleResponse<LoginResponse>> loginKakao(@Valid @R
*
* @param params 카카오 access token
* @return jwt token, 로그인 정보
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PostMapping("/kakao")
Expand All @@ -70,9 +70,9 @@ public ResponseEntity<SuccessSingleResponse<LoginResponse>> loginKakaoV1(@Valid
* @param params 네이버 accessToken
* @return ResponseEntity 로그인을 성공하면, JWT TOKEN과 사용자 정보(nickname, auth id)를 전달한다.
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PostMapping("/naver")
public ResponseEntity<SuccessSingleResponse<LoginResponse>> loginNaver(@Valid @RequestBody NaverLoginRequest params) {
LoginResponse loginResponse = oauthLoginService.login(params);
Expand All @@ -87,7 +87,7 @@ public ResponseEntity<SuccessSingleResponse<LoginResponse>> loginNaver(@Valid @R
*
* @param params 네이버 access token
* @return jwt token, 로그인 정보
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PostMapping("/naver")
Expand All @@ -105,9 +105,9 @@ public ResponseEntity<SuccessSingleResponse<LoginResponse>> loginNaverV1(@Valid
* @param request 재발급 요청 , header에 accessToken이 필요
* @return AuthToken
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PostMapping("/reissue")
public ResponseEntity<SuccessSingleResponse<?>> reissue(HttpServletRequest request) {
String newAccessToken = oauthLoginService.reissueToken(request.getHeader(AUTHORIZATION));
Expand All @@ -121,7 +121,7 @@ public ResponseEntity<SuccessSingleResponse<?>> reissue(HttpServletRequest reque
*
* @param request 재발급 요청, header에 access token 필요
* @return AuthToken
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PostMapping("/reissue")
Expand All @@ -138,9 +138,9 @@ public ResponseEntity<SuccessSingleResponse<?>> reissueV1(HttpServletRequest req
* @param request HttpServletRequest oauthId
* @param logoutFcmTokenRequest fcmToken
* @since 1.1.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PostMapping("/logout")
public ResponseEntity<SuccessSingleResponse> logout(HttpServletRequest request, @RequestBody LogoutFcmTokenRequest logoutFcmTokenRequest) {
oauthLoginService.logout(request.getHeader(AUTHORIZATION), logoutFcmTokenRequest.fcmToken());
Expand All @@ -153,7 +153,7 @@ public ResponseEntity<SuccessSingleResponse> logout(HttpServletRequest request,
*
* @param request HttpServletRequest
* @param logoutFcmTokenRequest fcm token 정보
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PostMapping("/logout")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ public class BloodSugarGuideController {
* @param principal 사용자 정보
* @return 혈당 가이드 응답 dto
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@GetMapping
public ResponseEntity<SuccessSingleResponse<BloodSugarGuideResponse>> get(@ValidLocalDate @RequestParam String date,
@AuthenticationPrincipal User principal) {
Expand All @@ -54,7 +54,7 @@ public ResponseEntity<SuccessSingleResponse<BloodSugarGuideResponse>> get(@Valid
* @param date 조회할 일자
* @param principal 사용자 정보
* @return 혈당 가이드 응답 dto
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@GetMapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ public class GuideController {
* @param date 조회날짜
* @author EVE
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@GetMapping
public ResponseEntity<SuccessSingleResponse<DayGuideResponse>> getDayGuide(@ValidLocalDate @RequestParam String date,
@AuthenticationPrincipal User principal) {
Expand All @@ -52,7 +52,7 @@ public ResponseEntity<SuccessSingleResponse<DayGuideResponse>> getDayGuide(@Vali
*
* @param date 조회날짜
* @author EVE
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@GetMapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ public class ExerciseGuideController {
* @param principal 유저 정보
* @return 운동 가이드 응답
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@GetMapping
public ResponseEntity<SuccessSingleResponse<ExerciseGuideResponse>> get(@ValidLocalDate @RequestParam String date,
@AuthenticationPrincipal User principal) {
Expand All @@ -56,7 +56,7 @@ public ResponseEntity<SuccessSingleResponse<ExerciseGuideResponse>> get(@ValidLo
* @param date 조회하는 날짜
* @param principal 유저 정보
* @return 운동 가이드 응답
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@GetMapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ public class WeightGuideController {
* @param principal 유저 정보
* @author EVE
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@GetMapping
public ResponseEntity<SuccessSingleResponse<WeightGuideResponse>> get(@ValidLocalDate @RequestParam String date,
@AuthenticationPrincipal User principal) {
Expand All @@ -55,7 +55,7 @@ public ResponseEntity<SuccessSingleResponse<WeightGuideResponse>> get(@ValidLoca
* @param date 조회하는 날짜
* @param principal 유저 정보
* @author EVE
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@GetMapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ public class HealthConnectController {
* @param requests 건강 지표 request post dto n개
* @param principal 유저 정보
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PostMapping
public ResponseEntity<SuccessSingleResponse<?>> postHealthConnect(@Valid @RequestBody HealthConnectPostRequest requests,
@AuthenticationPrincipal User principal) {
Expand All @@ -53,7 +53,7 @@ public ResponseEntity<SuccessSingleResponse<?>> postHealthConnect(@Valid @Reques
*
* @param requests 건강 지표 request post dto n개
* @param principal 유저 정보
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PostMapping
Expand All @@ -71,9 +71,9 @@ public ResponseEntity<SuccessSingleResponse<?>> postHealthConnectV1(@Valid @Requ
* @param requests health connect 연동 여부 데이터
* @param principal 유저 정보
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PatchMapping("/interlock")
public ResponseEntity<SuccessSingleResponse<?>> interlockHealthConnect(@Valid @RequestBody HealthConnectRegisterRequest requests,
@AuthenticationPrincipal User principal) {
Expand All @@ -87,7 +87,7 @@ public ResponseEntity<SuccessSingleResponse<?>> interlockHealthConnect(@Valid @R
*
* @param requests health connect 연동 여부 데이터
* @param principal 유저 정보
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PatchMapping("/interlock")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ public class HealthMetricController {
* HTTP POST METHOD
*
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PostMapping
public ResponseEntity<SuccessSingleResponse<HealthMetricResponse>> post(@Valid @RequestBody HealthMetricPostRequest postRequest,
@AuthenticationPrincipal User principal) {
Expand All @@ -65,7 +65,7 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricResponse>> post(@Valid @
/**
* HTTP POST METHOD // TODO 작성
*
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PostMapping
Expand All @@ -80,9 +80,9 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricResponse>> postHealthMet
* HTTP PATCH METHOD
*
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PatchMapping
public ResponseEntity<SuccessSingleResponse<HealthMetricResponse>> patch(@Valid @RequestBody HealthMetricPatchRequest patchRequest,
@AuthenticationPrincipal User principal) {
Expand All @@ -96,7 +96,7 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricResponse>> patch(@Valid
/*
* HTTP PATCH METHOD // TODO 작성
*
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PatchMapping
Expand All @@ -118,9 +118,9 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricResponse>> patchHealthMe
* @param principal 유저 정보
* @return 건강지표 차트 데이터
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@GetMapping
public ResponseEntity<SuccessSingleResponse<HealthMetricChartResponse>> getHealthMetrics(@ValidLocalDate @RequestParam String startDate,
@ValidLocalDate @RequestParam String endDate, @AuthenticationPrincipal User principal) {
Expand All @@ -136,7 +136,7 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricChartResponse>> getHealt
* @param endDate 조회 종료 날짜
* @param principal 유저 정보
* @return 건강지표 차트 데이터
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@GetMapping
Expand All @@ -154,9 +154,9 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricChartResponse>> getHealt
* @param principal 유저 정보
* @return 유저의 마지막 건강지표 생성일
* @since 1.1.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@GetMapping("/last-date")
public ResponseEntity<SuccessSingleResponse<HealthMetricLastDateResponse>> getHealthMetricLastDate(@AuthenticationPrincipal User principal) {
String oauthId = principal.getUsername();
Expand All @@ -169,7 +169,7 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricLastDateResponse>> getHe
*
* @param principal 유저 정보
* @return 유저의 마지막 건강지표 생성일
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@GetMapping("/last-date")
Expand All @@ -188,9 +188,9 @@ public ResponseEntity<SuccessSingleResponse<HealthMetricLastDateResponse>> getLa
* @param principal 유저 정보
* @return 성공 메시지
* @since 1.3.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@DeleteMapping
public ResponseEntity<SuccessSingleResponse<?>> deleteHealthMetric(@ValidLocalDate @RequestParam String date, @NotBlank @RequestParam String type,
@AuthenticationPrincipal User principal) {
Expand All @@ -205,7 +205,7 @@ public ResponseEntity<SuccessSingleResponse<?>> deleteHealthMetric(@ValidLocalDa
* @param type 건강지표 타입
* @param principal 유저 정보
* @return 성공 메시지
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@DeleteMapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ public class AppLogController {
* 앱 로그를 post 요청한다.
*
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PostMapping
public ResponseEntity<SuccessSingleResponse<?>> post(@Valid @RequestBody LogRequest request) {
logService.sendLog(request);
Expand All @@ -44,7 +44,7 @@ public ResponseEntity<SuccessSingleResponse<?>> post(@Valid @RequestBody LogRequ
* 앱 로그를 post 요청한다.
*
* @param request 로그 요청
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PostMapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ public class NotificationController {
* @param user 사용자
* @return notificationList 확인 안된 알림 목록
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@GetMapping
public ResponseEntity<SuccessSingleResponse<NotificationListResponse>> get(@AuthenticationPrincipal User user) {
NotificationListResponse response = new NotificationListResponse(notificationService.getNotificationList(user.getUsername()));
Expand All @@ -51,7 +51,7 @@ public ResponseEntity<SuccessSingleResponse<NotificationListResponse>> get(@Auth
*
* @param user 사용자 정보
* @return notificationList 확인하지 않은 알림 목록
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@GetMapping
Expand All @@ -69,9 +69,9 @@ public ResponseEntity<SuccessSingleResponse<NotificationListResponse>> getUnread
*
* @param notificationIdList 알림Id 목록
* @since 1.0.0
* @deprecated 1.4.0
* @deprecated 1.6.0
*/
@Deprecated(since = "1.4.0")
@Deprecated(since = "1.6.0")
@PatchMapping
public ResponseEntity<SuccessSingleResponse<?>> patch(@Valid @RequestBody CheckNotificationIdRequest notificationIdList) {
notificationService.updateNotificationIsRead(notificationIdList);
Expand All @@ -84,7 +84,7 @@ public ResponseEntity<SuccessSingleResponse<?>> patch(@Valid @RequestBody CheckN
* 클라이언트에서 사용자가 확인한 알림 id 목록을 서버로 전달하고 서버에서 알림 확인 여부를 변경한다.
*
* @param notificationIds 푸쉬 알림 id 목록
* @since 1.4.0
* @since 1.6.0
*/
@ApiVersion("1")
@PatchMapping
Expand Down
Loading

0 comments on commit 4385902

Please sign in to comment.