Skip to content

Docs: 관리자 삭제 및 이미지 후보 선택 Swagger 명세 보완 - #148

Merged
ppp1969 merged 1 commit into
devfrom
codex/issue-147-admin-swagger-docs
Jul 14, 2026
Merged

ppp1969 merged 1 commit into
devfrom
codex/issue-147-admin-swagger-docs

Conversation

@ppp1969

@ppp1969 ppp1969 commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

🧑🏻‍💻 PR 작업 내역 요약

관리자 도서 삭제 API와 대표 후보 선택/fan-out API를 프론트엔드가 오해 없이 사용할 수 있도록 Swagger 명세를 보완했습니다.

Closes #147

📋 변경 사항

  • 관리자 도서 삭제 API의 삭제 범위와 처리 중 job 차단 조건을 설명했습니다.
  • 삭제 API의 200, 404(PROGRESS4001), 409(ADMIN4027) 응답을 Swagger에 명시했습니다.
  • 삭제 대상은 종속 DB 데이터이며 S3의 EPUB/이미지 객체는 삭제하지 않는다는 현재 계약을 명시했습니다.
  • 후보 선택 API의 candidateId는 referenceCandidates[].id에 담긴 asset DB ID임을 명시했습니다.
  • slotNo 1~4는 화면 표시용이며 candidateId로 사용할 수 없다는 설명을 API 파라미터와 응답 DTO에 추가했습니다.
  • Swagger 어노테이션 계약을 검증하는 AdminSwaggerDocumentationTest를 추가했습니다.

🔍 Code Review

  • API 경로, 요청/응답 구조, 서비스 동작은 변경하지 않은 문서 보완입니다.
  • 실제 구현은 candidateId로 CharacterImageAsset을 ID와 책 기준으로 조회하므로 asset DB ID 설명과 일치합니다.
  • 검증: ./gradlew.bat test --tests com.kw.readwith.controller.AdminSwaggerDocumentationTest --no-daemon
  • 검증: ./gradlew.bat test --no-daemon

📸 ScreenShot

Swagger 어노테이션 명세 보완으로 별도 화면 캡처는 없습니다.

@ppp1969
ppp1969 marked this pull request as ready for review July 14, 2026 17:15
@ppp1969
ppp1969 merged commit d0ac15e into dev Jul 14, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: 관리자 삭제 및 이미지 후보 선택 Swagger 명세 보완

1 participant