Docs : 동아리 목록 조회, 상세 조회, 소속 조회, 구독 조회 성공 메세지 변경 및 커서 페이징 삭제

[jiyun921]

📝 개요

작업 내용
성공 메세지를 실제 응답에 맞게 수정하였습니다.
동아리 목록 조회, 구독한 동아리 목록 조회에서 커서 기반 페이징 관련 필드를 제거했습니다.

변경된 API 명세서 경로(Proposal경로)
https://ku-ring.stoplight.io/proposals/ku-ring/branches/docs-club-api-response-update

🔍 주요 변경 사항

• 동아리 목록 조회 API, 동아리 상세 조회 API, 동아리 소속 조회 API, 동아리 구독 조회 API 성공 메시지 수정

• 동아리 목록 조회 응답에서 커서 기반 페이징 필드 제거
  -> cursor, hasNext, totalCount 제거

• 구독자 수 int64 형식으로 수정 (int->Long)

[rlagkswn00]

• 동아리 구독 조회/추가/삭제 간 bookmarks대신 subscriptions경로를 사용합니다
• 동아리 삭제 시 requestBody 대신 PathVariable을 사용합니다(DELETE /api/v2/users/subscriptions/clubs/{clubsId} 형식}

[jiyun921]

수정사항

1. 동아리 목록 조회 api

   1. iconImageUrl nullable로 수정
   2. summary는 not null 그대로 유지
      • 한줄소개가 없는 동아리들은 null 대신 “”로 응답 (db에도 “”로 들어가있음)

2. 동아리 상세 조회 api

   1. description nullable로 수정
   2. qualifications nullable로 수정
   3. recruitStartAt, recruitEndAt nullable로 수정
   4. applyUrl nullable로 수정
   5. location nullable로 수정 (위치 관련 정보가 하나도 없으면 location : null)
      1. building, room nullable로 수정

[rlagkswn00]

ku-ring/ku-ring-backend-web#363
위 내용으로 admin API 문서가 실제 백엔드 요청 스펙과 달라서 정리했습니다.

• /api/v2/admin/notices/dev는 기존 AdminNoticeRequest가 아니라 category, subject, noticeId, articleId 구조를 사용용합니다.
  https://ku-ring.stoplight.io/docs/ku-ring/branches/docs-club-api-response-update/3d7ffdc5739c6-dev

• /api/v2/admin/notices/prod는 title, body, url, adminPassword 구조를 사용하도록 문서를 분리했습니다.
  https://ku-ring.stoplight.io/docs/ku-ring/branches/docs-club-api-response-update/07e283b4d37eb-prod

• 또한 /api/v2/admin/academic/dev에 누락돼 있던 request body(title, body)도 추가했습니다.
  https://ku-ring.stoplight.io/docs/ku-ring/branches/docs-club-api-response-update/66ef4d6a46259-dev

+) 추가로 동아리 즐겨찾기 삭제 관련 api문서의 body값은 없습니다! 아마 변경 내역이 중첩되어 보여서 헷갈린 부분이 있는듯 한데 다음엥는 확실하게 전달 드리겠습니다(상단의 current 버튼을 누르면 최신화된 내용을 볼 수 있습니다!)