Merge pull request #1491 from haoxiuwen/architecture

Modify REST API Docs

Author: haoxiuwen

docs/.vuepress/sidebar/document.ts

@@ -589,7 +589,7 @@ const documentSidebar = [
           {text: '修改聊天室公告', link: 'chatroom_announcement_update.html' }, 
           {text: '设置聊天室自定义属性', link: 'chatroom_custom_attribute_set.html' }, 
           {text: '强制设置聊天室自定义属性', link: 'chatroom_custom_attribute_set_force.html' }, 
-          {text: '获取聊天室自定义属性', link: 'chatroom_custom_attribute_set.html' }, 
+          {text: '获取聊天室自定义属性', link: 'chatroom_custom_attribute_get.html' }, 
           {text: '删除聊天室自定义属性', link: 'chatroom_custom_attribute_delete.html' }, 
           {text: '强制删除聊天室自定义属性', link: 'chatroom_custom_attribute_delete_force.html' }, 
          ], 
@@ -796,7 +796,7 @@ const documentSidebar = [
             { text: '概述', link: 'push_template_overview.html' },
             { text: '创建推送模板', link: 'push_template_create.html' },
             { text: '删除推送模板', link: 'push_template_delete.html' },
-            { text: '查询推送模板', link: 'push_settings_query.html' },
+            { text: '查询推送模板', link: 'push_template_query.html' },
             { text: '发消息时配置模板', link: 'push_template_send_message.html' },
             { text: '接收方配置模板', link: 'push_template_receiver.html' },
           ]

docs/document/server-side/account_register_authorized_batch.md

@@ -75,7 +75,13 @@ curl -X POST -H "Authorization: Bearer <YourAppToken>" -i  "https://XXXX/XXXX/XX
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST -H "Authorization: Bearer <YourAppToken>" -i  "https://XXXX/XXXX/XXXX/users" -d '[{"username":"user1", "password":"123"}, {"username":"user2", "password":"456"}, {"username":"user3", "password":"789"}]'
+curl -X POST -i  "https://XXXX/XXXX/XXXX/users"  \
+-H "Authorization: Bearer <YourAppToken>"  \
+-d '[
+      {"username":"user1", "password":"123"}, 
+      {"username":"user2", "password":"456"}, 
+      {"username":"user3", "password":"789"}
+  ]'
 ```
 
 ## 响应示例二
@@ -132,6 +138,8 @@ curl -X POST -H "Authorization: Bearer <YourAppToken>" -i  "https://XXXX/XXXX/XX
 
 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中的 `entities` 字段如下：
 
+| 参数              | 类型   | 描述                                                                           |
+| :---------------- | :----- | :----------------------------------------------------------------------------- |
 | `entities`        | JSON Array | 响应实体。                                                   |
 | - `uuid`          | String     | 用户的 UUID。即时通讯服务为该请求中的 app 或用户生成的唯一内部标识，用于生成 User Token。 |
 | - `type`          | String     | 对象类型，无需关注。                                         |

docs/document/server-side/account_register_authorized_single.md

@@ -80,6 +80,8 @@ curl -X POST 'https://XXXX/XXXX/XXXX/users'    \
 
 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中的 `data` 字段如下：
 
+| 参数              | 类型   | 描述                                                                           |
+| :---------------- | :----- | :----------------------------------------------------------------------------- |
 | `entities`        | JSON Array | 响应实体。                                                   |
 | - `uuid`          | String     | 用户的 UUID。即时通讯服务为该请求中的 app 或用户生成的唯一内部标识，用于生成 User Token。 |
 | - `type`          | String     | 对象类型，无需关注。                                         |

docs/document/server-side/chatroom_allowlist_overview.md

@@ -16,7 +16,7 @@
 
 聊天室白名单管理包含如下 API：
 
-- [查询聊天室白名单](chatroom_allowlist_query.html)
+- [查询聊天室白名单](chatroom_allowlist_obtain.html)
 - [批量添加用户至聊天室白名单](chatroom_allowlist_add_batch.html)
 - [添加单个用户至聊天室白名单](chatroom_allowlist_add_single.html)
 - [将用户移出聊天室白名单](chatroom_allowlist_remove.html)

docs/document/server-side/group_admin_add.md

@@ -28,7 +28,9 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST HTTP://XXXX/XXXX/XXXX/chatgroups/10XXXX85/admin -d '{"newadmin":"user1"}' -H 'Authorization: Bearer <YourAppToken>'
+curl -X POST HTTP://XXXX/XXXX/XXXX/chatgroups/10XXXX85/admin    \
+-H 'Authorization: Bearer <YourAppToken>'   \
+-d '{"newadmin":"user1"}' 
 ```
 
 ## 请求 header 参数

docs/document/server-side/group_admin_list_get.md

@@ -25,7 +25,8 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X GET HTTP://XXXX/XXXX/XXXX/chatgroups/10XXXX85/admin -H 'Authorization: Bearer <YourAppToken>'
+curl -X GET HTTP://XXXX/XXXX/XXXX/chatgroups/10XXXX85/admin      \
+-H 'Authorization: Bearer <YourAppToken>'
 ```
 
 ## 请求 header 参数

docs/document/server-side/group_admin_remove.md

@@ -27,7 +27,8 @@ DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin/{usernam
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X DELETE HTTP://XXXX/XXXX/XXXX/chatgroups/10XXXX85/admin/user1 -H 'Authorization: Bearer <YourAppToken>'
+curl -X DELETE HTTP://XXXX/XXXX/XXXX/chatgroups/10XXXX85/admin/user1    \
+-H 'Authorization: Bearer <YourAppToken>'
 ```
 
 ## 请求 header 参数

docs/document/server-side/group_allowlist_add_batch.md

@@ -29,7 +29,11 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{"usernames" : ["user1"]}' 'https://XXXX/XXXX/XXXX/chatgroups/{groupid}/white/users'
+curl -X POST 'https://XXXX/XXXX/XXXX/chatgroups/{groupid}/white/users'  \
+-H 'Content-Type: application/json'   \
+-H 'Accept: application/json'   \
+-H 'Authorization: Bearer <YourAppToken>'   \
+-d '{"usernames" : ["user1"]}' 
 ```
 
 ## 请求 header 参数

docs/document/server-side/group_allowlist_add_single.md

@@ -29,15 +29,15 @@ POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users/{use
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatgroups/{groupid}/white/users/{username}'
+curl -X POST 'https://XXXX/XXXX/XXXX/chatgroups/{groupid}/white/users/{username}'  \
+-H 'Accept: application/json'  \
+-H 'Authorization: Bearer <YourAppToken>' 
 ```
 
 ## 请求 header 参数
 
 关于 `Accept` 和 `Authorization` 字段的说明，详见 [请求 header 参数说明](overview.html#请求-header)。
 
-## 请求 body 参数
-
 ## 响应示例
 
 ```json

docs/document/server-side/group_allowlist_query.md

@@ -25,15 +25,15 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/white/users
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/chatgroups/{groupid}/white/users'
+curl -X GET 'https://XXXX/XXXX/XXXX/chatgroups/{groupid}/white/users'   \
+-H 'Accept: application/json'   \
+-H 'Authorization: Bearer <YourAppToken>' 
 ```
 
 ## 请求 header 参数
 
 关于 `Accept` 和 `Authorization` 字段的说明，详见 [请求 header 参数说明](overview.html#请求-header)。
 
-## 请求 body 参数
-
 ## 响应示例
 
 ```json