Skip to content

Commit

Permalink
✏️ typo: unify the convention in swagger (#480)
Browse files Browse the repository at this point in the history
  • Loading branch information
siyeonSon authored Jun 11, 2024
1 parent d281364 commit b353bbc
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class GeoController {

private final GeoService geoService;

@Operation(summary = "Reverse Geocoding")
@Operation(summary = "좌표 주소 변환")
@ApiResponse(responseCode = "200", description = "좌표 주소 변환 성공")
@ApiErrorResponse(errorCode = "GEO_NOT_SUPPORT_LOCATION", description = "유효하지 않은 좌표 입니다")
@GetMapping("/reverse-geocode")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
public class ItemClaimController {
private final ItemClaimService itemClaimService;

@Operation(summary = "아이템 신고하기")
@Operation(summary = "아이템 신고")
@ApiResponse(responseCode = "204", description = "신고 성공")
@ApiErrorResponses(value = {
@ApiErrorResponse(errorCode = "ITEM_NOT_FOUND", description = "아이템을 찾을 수 없습니다."),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public ResponseEntity<ItemResponseDto> create(
return ResponseDto.created(response);
}

@Operation(summary = "아이템 드랍 - 단건조회")
@Operation(summary = "아이템 드랍 - 단건 조회")
@GetMapping("/{itemId}")
@ApiErrorResponse(errorCode = "ITEM_NOT_FOUND", description = "아이템을 찾을 수 없습니다.")
public ResponseEntity<ItemDetailResponseDto> findOneItem(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
@RestController
@RequestMapping("/level")
@RequiredArgsConstructor
@Tag(name = "Level Controller", description = "Level API")
@Tag(name = "🪜Level", description = "Level API")
public class LevelController {

private final LevelService levelService;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
@RestController
@RequestMapping("/notifications")
@RequiredArgsConstructor
@Tag(name = "✉️Notification Controller", description = "Notification API")
@Tag(name = "✉️Notification", description = "Notification API")
public class NotificationController {

private final NotificationService notificationService;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
@RestController
@RequestMapping("/pop-up")
@RequiredArgsConstructor
@Tag(name = "Pop Up", description = "Pop Up API")
@Tag(name = "🫧Pop Up", description = "Pop Up API")
public class PopupController {
private final PopupService popupService;


@Operation(summary = "Get User Popup")
@Operation(summary = "사용자 팝업 조회")
@GetMapping
public ResponseEntity<PopupResponseDto> getUserPopup(
@ReqUser User user
Expand All @@ -29,7 +29,7 @@ public ResponseEntity<PopupResponseDto> getUserPopup(
return ResponseDto.ok(response);
}

@Operation(summary = "user Popup to Read")
@Operation(summary = "팝업 읽음")
@PostMapping("/read")
public ResponseEntity<Void> readUserPopup(
@ReqUser User user,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
@RestController
@RequestMapping("/search-term/recommend")
@RequiredArgsConstructor
@Tag(name = "SearchRecommend", description = "Search Recommend API")
@Tag(name = "💁Search Recommend", description = "Search Recommend API")
public class SearchRecommendController {
private final SearchRecommendService searchRecommendService;

@Operation(summary = "Recommend Search Term")
@Operation(summary = "검색어 추천")
@GetMapping
public ResponseEntity<SearchTermRecommendResponseDto> recommendSearchTerm() {
var response = searchRecommendService.recommendSearchTerm();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
public class UserBlockController {
private final UserBlockService userBlockService;

@Operation(summary = "사용자 차단하기")
@Operation(summary = "사용자 차단")
@ApiResponse(responseCode = "200", description = "차단 성공")
@ApiErrorResponses(value = {
@ApiErrorResponse(errorCode = "USER_NOT_FOUND", description = "차단하려는 사용자가 존재하지 않음"),
Expand All @@ -38,7 +38,7 @@ public ResponseEntity<BlockUserResponseDto> blockUser(
return ResponseDto.ok(response);
}

@Operation(summary = "사용자 차단 해제하기")
@Operation(summary = "사용자 차단 해제")
@ApiResponse(responseCode = "204", description = "차단 해제 성공")
@ApiErrorResponse(errorCode = "USER_NOT_FOUND", description = "차단 해제하려는 사용자가 존재하지 않음")
@DeleteMapping("/users/unblock")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public ResponseEntity<UserResponseDto> getUserInfo(
return ResponseDto.ok(response);
}

@Operation(summary = "닉네임 변경하기")
@Operation(summary = "닉네임 변경")
@ApiResponse(responseCode = "200", description = "닉네임 변경 성공")
@PatchMapping("/me/nickname")
public ResponseEntity<UserResponseDto> changeNickname(
Expand Down

0 comments on commit b353bbc

Please sign in to comment.