Skip to content

Commit f1499da

Browse files
authored
更改部分字段名称保持和官方api一致 (#11)
* Update deploy-docs.yml * feat(docs): /v1/group/info * update(docs): 修正proto文件msg命名 * Update: 更改部分字段名和官方api保持一致 * Update: 更改部分字段名和官方api保持一致
1 parent e7d92e7 commit f1499da

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

src/api/v1/user.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -134,28 +134,28 @@ data {
134134
avatar_url: "头像URL"
135135
avatar_id: 头像ID(整数)
136136
medal {
137-
order: 1
138-
text: "内测用户"
139-
id: 100
137+
id: 1
138+
name: "内测用户"
139+
sort: 100
140140
}
141141
medal {
142-
order: 6
143-
text: "100000用户"
144-
id: 500
142+
id: 6
143+
name: "100000用户"
144+
sort: 500
145145
}
146-
registered_time: "注册时间(YYYY-MM-DD hh:mm:ss)"
146+
register_time: "注册时间(YYYY-MM-DD hh:mm:ss)"
147147
online_day: 在线时长(整数)
148-
continue_online_day: 连续在线时长(整数)
148+
continuous_online_day: 连续在线时长(整数)
149149
vip_expired_time: unix时间戳
150150
}
151151
```
152152
::: details ProtoBuf数据结构
153153
```proto
154154
// 勋章信息
155155
message Medal_info {
156-
uint64 order = 1;
157-
string text = 2;
158-
uint64 id = 5;
156+
uint64 id = 1;
157+
string name = 2;
158+
uint64 sort = 5;
159159
}
160160
161161
// 获取用户信息
@@ -169,9 +169,9 @@ message get_user {
169169
string avatar_url = 4; //头像URL
170170
uint64 avatar_id = 5; // 头像ID
171171
repeated Medal_info medal = 6; // 勋章信息
172-
string registered_time = 7; // 注册时间,格式: YYYY-MM-DD hh:mm:ss
172+
string register_time = 7; // 注册时间,格式: YYYY-MM-DD hh:mm:ss
173173
uint64 online_day = 11; // 在线天数
174-
uint64 continue_online_day = 12; // 连续在线天数
174+
uint64 continuous_online_day = 12; // 连续在线天数
175175
uint64 vip_expired_time = 14; // VIP过期时间(时间戳)
176176
}
177177
}
@@ -196,14 +196,14 @@ status {
196196
msg: "success"
197197
}
198198
medal {
199-
order: 1
200-
text: "内测用户"
201-
id: 100
199+
id: 1
200+
name: "内测用户"
201+
sort: 100
202202
}
203203
medal {
204-
order: 6
205-
text: "100000用户"
206-
id: 500
204+
id: 6
205+
name: "100000用户"
206+
sort: 500
207207
}
208208
```
209209

@@ -217,9 +217,9 @@ message medal {
217217
218218
// 勋章信息
219219
message Medal_info {
220-
uint64 order = 1; // 勋章序列
221-
string text = 2; // 勋章文本
222-
uint64 id = 5; // 勋章ID? 不确定
220+
uint64 id = 1; // 勋章ID
221+
string name = 2; // 勋章名
222+
uint64 sort = 5; // 勋章排列相关?
223223
}
224224
```
225225
:::
@@ -258,7 +258,7 @@ status {
258258
::: details ProtoBuf数据结构
259259
```proto
260260
// 更改名称状态信息
261-
message medal {
261+
message edit_nickname {
262262
Status status = 1; // 状态信息
263263
}
264264
```
@@ -280,7 +280,7 @@ url: "用户头像url"
280280
```
281281
::: details ProtoBuf数据结构
282282
```proto
283-
message edit_nickname_send {
283+
message edit_avatar_send {
284284
string url = 2;
285285
}
286286
```
@@ -298,7 +298,7 @@ status {
298298
::: details ProtoBuf数据结构
299299
```proto
300300
// 更改名称状态信息
301-
message medal {
301+
message edit_avatar {
302302
Status status = 1; // 状态信息
303303
}
304304
```

0 commit comments

Comments
 (0)