docs: API 문서 업데이트

- GET /schedules에 startDate 파라미터 추가
- 다가오는 일정 조회 응답 형식 문서화
- PUT /admin/youtube/schedule/:id 문서 추가

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
caadiq 2026-01-20 17:28:50 +09:00
parent f780e91f14
commit 8bcd3e881d

View file

@ -38,10 +38,13 @@ Base URL: `/api`
일정 조회 일정 조회
**Query Parameters:** **Query Parameters:**
- `year`, `month` - 월별 조회 (필수, search 없을 때) - `year`, `month` - 월별 조회
- `startDate` - 시작 날짜 (YYYY-MM-DD), 다가오는 일정 조회
- `search` - 검색어 (Meilisearch 사용) - `search` - 검색어 (Meilisearch 사용)
- `offset`, `limit` - 페이징 - `offset`, `limit` - 페이징
`search`, `startDate`, `year/month` 중 하나는 필수
**월별 조회 응답:** **월별 조회 응답:**
```json ```json
{ {
@ -70,6 +73,23 @@ Base URL: `/api`
- X (category_id=3): `{ name: "", url: "https://x.com/realfromis_9/status/..." }` (name 빈 문자열) - X (category_id=3): `{ name: "", url: "https://x.com/realfromis_9/status/..." }` (name 빈 문자열)
- 기타 카테고리: source 없음 - 기타 카테고리: source 없음
**다가오는 일정 응답 (startDate):**
```json
[
{
"id": 123,
"title": "...",
"date": "2026-01-18",
"time": "19:00:00",
"category_id": 2,
"category_name": "유튜브",
"category_color": "#ff0033",
"members": [{ "name": "송하영" }]
}
]
```
※ 멤버가 5명 이상이면 `[{ "name": "프로미스나인" }]` 반환
**검색 응답:** **검색 응답:**
```json ```json
{ {
@ -227,6 +247,18 @@ YouTube 일정 저장
} }
``` ```
### PUT /admin/youtube/schedule/:id
YouTube 일정 수정 (멤버, 영상 유형)
**Request Body:**
```json
{
"memberIds": [1, 2, 3],
"videoType": "video"
}
```
`videoType`: "video" 또는 "shorts"
--- ---
## 관리자 - X (인증 필요) ## 관리자 - X (인증 필요)