Skip to content

Commit

Permalink
fix: doc (#189)
Browse files Browse the repository at this point in the history
  • Loading branch information
@mo3et
mo3et authored Sep 29, 2024
1 parent 1819173 commit 54b089f
Show file tree
Hide file tree
Showing 14 changed files with 13 additions and 176 deletions.
1 change: 0 additions & 1 deletion docs/restapi/apis/friendsManagement/addBlackList.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |

### 失败返回示例

Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/apis/friendsManagement/deleteBlackList.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |


### 失败返回示例

Expand Down
1 change: 0 additions & 1 deletion docs/restapi/apis/friendsManagement/deleteFriend.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |

### 失败返回示例

Expand Down
1 change: 0 additions & 1 deletion docs/restapi/apis/friendsManagement/importFriend.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |

### 失败返回示例

Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/apis/friendsManagement/processApplication.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |


### 失败返回示例

Expand Down
1 change: 0 additions & 1 deletion docs/restapi/apis/friendsManagement/sendApplication.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |

### 失败返回示例

Expand Down
83 changes: 0 additions & 83 deletions docs/restapi/apis/friendsManagement/setFriendRemark.mdx
View file

This file was deleted.

4 changes: 2 additions & 2 deletions docs/restapi/apis/friendsManagement/updateFriends.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ hide_title: true

### 简要描述

- 修改指定用户（ownerUserID）的某个好友（friendUserID）的备注、星标信息。
- 修改指定用户（ownerUserID）的某个好友（friendUserID）的备注、星标信息。仅传需要修改的字段，也支持零值。

### 请求方式

Expand Down Expand Up @@ -66,7 +66,7 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |


### 失败返回示例

Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/apis/userManagement/checkUserRegistered.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ hide_title: true
| data | object | 通用数据对象，具体结构见下方 |
| results | array | 查询结果 |
| results.userID | string | 用户 ID |
| results.accountStatus | int | 账户状态，未注册：0，已注册：1 |
| results.accountStatus | int | 账户状态，0：未注册，1：已注册 |

### 失败返回示例

Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/apis/userManagement/getSubscribeUsersStatus.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ hide_title: true
| data | object | 通用数据对象，具体结构见下方 |
| statusList | array | 订阅用户在线状态列表 |
| statusList.userID | string | 用户 ID |
| statusList.status | int | 在线状态，1：online，0 ：offline |
| statusList.status | int | 在线状态，0 ：offline，1：online |
| statusList.platformIDs | array | [用户登录时的终端类型](docs/restapi/commonFields.mdx)列表，可存在多端在线。取值为1-9 |

### 失败返回示例
Expand Down
4 changes: 2 additions & 2 deletions docs/restapi/apis/userManagement/subscribeUsersStatus.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ hide_title: true
},
{
"userID": "8450535746",
"status": 0,
"status": 1,
"platformIDs": [2]
}
]
Expand All @@ -84,7 +84,7 @@ hide_title: true
| data | object | 通用数据对象，具体结构见下方 |
| statusList | array | 状态返回结果 |
| statusList.userID | string | 用户账号 |
| statusList.status | int | 在线状态，1：online，0 ：offline |
| statusList.status | int | 在线状态，0 ：offline，1：online |
| statusList.platformIDs | array | [用户登录时的终端类型](docs/restapi/commonFields.mdx)列表，可能多端在线，取值为1-9 |

### 失败返回示例
Expand Down
2 changes: 1 addition & 1 deletion docs/restapi/apis/userManagement/updateGlobalRemind.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |


### 失败返回示例

Expand Down
8 changes: 4 additions & 4 deletions docs/restapi/apis/userManagement/updateUserInfo.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ hide_title: true

### 简要描述

- 修改用户的头像、昵称等信息。
- 修改用户的头像、名称、Ex等信息。仅传需要修改的字段，也支持零值。

### 请求方式

Expand All @@ -36,7 +36,7 @@ hide_title: true
"userInfo": {
"userID": "2",
"nickname": "alantestuid3",
"faceURL": "1111111",
"faceURL": "",
"ex": "123"
}
}
Expand All @@ -46,7 +46,7 @@ hide_title: true
| :---------------- | :--- | :----- | -------- |
| userInfo | 必填 | object | 用户信息 |
| userInfo.userID | 必填 | string | 用户 lD |
| userInfo.nickname | 选填 | string | 用户昵称 |
| userInfo.nickname | 选填 | string | 用户名称 |
| userInfo.faceURL | 选填 | string | 用户头像 |
| ex | 选填 | string | 扩展字段 |

Expand All @@ -67,7 +67,7 @@ hide_title: true
| errCode | int | 错误码，0 表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |


### 失败返回示例

Expand Down
76 changes: 0 additions & 76 deletions ...-plugin-content-docs-restapi/current/apis/friendsManagement/setFriendRemark.mdx
View file

This file was deleted.

0 comments on commit 54b089f

Please sign in to comment.