Skip to content

#555 [Docs] 클래스 API 명세서 - #556

Merged
si-zero merged 2 commits into
devfrom
docs/#555
Oct 21, 2026
Merged

si-zero merged 2 commits into
devfrom
docs/#555

Conversation

@si-zero

@si-zero si-zero commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

#️⃣ 연관된 이슈

📝 작업 내용

📚 Docs

내용 파일
공통: 응답 형식, enum 값, 클래스 읽기·쓰기·결과 열람 권한 규칙, 화면별 API 호출 흐름 docs/api-specs/class-api.md
이용권: 코드 확인·등록·내 이용권 조회 docs/api-specs/class-api.md
클래스: 생성(battleId / topicVersionId)·목록·상세·수정(이름·마감일 연장)·삭제 docs/api-specs/class-api.md
Picke 배틀 추천: 쿼리 조건, 후보·정렬 규칙, 최대 3개 반환 docs/api-specs/class-api.md
커스텀 배틀 주제: 초안 생성·조회·AI 제안·후보 선택·직접 수정 검증, suggestStatus 별 화면 처리, issues 필드·코드 docs/api-specs/class-api.md
참여·멤버: 참여 코드 확인(판정 순서), 참여, 명단, 이름 변경, 나가기·내보내기와 좌석 규칙 docs/api-specs/class-api.md
클래스 배틀 진행: 상세(canParticipate, participationCompleted), 사전·사후투표, TTS 완료, 투표 통계, 의견, 일반 댓글·좋아요 API 의 클래스 권한 docs/api-specs/class-api.md
AI 철학자 토론: 조회·시작·반박·재시도, status·canReply·canRetry, requestKey 중복 전송 처리 docs/api-specs/class-api.md
결과·리포트: 정량 통계(LIVE / SNAPSHOT), 내 AI 피드백, 운영자 인사이트·재시도, 리포트 상태값 docs/api-specs/class-api.md
어드민: 배틀 클래스 설정, 펀딩 CSV 가져오기, 이용권 발급·전달 기록·재발급·환불, 주문 목록·현황 docs/api-specs/class-api.md
에러 코드 모음 (클래스, 이용권·펀딩, 클래스에서 함께 쓰는 공통 코드) docs/api-specs/class-api.md

📌 공유 사항

  1. 필드 이름·에러 코드·제한값은 컨트롤러 설명이 아니라 서비스 코드 기준으로 맞췄습니다. 예를 들어 사후투표를 사전투표 없이 호출하면 Swagger 설명의 400 PRE_VOTE_REQUIRED 가 아니라 404 VOTE_404 가 나옵니다.
  2. 클래스 의견의 좋아요 API 는 클래스 권한 검사가 없다는 점을 문서에 표시했습니다. 의견 목록의 작성자 이름도 클래스 표시 이름이 아닌 전체 닉네임이 내려갑니다.
  3. 응답 예시의 값은 설명용입니다.
  4. 문서만 추가해서 코드 변경은 없습니다.

✅ 체크리스트

  • Assignees에 본인을 선택했나요?
  • 컨벤션에 맞는 Type을 선택했나요?
  • Development에 이슈를 연동했나요?
  • Merge 하려는 브랜치가 올바르게 설정되어 있나요?
  • 컨벤션을 지키고 있나요?

@si-zero si-zero added the 📚 Docs (문서 수정) 문서를 수정할 때 사용합니다. label Oct 21, 2026
@si-zero si-zero self-assigned this Oct 21, 2026
@si-zero si-zero changed the title #555 [Docs] 클래스 커스텀 배틀·추천·참여 코드 확인 API 명세서 #555 [Docs] 클래스 API 명세서 Oct 21, 2026
@si-zero si-zero linked an issue Oct 21, 2026 that may be closed by this pull request
11 tasks
@si-zero
si-zero merged commit da247e3 into dev Oct 21, 2026
1 check passed
@si-zero
si-zero deleted the docs/#555 branch October 21, 2026 11:51
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.

📚 Docs: 클래스 API 명세서

1 participant