Docs: add task info api and format (#315)

AlistGo · Jan 17, 2024 · 763bde5 · 763bde5
1 parent c722025
commit 763bde5
Show file tree

Hide file tree

Showing 20 changed files with 5,823 additions and 5,684 deletions.
diff --git a/docs/guide/api/admin/driver.md b/docs/guide/api/admin/driver.md
diff --git a/docs/guide/api/admin/meta.md b/docs/guide/api/admin/meta.md
@@ -25,11 +25,11 @@ GET /api/admin/meta/list
 
 ### 请求参数
 
-|名称|位置|类型|必选|说明|
-|---|---|---|---|---|
-|page|query|string| 否 |页数|
-|per_page|query|string| 否 |每页个数|
-|Authorization|header|string| 是 |none|
+| 名称          | 位置   | 类型   | 必选 | 说明     |
+| ------------- | ------ | ------ | ---- | -------- |
+| page          | query  | string | 否   | 页数     |
+| per_page      | query  | string | 否   | 每页个数 |
+| Authorization | header | string | 是   | none     |
 
 > 返回示例
 
@@ -61,42 +61,42 @@ GET /api/admin/meta/list
 
 ### 返回结果
 
-|状态码|状态码含义|说明|数据模型|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
+| 状态码 | 状态码含义                                              | 说明 | 数据模型 |
+| ------ | ------------------------------------------------------- | ---- | -------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline   |
 
 ### 返回数据结构
 
 状态码 **200**
 
-|名称|类型|必选|约束|中文名|说明|
-|---|---|---|---|---|---|
-|» code|integer|true|none|状态码|none|
-|» message|string|true|none|信息|none|
-|» data|object|true|none|数据|none|
-|»» content|[object]|true|none|内容|none|
-|»»» id|integer|false|none|id|none|
-|»»» path|string|false|none|路径|none|
-|»»» password|string|false|none|密码|none|
-|»»» p_sub|boolean|false|none|密码是否应用到子文件夹|none|
-|»»» write|boolean|false|none|是否允许写入|none|
-|»»» w_sub|boolean|false|none|是否允许写入引用到子文件夹|none|
-|»»» hide|string|false|none|隐藏|none|
-|»»» h_sub|boolean|false|none|隐藏是否应用到子文件夹|none|
-|»»» readme|string|false|none|说明|none|
-|»»» r_sub|boolean|false|none|说明是否应用到子文件夹|none|
-|»» total|integer|true|none|总数|none|
+| 名称         | 类型     | 必选  | 约束 | 中文名                     | 说明 |
+| ------------ | -------- | ----- | ---- | -------------------------- | ---- |
+| » code       | integer  | true  | none | 状态码                     | none |
+| » message    | string   | true  | none | 信息                       | none |
+| » data       | object   | true  | none | 数据                       | none |
+| »» content   | [object] | true  | none | 内容                       | none |
+| »»» id       | integer  | false | none | id                         | none |
+| »»» path     | string   | false | none | 路径                       | none |
+| »»» password | string   | false | none | 密码                       | none |
+| »»» p_sub    | boolean  | false | none | 密码是否应用到子文件夹     | none |
+| »»» write    | boolean  | false | none | 是否允许写入               | none |
+| »»» w_sub    | boolean  | false | none | 是否允许写入引用到子文件夹 | none |
+| »»» hide     | string   | false | none | 隐藏                       | none |
+| »»» h_sub    | boolean  | false | none | 隐藏是否应用到子文件夹     | none |
+| »»» readme   | string   | false | none | 说明                       | none |
+| »»» r_sub    | boolean  | false | none | 说明是否应用到子文件夹     | none |
+| »» total     | integer  | true  | none | 总数                       | none |
 
 ## GET 获取元信息
 
 GET /api/admin/meta/get
 
 ### 请求参数
 
-|名称|位置|类型|必选|说明|
-|---|---|---|---|---|
-|id|query|string| 是 |元信息id|
-|Authorization|header|string| 是 |none|
+| 名称          | 位置   | 类型   | 必选 | 说明     |
+| ------------- | ------ | ------ | ---- | -------- |
+| id            | query  | string | 是   | 元信息id |
+| Authorization | header | string | 是   | none     |
 
 > 返回示例
 
@@ -123,29 +123,29 @@ GET /api/admin/meta/get
 
 ### 返回结果
 
-|状态码|状态码含义|说明|数据模型|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
+| 状态码 | 状态码含义                                              | 说明 | 数据模型 |
+| ------ | ------------------------------------------------------- | ---- | -------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline   |
 
 ### 返回数据结构
 
 状态码 **200**
 
-|名称|类型|必选|约束|中文名|说明|
-|---|---|---|---|---|---|
-|» code|integer|true|none|状态码|none|
-|» message|string|true|none|信息|none|
-|» data|object|true|none||none|
-|»» id|integer|true|none|id|none|
-|»» path|string|true|none|路径|none|
-|»» password|string|true|none|密码|none|
-|»» p_sub|boolean|true|none|密码是否应用到子文件夹|none|
-|»» write|boolean|true|none|开启写入|none|
-|»» w_sub|boolean|true|none|开启写入是否应用到子文件夹|none|
-|»» hide|string|true|none|隐藏|none|
-|»» h_sub|boolean|true|none|隐藏是否应用到子文件夹|none|
-|»» readme|string|true|none|说明|none|
-|»» r_sub|boolean|true|none|说明是否应用到子文件夹|none|
+| 名称        | 类型    | 必选 | 约束 | 中文名                     | 说明 |
+| ----------- | ------- | ---- | ---- | -------------------------- | ---- |
+| » code      | integer | true | none | 状态码                     | none |
+| » message   | string  | true | none | 信息                       | none |
+| » data      | object  | true | none |                            | none |
+| »» id       | integer | true | none | id                         | none |
+| »» path     | string  | true | none | 路径                       | none |
+| »» password | string  | true | none | 密码                       | none |
+| »» p_sub    | boolean | true | none | 密码是否应用到子文件夹     | none |
+| »» write    | boolean | true | none | 开启写入                   | none |
+| »» w_sub    | boolean | true | none | 开启写入是否应用到子文件夹 | none |
+| »» hide     | string  | true | none | 隐藏                       | none |
+| »» h_sub    | boolean | true | none | 隐藏是否应用到子文件夹     | none |
+| »» readme   | string  | true | none | 说明                       | none |
+| »» r_sub    | boolean | true | none | 说明是否应用到子文件夹     | none |
 
 ## POST 新增元信息
 
@@ -170,20 +170,20 @@ POST /api/admin/meta/create
 
 ### 请求参数
 
-|名称|位置|类型|必选|中文名|说明|
-|---|---|---|---|---|---|
-|Authorization|header|string| 是 ||none|
-|body|body|object| 否 ||none|
-|» id|body|integer| 是 | id|none|
-|» path|body|string| 是 | 路径|none|
-|» password|body|string| 是 | 密码|none|
-|» p_sub|body|boolean| 是 | 密码是否应用到子文件夹|none|
-|» write|body|boolean| 是 | 开启写入|none|
-|» w_sub|body|boolean| 是 | 开启写入是否应用到子文件夹|none|
-|» hide|body|string| 是 | 隐藏|none|
-|» h_sub|body|boolean| 是 | 隐藏是否应用到子文件夹|none|
-|» readme|body|string| 是 | 说明|none|
-|» r_sub|body|boolean| 是 | 说明是否应用到子文件夹|none|
+| 名称          | 位置   | 类型    | 必选 | 中文名                     | 说明 |
+| ------------- | ------ | ------- | ---- | -------------------------- | ---- |
+| Authorization | header | string  | 是   |                            | none |
+| body          | body   | object  | 否   |                            | none |
+| » id          | body   | integer | 是   | id                         | none |
+| » path        | body   | string  | 是   | 路径                       | none |
+| » password    | body   | string  | 是   | 密码                       | none |
+| » p_sub       | body   | boolean | 是   | 密码是否应用到子文件夹     | none |
+| » write       | body   | boolean | 是   | 开启写入                   | none |
+| » w_sub       | body   | boolean | 是   | 开启写入是否应用到子文件夹 | none |
+| » hide        | body   | string  | 是   | 隐藏                       | none |
+| » h_sub       | body   | boolean | 是   | 隐藏是否应用到子文件夹     | none |
+| » readme      | body   | string  | 是   | 说明                       | none |
+| » r_sub       | body   | boolean | 是   | 说明是否应用到子文件夹     | none |
 
 > 返回示例
 
@@ -199,19 +199,19 @@ POST /api/admin/meta/create
 
 ### 返回结果
 
-|状态码|状态码含义|说明|数据模型|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
+| 状态码 | 状态码含义                                              | 说明 | 数据模型 |
+| ------ | ------------------------------------------------------- | ---- | -------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline   |
 
 ### 返回数据结构
 
 状态码 **200**
 
-|名称|类型|必选|约束|中文名|说明|
-|---|---|---|---|---|---|
-|» code|integer|true|none||none|
-|» message|string|true|none||none|
-|» data|null|true|none||none|
+| 名称      | 类型    | 必选 | 约束 | 中文名 | 说明 |
+| --------- | ------- | ---- | ---- | ------ | ---- |
+| » code    | integer | true | none |        | none |
+| » message | string  | true | none |        | none |
+| » data    | null    | true | none |        | none |
 
 ## POST 更新元信息
 
@@ -236,20 +236,20 @@ POST /api/admin/meta/update
 
 ### 请求参数
 
-|名称|位置|类型|必选|中文名|说明|
-|---|---|---|---|---|---|
-|Authorization|header|string| 是 ||none|
-|body|body|object| 否 ||none|
-|» id|body|integer| 是 | id|none|
-|» path|body|string| 是 | 路径|none|
-|» password|body|string| 是 | 密码|none|
-|» p_sub|body|boolean| 是 | 密码是否应用到子文件夹|none|
-|» write|body|boolean| 是 | 开启写入|none|
-|» w_sub|body|boolean| 是 | 开启写入是否应用到子文件夹|none|
-|» hide|body|string| 是 | 隐藏|none|
-|» h_sub|body|boolean| 是 | 隐藏是否应用到子文件夹|none|
-|» readme|body|string| 是 | 说明|none|
-|» r_sub|body|boolean| 是 | 说明是否应用到子文件夹|none|
+| 名称          | 位置   | 类型    | 必选 | 中文名                     | 说明 |
+| ------------- | ------ | ------- | ---- | -------------------------- | ---- |
+| Authorization | header | string  | 是   |                            | none |
+| body          | body   | object  | 否   |                            | none |
+| » id          | body   | integer | 是   | id                         | none |
+| » path        | body   | string  | 是   | 路径                       | none |
+| » password    | body   | string  | 是   | 密码                       | none |
+| » p_sub       | body   | boolean | 是   | 密码是否应用到子文件夹     | none |
+| » write       | body   | boolean | 是   | 开启写入                   | none |
+| » w_sub       | body   | boolean | 是   | 开启写入是否应用到子文件夹 | none |
+| » hide        | body   | string  | 是   | 隐藏                       | none |
+| » h_sub       | body   | boolean | 是   | 隐藏是否应用到子文件夹     | none |
+| » readme      | body   | string  | 是   | 说明                       | none |
+| » r_sub       | body   | boolean | 是   | 说明是否应用到子文件夹     | none |
 
 > 返回示例
 
@@ -265,30 +265,30 @@ POST /api/admin/meta/update
 
 ### 返回结果
 
-|状态码|状态码含义|说明|数据模型|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
+| 状态码 | 状态码含义                                              | 说明 | 数据模型 |
+| ------ | ------------------------------------------------------- | ---- | -------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline   |
 
 ### 返回数据结构
 
 状态码 **200**
 
-|名称|类型|必选|约束|中文名|说明|
-|---|---|---|---|---|---|
-|» code|integer|true|none||none|
-|» message|string|true|none||none|
-|» data|null|true|none||none|
+| 名称      | 类型    | 必选 | 约束 | 中文名 | 说明 |
+| --------- | ------- | ---- | ---- | ------ | ---- |
+| » code    | integer | true | none |        | none |
+| » message | string  | true | none |        | none |
+| » data    | null    | true | none |        | none |
 
 ## POST 删除元信息
 
 POST /api/admin/meta/delete
 
 ### 请求参数
 
-|名称|位置|类型|必选|中文名|说明|
-|---|---|---|---|---|---|
-|id|query|string| 是 ||none|
-|Authorization|header|string| 是 ||none|
+| 名称          | 位置   | 类型   | 必选 | 中文名 | 说明 |
+| ------------- | ------ | ------ | ---- | ------ | ---- |
+| id            | query  | string | 是   |        | none |
+| Authorization | header | string | 是   |        | none |
 
 > 返回示例
 
@@ -304,19 +304,16 @@ POST /api/admin/meta/delete
 
 ### 返回结果
 
-|状态码|状态码含义|说明|数据模型|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
+| 状态码 | 状态码含义                                              | 说明 | 数据模型 |
+| ------ | ------------------------------------------------------- | ---- | -------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline   |
 
 ### 返回数据结构
 
 状态码 **200**
 
-|名称|类型|必选|约束|中文名|说明|
-|---|---|---|---|---|---|
-|» code|integer|true|none|状态码|none|
-|» message|string|true|none|信息|none|
-|» data|null|true|none||none|
-
-# 数据模型
-
+| 名称      | 类型    | 必选 | 约束 | 中文名 | 说明 |
+| --------- | ------- | ---- | ---- | ------ | ---- |
+| » code    | integer | true | none | 状态码 | none |
+| » message | string  | true | none | 信息   | none |
+| » data    | null    | true | none |        | none |