Skip to content

Commit 738357d

Browse files
devxbdevxb
authored
release: 0.8.5 (#92)
2 parents a095b93 + e827cd9 commit 738357d

30 files changed

+611
-366
lines changed

‎docs/api/guild/accept-join-guild.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Accept join guild
2+
3+
{guildId}와 {userId}를 입력받아 가입 요청을 수락합니다.
4+
5+
## Request
6+
### Http Method: `POST`
7+
### url: `https://render.gitanimals.org/guilds/{guildId}/accepts`
8+
### Request param
9+
- `user-id`: 가입을 수락할 유저의 id
10+
### Http Headers
11+
- Authorization: 토큰을 전달합니다.
12+
13+
## Response
14+
200 OK

‎docs/api/guild/change-guild.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Patch guild
2+
3+
길드 정보를 업데이트 합니다.
4+
(모든 필드는 null인 경우 무시됩니다.)
5+
6+
## Request
7+
### Http Method: `PATCH`
8+
### url: `https://render.gitanimals.org/guilds/{guildId}`
9+
### Http Headers
10+
- Authorization: 토큰을 전달합니다.
11+
12+
### Request body
13+
```json
14+
{
15+
"title": "변경할 길드의 제목",
16+
"body": "변경할 길드의 설명",
17+
"farmType": "변경할 길드의 배경",
18+
"guildIcon": "변경할 길드의 아이콘",
19+
"autoJoin": true // 자동가입 여부
20+
}
21+
```
22+
23+
## Response
24+
200 OK
25+

‎docs/api/guild/change-main-pet.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Change main pet
2+
3+
길드에 등록된 메인펫을 변경합니다.
4+
5+
## Request
6+
### Http Method: `POST`
7+
### url: `https://render.gitanimals.org/guilds/{guildId}/personas`
8+
### Request params
9+
- `persona-id`: 변경된 펫의 아이디
10+
### Http Headers
11+
- Authorization: 토큰을 전달합니다.
12+
13+
## Response
14+
200 OK

‎docs/api/guild/create-guild.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Create guild
2+
3+
길드를 생성합니다.
4+
길드의 title은 중복될 수 없습니다.
5+
6+
## Request
7+
### HTTP METHOD : `POST`
8+
### url : `https://render.gitanimals.org/guilds`
9+
### Request Header
10+
- Authorization: 생성 요청자의 토큰 전달 이 토큰으로 leader가 결정됨
11+
12+
### Request body
13+
14+
```json
15+
{
16+
"title": "길드의 이름",
17+
"body": "길드의 본문",
18+
"guildIcon": "guild의 아이콘",
19+
"autoJoin": true, // 자동가입 여부
20+
"farmType": "FARM_TYPE", // 그리는 팜의 타입
21+
"personaId": "1234567890" // 대표의 보여질 펫 아이디
22+
}
23+
```
24+
25+
## Response
26+
27+
200 OK

‎docs/api/guild/deny-join-guild.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Deny join guild
2+
3+
{guildId}와 {userId}를 입력받아 가입 요청을 거절합니다.
4+
5+
## Request
6+
### Http Method: `POST`
7+
### url: `https://render.gitanimals.org/guilds/{guildId}/deny`
8+
### Request param
9+
- `user-id`: 가입을 거절할 유저의 id
10+
### Http Headers
11+
- Authorization: 토큰을 전달합니다.
12+
13+
## Response
14+
200 OK

‎docs/api/guild/get-all-joined-guild.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Get all joined guilds
2+
3+
토큰에 해당하는 유저가 참여중인 모든 길드를 조회합니다.
4+
5+
## Request
6+
### HTTP METHOD : `GET`
7+
### url : `https://render.gitanimals.org/guilds`
8+
### Http Headers
9+
- Authorization: 토큰을 전달합니다.
10+
11+
## Response
12+
13+
```json
14+
{
15+
"guilds": [
16+
{
17+
"id": "123456",
18+
"title": "제목",
19+
"body": "설명",
20+
"guildIcon": "길드의 아이콘",
21+
"leader": {
22+
"userId": "1", // 리더의 아이디
23+
"name": "리더의 이름",
24+
"contributions": "12345", // 리더의 컨트리뷰션
25+
"personaId": "12345",
26+
"personaType": "GOOSE"
27+
},
28+
"farmType": "길드 팜의 종류",
29+
"totalContributions": "99999999", // 길드 모든 멤버와 리더의 contributions 총합
30+
"members": [
31+
{
32+
"id": "2", // 멤버의 고유 아이디
33+
"userId": "3", // 유저의 아이디
34+
"name": "유저의 이름",
35+
"contributions": "12345", // 각 멤버의 contributions
36+
"personaId": "4", // 길드에 보여질 대표펫의 아이디
37+
"personaType": "GOOSE"
38+
},
39+
...
40+
],
41+
"waitMembers": [ // 길드 가입을 대기하는 유저들
42+
{
43+
"id": "2", // 멤버의 고유 아이디
44+
"userId": "3", // 유저의 아이디
45+
"name": "유저의 이름",
46+
"contributions": "12345", // 각 멤버의 contributions
47+
"personaId": "4", // 길드에 보여질 대표펫의 아이디
48+
"personaType": "GOOSE"
49+
},
50+
...
51+
],
52+
"createdAt": "2022-04-29 10:15:30"
53+
},
54+
...
55+
]
56+
}
57+
58+
```

‎docs/api/guild/get-guild-by-id.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Get Guild by id
2+
3+
길드 id로 길드를 단건 조회합니다.
4+
5+
## Request
6+
### Http Method: `GET`
7+
### url: `https://render.gitanimals.org/guilds/{guildId}`
8+
9+
## Response
10+
11+
```json
12+
{
13+
"id": "123456",
14+
"title": "제목",
15+
"body": "설명",
16+
"guildIcon": "길드의 아이콘",
17+
"leader": {
18+
"userId": "1", // 리더의 아이디
19+
"name": "리더의 이름",
20+
"contributions": "12345",// 리더의 컨트리뷰션
21+
"personaId": "12345",
22+
"personaType": "GOOSE"
23+
},
24+
"farmType": "길드 팜의 종류",
25+
"totalContributions": "99999999", // 길드 모든 멤버와 리더의 contributions 총합
26+
"members": [
27+
{
28+
"id": "2", // 멤버의 고유 아이디
29+
"userId": "3", // 유저의 아이디
30+
"name": "유저의 이름",
31+
"contributions": "12345", // 각 멤버의 contributions
32+
"personaId": "4", // 길드에 보여질 대표펫의 아이디
33+
"personaType": "GOOSE"
34+
},
35+
...
36+
],
37+
"waitMembers": [ // 길드 가입을 대기하는 유저들
38+
{
39+
"id": "2", // 멤버의 고유 아이디
40+
"userId": "3", // 유저의 아이디
41+
"name": "유저의 이름",
42+
"contributions": "12345", // 각 멤버의 contributions
43+
"personaId": "4", // 길드에 보여질 대표펫의 아이디
44+
"personaType": "GOOSE"
45+
},
46+
...
47+
],
48+
"createdAt": "2022-04-29 10:15:30"
49+
}
50+
```

‎docs/api/guild/get_all_guild_backgrounds.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Get all guild icons
2+
3+
존재하는 길드 배경들의 이름을 반환합니다.
4+
5+
6+
## Request
7+
### HTTP METHOD : `GET`
8+
### url : `https://render.gitanimals.org/guilds/backgrounds`
9+
10+
## Response
11+
12+
200 OK
13+
14+
```json
15+
{
16+
"backgrounds": [
17+
"LOGO_SHOWING", ...
18+
]
19+
}
20+
```

‎docs/api/guild/get_all_guild_icons.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Get all guild icons
2+
3+
존재하는 길드 아이콘들의 이름을 반환합니다.
4+
5+
6+
## Request
7+
### HTTP METHOD : `GET`
8+
### url : `https://render.gitanimals.org/guilds/icons`
9+
10+
## Response
11+
12+
200 OK
13+
14+
```json
15+
{
16+
"icons": [
17+
"https://static.gitanimals.org/guilds/icons/GUILD-1",
18+
"https://static.gitanimals.org/guilds/icons/GUILD-2",
19+
...
20+
]
21+
}
22+
```

‎docs/api/guild/join-guild.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Join guild
2+
3+
guildId에 해당하는 길드에 가입합니다.
4+
5+
## Request
6+
### HTTP METHOD : `POST`
7+
### url : `https://render.gitanimals.org/guilds/{guildId}`
8+
### Request Header
9+
- Authorization: 토큰에 해당하는 유저가 가입됩니다.
10+
11+
### Request body
12+
```json
13+
{
14+
"personaId": "12345" // 길드에 보여질 대표펫의 id를 넘깁니다.
15+
}
16+
```
17+
18+
## Response
19+
20+
200 OK

‎docs/api/guild/kick_member_from_guild.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Kick member from guild
2+
3+
유저를 길드에서 추방합니다.
4+
5+
## Request
6+
### Http Method: `DELETE`
7+
### url: `https://render.gitanimals.org/guilds/{guildId}`
8+
### Request param
9+
- `user-id`: 추방할 유저의 id
10+
### Http Headers
11+
- Authorization: 토큰을 전달합니다.
12+
13+
## Response
14+
200 OK

‎docs/api/guild/leave-guild.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Leave guild
2+
3+
길드를 떠납니다. (멤버만 가능)
4+
5+
## Request
6+
### Http Method: `DELETE`
7+
### url: `https://render.gitanimals.org/guilds/{guildId}/leave`
8+
### Http Headers
9+
- Authorization: 토큰을 전달합니다.
10+
11+
## Response
12+
200 OK

‎docs/api/guild/search-guild.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Search guild
2+
3+
길드를 검색합니다.
4+
5+
## Request
6+
### Http Method: `GET`
7+
### url: `https://render.gitanimals.org/guilds/search`
8+
### Request param
9+
- `page-number`: page-number에 해당하는 page를 조회합니다. (첫번째 page-number는 0 이며, 아무것도 입력하지 않을시, 0으로 초기화 됩니다.)
10+
- `filter`: filter 조건에 의해서 정렬합니다. 기본값은 random 입니다.
11+
- `RANDOM`: 랜덤하게 정렬합니다.
12+
- `PEOPLE_ASC`: 사람 오름차순
13+
- `PEOPLE_DESC`: 사람 내림차순
14+
- `CONTRIBUTION_ASC`: 기여 오름차순
15+
- `CONTRIBUTION_DESC`: 기여 내림차순
16+
- `text`: 검색어 입니다.
17+
- `key`: 랜덤의 변인이 되는 키 입니다. 하나의 유저는 페이지를 이탈하기 전까지 같은 key로 요청해야 중복된 상품을 보지 않습니다. key는 음수가 아닌 int 입니다.
18+
19+
20+
### Response
21+
200 OK
22+
23+
```json
24+
{
25+
"guilds": [
26+
{
27+
"title": "제목",
28+
"body": "설명",
29+
"guildIcon": "길드의 아이콘",
30+
"leader": {
31+
"userId": "1", // 리더의 아이디
32+
"name": "리더의 이름",
33+
"contributions": "12345", // 리더의 컨트리뷰션
34+
"personaId": "12345",
35+
"personaType": "GOOSE"
36+
},
37+
"farmType": "길드 팜의 종류",
38+
"totalContributions": "99999999", // 길드 모든 멤버와 리더의 contributions 총합
39+
"members": [
40+
{
41+
"id": "2", // 멤버의 고유 아이디
42+
"userId": "3", // 유저의 아이디
43+
"name": "유저의 이름",
44+
"contributions": "12345", // 각 멤버의 contributions
45+
"personaId": "4", // 길드에 보여질 대표펫의 아이디
46+
"personaType": "GOOSE"
47+
},
48+
...
49+
],
50+
"waitMembers": [ // 길드 가입을 대기하는 유저들
51+
{
52+
"id": "2", // 멤버의 고유 아이디
53+
"userId": "3", // 유저의 아이디
54+
"name": "유저의 이름",
55+
"contributions": "12345", // 각 멤버의 contributions
56+
"personaId": "4", // 길드에 보여질 대표펫의 아이디
57+
"personaType": "GOOSE"
58+
},
59+
...
60+
],
61+
"createdAt": "2022-04-29T10:15:30Z",
62+
},
63+
],
64+
"pagination": {
65+
"totalRecords": 100,
66+
"currentPage": 0,
67+
"totalPages": 10,
68+
"nextPage": 1,
69+
"prevPage": null
70+
}
71+
}
72+
```

0 commit comments

Comments
 (0)