Skip to content

Commit e04005f

Browse files
committed
doc: point 증/감 API를 추가한다
1 parent f7363d5 commit e04005f

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Get user by token
2+
3+
username에 해당하는 유저의 포인트를 감소시킵니다.
4+
5+
> [!WARN]
6+
> 요청하면 별도의 승인절차를 거친 후 승인이 되었을때, 요청이 처리됩니다.
7+
8+
## Request
9+
### HTTP METHOD : `POST`
10+
### url : `https://api.gitanimals.org/admin/users/points/decrease/by-username/{username}`
11+
### RequestHeader
12+
- Admin-Secret: `{발급받은 어드민 토큰을 넘겨주세요.}`
13+
- Authorization: `{어드민 요청자의 인증토큰을 넘겨주세요.}`
14+
15+
### Request Body
16+
```json
17+
{
18+
"point": 100000, // 감소 시킬 포인트
19+
"reason": "" // 요청을 처리하는 이유
20+
}
21+
```
22+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Get user by token
2+
3+
username에 해당하는 유저의 포인트를 증가시킵니다.
4+
5+
> [!WARN]
6+
> 요청하면 별도의 승인절차를 거친 후 승인이 되었을때, 요청이 처리됩니다.
7+
8+
## Request
9+
### HTTP METHOD : `POST`
10+
### url : `https://api.gitanimals.org/admin/users/points/increase/by-username/{username}`
11+
### RequestHeader
12+
- Admin-Secret: `{발급받은 어드민 토큰을 넘겨주세요.}`
13+
- Authorization: `{어드민 요청자의 인증토큰을 넘겨주세요.}`
14+
15+
### Request Body
16+
```json
17+
{
18+
"point": 100000, // 증가 시킬 포인트
19+
"reason": "" // 요청을 처리하는 이유
20+
}
21+
```

0 commit comments

Comments
 (0)