Skip to content

클론 제거 뒤 낡은 토너먼트·위시 API 문서 정리 - #1244

Merged
m-a-king merged 1 commit into
devfrom
docs/1243-clone-api-doc-drift
Oct 20, 2026
Merged

m-a-king merged 1 commit into
devfrom
docs/1243-clone-api-doc-drift

Conversation

@m-a-king

Copy link
Copy Markdown
Collaborator

한눈에

토너먼트·위시 API 문서를 지금 서버 동작에 맞춤

  • 이전: 클론 토너먼트를 없앤 뒤에도 API 문서가 옛 동작을 설명함
    • 예시: 사라진 에러 코드, 이제 나지 않는 권한 오류
  • API 문서의 설명과 응답 예시를 서버가 실제로 내는 값으로 고침
  • 서버 동작은 그대로
  • 머지 뒤 바뀌는 것은 API 문서 화면뿐

Situation

이슈

  • 클론 제거 뒤 낡은 토너먼트·위시 API 문서 정리 #1243
  • 추가: dev 에 클론 정리 4-1단계(토너먼트 CLONE 잔재 정리 (4-1단계) #1191)가 먼저 들어와 있었음
    • 결과: 넘겨받은 점검 목록 36건 중 18건만 dev 에 남음
  • 추가: 같은 종류의 어긋남 4건을 새로 찾음
    • 코드 미리보기의 주최자 완주 갈래 누락
    • 토너먼트 presign 예시 누락
    • 코드 입장 표의 미완주 409 행 누락
    • 목록 설명의 완료 기준
  • 추가: 리뷰 중 고치지 않은 줄 2곳도 코드와 다름
    • 플레이 링크 인원 제한 없음 서술
    • 주최자가 나가 무효화된 링크를 404 로 안내

Task

이슈

Action

동작 서술 정정

영역 이전 이후
한도 초과 429 code WISH-010·TOURNAMENT-037 ITEM-006
후보 API 403(032·038) 복제 토너먼트 옛 클론 id 로 요청한 경우만
플레이 링크·코드 입장·목록의 완료 기준 토너먼트 COMPLETED 주최자 본인 플레이 완주
시작 PENDING 전환만 서술. 403 에 소유자 아님 주최자·멤버 두 경로. 403 은 비참여자만
삭제 소유자 목록에서만 제거 주최자 진행 상태별 세 갈래
코드 미리보기 PENDING 갈래만 완주 갈래와 404(026)·409(027) 추가
결승 기록 토너먼트가 COMPLETED 내 참여가 COMPLETED
플레이 링크 인원 제한 없음 초대·코드와 같은 정원
주최자가 나간 링크 404 409(027)
  • 완료 기준은 토너먼트 상태가 아니라 주최자 참여 행으로 판정함
    • 원인: 주최자 완주 뒤에도 토너먼트 상태는 IN_PROGRESS 일 수 있음

선언·예시 보강

  • 위시 수정 400 에 PRODUCTIMAGE-002 추가
  • 위시·토너먼트 presign 에 content-type 미지정 예시 추가
  • 초대 미리보기에 PENDING 아님 예시 추가
  • 후보 수정의 400 중복 선언을 하나로 합침
    • 원인: 같은 응답 코드 선언이 둘이면 앞쪽 설명이 가려질 수 있음 (렌더 확인은 안 함)
  • READY 후보 예시의 빈 이미지 채움
    • 원인: READY 는 이미지가 있어야 해 나올 수 없는 응답 모양
  • presigned URL 만료 숫자 제거
    • 원인: 설정 기본값을 복제한 숫자라 설정이 바뀌면 조용히 낡음

Result

검증

  • 리뷰어가 항목마다 dev 의 예외 발생 지점을 다시 추적해 판정함
    • 이미 해소된 항목은 손대지 않음

후속


연관 이슈

- 한도 초과 429 code 를 WISH-010·TOURNAMENT-037 에서 ITEM-006 으로 고침
- 토너먼트 후보 API 403(032·038) 사유를 옛 클론 id 로 요청한 경우로 한정
  - 복제 토너먼트에는 추가 불가 문장 삭제
- 플레이 링크·코드 입장·목록의 완료 기준을 주최자 본인 플레이 완주로 고침
  - 이전: 토너먼트 COMPLETED 상태. 주최자 완주 뒤에도 토너먼트 상태는 IN_PROGRESS 일 수 있음
  - 코드 입장 표에 시작했지만 주최자 미완주 409 행 추가
- 플레이 링크 서술 정정
  - 이전: 링크로 들어오는 인원 제한 없음. 실제로는 초대·코드와 같은 정원
  - 이전: 주최자가 나가 무효화된 링크는 404. 실제로는 409(027)
- 시작 설명을 주최자·멤버 두 경로로 나눔. 403 에서 소유자 아님 삭제
- 결승 기록 설명을 내 참여가 COMPLETED 로 고침
- 삭제 설명을 주최자 참여 행 상태 세 갈래로 고침
- 코드 미리보기에 완주한 토너먼트 갈래 추가
  - 404 TOURNAMENT-026 선언. 409 설명과 example 보강
- 빠진 선언·example 보강
  - 위시 PATCH 400 에 PRODUCTIMAGE-002
  - 위시·토너먼트 presign 에 content-type 미지정 example
  - 초대 미리보기에 PENDING 아님 example
- 후보 수정 400 중복 선언을 하나로 합침
- READY 후보 example 의 빈 imageUrl 채움. 썸네일 주석을 READY 이미지로 고침
- presigned URL 만료 숫자 제거
  - 원인: S3Properties 기본값 복제라 설정이 바뀌면 조용히 낡음
- 범위: PLAY_LINK_ALREADY_CREATED(025)는 결번 의도 주석과 함께 남겨 둔 것이라 유지
@m-a-king m-a-king linked an issue Oct 20, 2026 that may be closed by this pull request
@m-a-king m-a-king added the docs 문서만 만지는 작업 label Oct 20, 2026
@m-a-king m-a-king self-assigned this Oct 20, 2026
@coderabbitai

coderabbitai Bot commented Oct 20, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Repository: TeamPiKi/core/.coderabbit.yml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 22456e0a-f842-4420-9d39-28ba253aa06f
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

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

@github-actions

Copy link
Copy Markdown

Discord 스레드 연동용 메타데이터입니다. discord-pr-bot 워크플로가 자동 생성하며, 수정·삭제하면 PR 과 Discord 알림 연동이 끊깁니다.

@m-a-king
m-a-king merged commit 973e534 into dev Oct 20, 2026
7 checks passed
@m-a-king
m-a-king deleted the docs/1243-clone-api-doc-drift branch October 20, 2026 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서만 만지는 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

클론 제거 뒤 낡은 토너먼트·위시 API 문서 정리

1 participant