docs: 부수효과를 일으키는 쪽에도 적는다

[sevineleven]

Situation

DELETE /courses/{courseId} 는 연차를 함께 되돌린다. 그런데 그 사실이 차감 취소 API 설명에만 적혀 있었다.

DELETE /courses/{courseId}/leave-deduction
  ...
  코스 자체를 지우면(DELETE /courses/{courseId}) 차감도 함께 되돌아가므로 따로 부를 필요가 없다.   ← 여기에만

삭제 API 문서만 보면 그 부수효과를 모르고 지나간다. FE 는 실서버를 찔러 확인했다.

그리고 어제 머지된 #328 이 그 자리를 하나 더 벌렸다 — 차감 취소가 여행 결과 답변까지 지우게 됐는데 *Api 문서는 안 고쳤다. 내가 만든 공백이다.

Task

부수효과는 그것을 일으키는 쪽에 적는다. 반대편에만 있으면 읽는 사람은 자기가 부르는 API 문서를 다 읽고도 모른다.

Action

삭제 API — 두 가지를 적었다

• 이 코스로 깎은 연차가 함께 돌아온다. 취소 API 를 따로 부를 필요가 없고, 한 트랜잭션이라 "코스는 사라졌는데 연차는 깎인 채" 가 남지 않는다(그 상태는 코스가 없어 취소 API 로도 못 고친다)
• 여행 결과 답변도 함께 지워진다(fix: 차감을 취소하면 여행 결과 답변도 지운다 #328)

응답에 연차를 싣지 않는 이유도 적었다. 삭제 뒤 화면은 목록으로 돌아가므로 그 자리에서 다시 읽는다 — 차감 취소가 갱신된 연차를 돌려주는 것과 다른 점이라, 안 적으면 "왜 여기만 안 주지" 가 된다.

차감 취소 API — #328 이 바꾼 동작을 적었다

답변이 지워져 그 코스가 "아직 답하지 않은" 상태로 돌아간다는 것과, 그래서 모달이 다시 묻고 VISITED 로 복원하거나 NOT_VISITED 로 확정할 수 있다는 것.

trip-outcome 의 409 — 이제 영구적이지 않다

이미 답한 여행은 409 다

#328 이후 이 문장만 읽으면 틀린 그림이 된다. 차감을 취소하면 다시 답을 받는다는 것을 덧붙였다.

나머지는 손대지 않았다

이슈가 함께 요청한 "다른 상태 변경 엔드포인트도 같은 눈으로" 를 따라 23개를 전부 훑었다.

엔드포인트	판정
DELETE /users/me(탈퇴)	지우는 것·안 지우는 것·Apple 연결 해제까지 이미 상세하다
POST /auth/logout	refresh 토큰 폐기와 access 토큰이 만료까지 유효하다는 것이 적혀 있다
DELETE /devices	이 사람의 토큰을 전부 지운다는 것이 적혀 있다
PATCH /courses/{courseId}(날짜 수정)	차감량 재계산·0 이 되는 경우까지 적혀 있다
POST /courses/{id}/trip-outcome	차감이 여기서 일어난다는 것이 여러 번 적혀 있다(409 설명만 보강)

고칠 곳은 코스 삭제 하나뿐이었다. 나머지는 이미 양쪽이 맞다.

Result

DELETE /courses/{courseId} 문서만 보고도 연차가 돌아온다는 것과 답변이 지워진다는 것을 알 수 있다 — 이슈의 완료 기준이다.

문서만 바뀌었고 동작은 그대로다. 테스트를 더하지 않은 이유가 그것이다.

---

연관 이슈

• close [docs] itinerary — 삭제 API 쪽에서 차감 복구가 안 보인다 (반대편에만 적혀 있다) #173
• 관련 fix: 차감을 취소하면 여행 결과 답변도 지운다 #328 (차감 취소가 답변도 지운다) · [task] itinerary — 계획 관리: 연차↔코스 정합성 + 목록 강화 #113 (차감 취소) · [fix] itinerary — 차감을 "다녀오셨나요? 예" 하나로 모으고, 반차를 코스에서 읽는다 #288 (차감 입구 일원화)

[coderabbitai]

Warning

Review limit reached

Next included review available in 40 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e06484b3-dec7-450a-ae02-ef9f1a67f304

📥 Commits

Reviewing files that changed from the base of the PR and between c60b2ca and f16d732.

📒 Files selected for processing (1)

• src/main/java/com/offway/core/itinerary/controller/CourseStorageApi.java

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}