Skip to content

Commit d946563

Browse files
mo3etmo3et
authored
docs: updat userRegister fields. (#167)
1 parent 918e936 commit d946563

87 files changed

Lines changed: 228 additions & 416 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/restapi/apis/authenticationManagement/forceLogout.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ hide_title: true
5858
| 参数名 | 类型 | 说明 |
5959
| :------ | :----- | :--------------------------- |
6060
| errCode | int | 错误码,0 表示成功 |
61-
| errMsg | string | 错误简要信息,无错误时为空 |
62-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
61+
| errMsg | string | 错误简要信息，为空 |
62+
| errDlt | errDlt | 错误详细信息，为空 |
6363
| data | object | 通用数据对象，具体结构见下方 |
6464

6565
### 失败返回示例

‎docs/restapi/apis/authenticationManagement/getToken.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ hide_title: true
6565
| 参数名 | 类型 | 说明 |
6666
| :---------------- | :----- | :--------------------------- |
6767
| errCode | int | 错误码,0 表示成功 |
68-
| errMsg | string | 错误简要信息,无错误时为空 |
69-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
68+
| errMsg | string | 错误简要信息，为空 |
69+
| errDlt | errDlt | 错误详细信息，为空 |
7070
| data | object | 通用数据对象，具体结构见下方 |
7171
| token | string | 获取到的用户 token |
7272
| expireTimeSeconds | string | token 的过期时间（单位秒） |

‎docs/restapi/apis/authenticationManagement/getUserToken.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ hide_title: true
6464
| 参数名 | 类型 | 说明 |
6565
| :---------------- | :----- | :--------------------------- |
6666
| errCode | int | 错误码,0 表示成功 |
67-
| errMsg | string | 错误简要信息,无错误时为空 |
68-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
67+
| errMsg | string | 错误简要信息，为空 |
68+
| errDlt | errDlt | 错误详细信息，为空 |
6969
| data | object | 通用数据对象，具体结构见下方 |
7070
| token | string | 获取到的用户 token |
7171
| expireTimeSeconds | string | token 的过期时间（单位秒） |

‎docs/restapi/apis/conversationManagement/getOwnerConversation.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ hide_title: true
2121

2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
24-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
24+
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
2525
|token|eyJhbxxxx3Xs|必填|string|管理员token|
2626

2727

@@ -445,8 +445,8 @@ hide_title: true
445445
|参数名|类型|说明|
446446
|:---- |:------- |:--- |
447447
|errCode|int|错误码,0表示成功|
448-
|errMsg|string|错误简要信息,无错误时为空|
449-
|errDlt|errDlt|错误详细信息,无错误时为空|
448+
|errMsg|string|错误简要信息，为空|
449+
|errDlt|errDlt|错误详细信息，为空|
450450
|data|object|通用数据对象，具体结构见下方|
451451
|total|string|会话总数|
452452
|conversations|array|[会话](docs/restapi/commonFields.mdx#conversationinfo)列表|

‎docs/restapi/apis/conversationManagement/getSortedConversationList.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ hide_title: true
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|token|eyJhbxxxx3Xs|必填|string|管理员token|
25-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
25+
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
2626

2727
### 请求参数示例
2828

@@ -117,8 +117,8 @@ hide_title: true
117117
| 字段名 | 类型 | 说明 |
118118
|:------------------|:---------|----------------------------------------------------------------------------------|
119119
| errCode | int | 错误码,0表示成功 |
120-
| errMsg | string | 错误简要信息,无错误时为空 |
121-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
120+
| errMsg | string | 错误简要信息，为空 |
121+
| errDlt | errDlt | 错误详细信息，为空 |
122122
| unreadTotal | string |未读数总数 |
123123
| conversationToal | string | 会话数总数 |
124124
| data | object | 通用数据对象，具体结构见下方 |

‎docs/restapi/apis/conversationManagement/setConversations.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ hide_title: true
2121
### Header
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
24-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
24+
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
2525
|token|eyJhbxxxx3Xs|必填|string|管理员token|
2626

2727

@@ -78,8 +78,8 @@ hide_title: true
7878
|参数名|类型|说明|
7979
|:---- |:------- |:--- |
8080
|errCode|int|错误码,0表示成功|
81-
|errMsg|string|错误简要信息,无错误时为空|
82-
|errDlt|errDlt|错误详细信息,无错误时为空|
81+
|errMsg|string|错误简要信息，为空|
82+
|errDlt|errDlt|错误详细信息，为空|
8383
|data|object|通用数据对象，具体结构见下方|
8484
### 失败返回示例
8585

‎docs/restapi/apis/friendsManagement/addBlackList.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ hide_title: true
6060
| 参数名 | 类型 | 说明 |
6161
| :------ | :----- | :--------------------------- |
6262
| errCode | int | 错误码,0 表示成功 |
63-
| errMsg | string | 错误简要信息,无错误时为空 |
64-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
63+
| errMsg | string | 错误简要信息，为空 |
64+
| errDlt | errDlt | 错误详细信息，为空 |
6565
| data | object | 通用数据对象，具体结构见下方 |
6666

6767
### 失败返回示例

‎docs/restapi/apis/friendsManagement/checkFriend.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ hide_title: true
6262
| 参数名 | 类型 | 说明 |
6363
| :------------- | :------ | :------------------------------------ |
6464
| errCode | int | 错误码,0 表示成功 |
65-
| errMsg | string | 错误简要信息,无错误时为空 |
66-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
65+
| errMsg | string | 错误简要信息，为空 |
66+
| errDlt | errDlt | 错误详细信息，为空 |
6767
| data | object | 通用数据对象，具体结构见下方 |
6868
| inUser1Friends | boolean | ture: userID2 在 userID1 的好友列表中 |
6969
| inUser2Friends | boolean | ture: userID1 在 userID2 的好友列表中 |

‎docs/restapi/apis/friendsManagement/deleteBlackList.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ hide_title: true
5858
| 参数名 | 类型 | 说明 |
5959
| :------ | :----- | :--------------------------- |
6060
| errCode | int | 错误码,0 表示成功 |
61-
| errMsg | string | 错误简要信息,无错误时为空 |
62-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
61+
| errMsg | string | 错误简要信息，为空 |
62+
| errDlt | errDlt | 错误详细信息，为空 |
6363
| data | object | 通用数据对象，具体结构见下方 |
6464

6565
### 失败返回示例

‎docs/restapi/apis/friendsManagement/deleteFriend.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ hide_title: true
5858
| 参数名 | 类型 | 说明 |
5959
| :------ | :----- | :--------------------------- |
6060
| errCode | int | 错误码,0 表示成功 |
61-
| errMsg | string | 错误简要信息,无错误时为空 |
62-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
61+
| errMsg | string | 错误简要信息，为空 |
62+
| errDlt | errDlt | 错误详细信息，为空 |
6363
| data | object | 通用数据对象，具体结构见下方 |
6464

6565
### 失败返回示例

0 commit comments

Comments
 (0)