Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
* [승인된 회원 목록 조회](member/approved-members.md)
* [관리자 페이지 로그인](member/admin-login.md)
* [비밀번호 설정](member/admin-password.md)
* [약관 동의](member/agree-terms.md)

## Board (게시판) <a href="#board" id="board"></a>

Expand Down Expand Up @@ -104,6 +105,7 @@
* [배지 부여](badge/assign.md)
* [해당 회원의 모든 배지 조회](badge/get-member-badges.md)
* [배지 회수](badge/remove.md)
* [배지 단건 조회](badge/get-badge-single.md)

## Activity (활동기록) <a href="#activity" id="activity"></a>

Expand Down
53 changes: 53 additions & 0 deletions badge/get-badge-single.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## 배지 단건 조회

### 개요
배지 단건 조회

### 엔드포인트
`GET /v1/admin/badges/{badgeId}`

### 인증
- **인증 필요 여부:** JWT 인증 필요
- **권한:** 관리자만 접근 가능 (MANAGER 이상)

> 요청 헤더(Header)에 아래와 같이 Authorization 필드를 포함해야 합니다.
> `Authorization: Bearer {JWT_TOKEN}`

### 요청 (Request)

**Headers**
| Key | Type | 설명 | 필수 |
|-----|------|------|------|
| Authorization | String | Bearer 토큰 | O |

**Path Parameters**
| Key | Type | 설명 | 필수 |
|-----|------|------|------|
| badgeId | Long | badgeId | O |

---

### 응답 (Response)

**성공**
| HTTP Status | 의미 |
|-------------|------|
| 200 OK | 요청 성공 |

**Body (BadgeDetailResDTO)**
| Key | Type | 설명 |
|-----|------|------|
| badgeId | Long | badgeId |
| name | String | name |
| imageUrl | String | imageUrl |
| description | String | description |
| requirement | String | requirement |

**응답 예시**
```json
{
"code": 200,
"message": "요청이 성공적으로 처리되었습니다.",
"data": null
}
```
39 changes: 39 additions & 0 deletions member/agree-terms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## 약관 동의

### 개요
약관 동의

### 엔드포인트
`PATCH /v1/user/members/terms/agree`

### 인증
- **인증 필요 여부:** JWT 인증 필요
- **권한:** 일반 사용자 접근 가능 (MEMBER 이상)

> 요청 헤더(Header)에 아래와 같이 Authorization 필드를 포함해야 합니다.
> `Authorization: Bearer {JWT_TOKEN}`

### 요청 (Request)

**Headers**
| Key | Type | 설명 | 필수 |
|-----|------|------|------|
| Authorization | String | Bearer 토큰 | O |

---

### 응답 (Response)

**성공**
| HTTP Status | 의미 |
|-------------|------|
| 200 OK | 요청 성공 |

**응답 예시**
```json
{
"code": 200,
"message": "요청이 성공적으로 처리되었습니다.",
"data": null
}
```