Skip to content

Commit 763bde5

Browse files
authored
Docs: add task info api and format (#315)
1 parent c722025 commit 763bde5

20 files changed

+5823
-5684
lines changed

docs/guide/api/admin/driver.md

+1,283-1,286
Large diffs are not rendered by default.

docs/guide/api/admin/meta.md

+103-106
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ GET /api/admin/meta/list
2525

2626
### 请求参数
2727

28-
|名称|位置|类型|必选|说明|
29-
|---|---|---|---|---|
30-
|page|query|string||页数|
31-
|per_page|query|string||每页个数|
32-
|Authorization|header|string||none|
28+
| 名称 | 位置 | 类型 | 必选 | 说明 |
29+
| ------------- | ------ | ------ | ---- | -------- |
30+
| page | query | string | | 页数 |
31+
| per_page | query | string | | 每页个数 |
32+
| Authorization | header | string | | none |
3333

3434
> 返回示例
3535
@@ -61,42 +61,42 @@ GET /api/admin/meta/list
6161

6262
### 返回结果
6363

64-
|状态码|状态码含义|说明|数据模型|
65-
|---|---|---|---|
66-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
64+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
65+
| ------ | ------------------------------------------------------- | ---- | -------- |
66+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
6767

6868
### 返回数据结构
6969

7070
状态码 **200**
7171

72-
|名称|类型|必选|约束|中文名|说明|
73-
|---|---|---|---|---|---|
74-
|» code|integer|true|none|状态码|none|
75-
|» message|string|true|none|信息|none|
76-
|» data|object|true|none|数据|none|
77-
|»» content|[object]|true|none|内容|none|
78-
|»»» id|integer|false|none|id|none|
79-
|»»» path|string|false|none|路径|none|
80-
|»»» password|string|false|none|密码|none|
81-
|»»» p_sub|boolean|false|none|密码是否应用到子文件夹|none|
82-
|»»» write|boolean|false|none|是否允许写入|none|
83-
|»»» w_sub|boolean|false|none|是否允许写入引用到子文件夹|none|
84-
|»»» hide|string|false|none|隐藏|none|
85-
|»»» h_sub|boolean|false|none|隐藏是否应用到子文件夹|none|
86-
|»»» readme|string|false|none|说明|none|
87-
|»»» r_sub|boolean|false|none|说明是否应用到子文件夹|none|
88-
|»» total|integer|true|none|总数|none|
72+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
73+
| ------------ | -------- | ----- | ---- | -------------------------- | ---- |
74+
| » code | integer | true | none | 状态码 | none |
75+
| » message | string | true | none | 信息 | none |
76+
| » data | object | true | none | 数据 | none |
77+
| »» content | [object] | true | none | 内容 | none |
78+
| »»» id | integer | false | none | id | none |
79+
| »»» path | string | false | none | 路径 | none |
80+
| »»» password | string | false | none | 密码 | none |
81+
| »»» p_sub | boolean | false | none | 密码是否应用到子文件夹 | none |
82+
| »»» write | boolean | false | none | 是否允许写入 | none |
83+
| »»» w_sub | boolean | false | none | 是否允许写入引用到子文件夹 | none |
84+
| »»» hide | string | false | none | 隐藏 | none |
85+
| »»» h_sub | boolean | false | none | 隐藏是否应用到子文件夹 | none |
86+
| »»» readme | string | false | none | 说明 | none |
87+
| »»» r_sub | boolean | false | none | 说明是否应用到子文件夹 | none |
88+
| »» total | integer | true | none | 总数 | none |
8989

9090
## GET 获取元信息
9191

9292
GET /api/admin/meta/get
9393

9494
### 请求参数
9595

96-
|名称|位置|类型|必选|说明|
97-
|---|---|---|---|---|
98-
|id|query|string||元信息id|
99-
|Authorization|header|string||none|
96+
| 名称 | 位置 | 类型 | 必选 | 说明 |
97+
| ------------- | ------ | ------ | ---- | -------- |
98+
| id | query | string | | 元信息id |
99+
| Authorization | header | string | | none |
100100

101101
> 返回示例
102102
@@ -123,29 +123,29 @@ GET /api/admin/meta/get
123123

124124
### 返回结果
125125

126-
|状态码|状态码含义|说明|数据模型|
127-
|---|---|---|---|
128-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
126+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
127+
| ------ | ------------------------------------------------------- | ---- | -------- |
128+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
129129

130130
### 返回数据结构
131131

132132
状态码 **200**
133133

134-
|名称|类型|必选|约束|中文名|说明|
135-
|---|---|---|---|---|---|
136-
|» code|integer|true|none|状态码|none|
137-
|» message|string|true|none|信息|none|
138-
|» data|object|true|none||none|
139-
|»» id|integer|true|none|id|none|
140-
|»» path|string|true|none|路径|none|
141-
|»» password|string|true|none|密码|none|
142-
|»» p_sub|boolean|true|none|密码是否应用到子文件夹|none|
143-
|»» write|boolean|true|none|开启写入|none|
144-
|»» w_sub|boolean|true|none|开启写入是否应用到子文件夹|none|
145-
|»» hide|string|true|none|隐藏|none|
146-
|»» h_sub|boolean|true|none|隐藏是否应用到子文件夹|none|
147-
|»» readme|string|true|none|说明|none|
148-
|»» r_sub|boolean|true|none|说明是否应用到子文件夹|none|
134+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
135+
| ----------- | ------- | ---- | ---- | -------------------------- | ---- |
136+
| » code | integer | true | none | 状态码 | none |
137+
| » message | string | true | none | 信息 | none |
138+
| » data | object | true | none | | none |
139+
| »» id | integer | true | none | id | none |
140+
| »» path | string | true | none | 路径 | none |
141+
| »» password | string | true | none | 密码 | none |
142+
| »» p_sub | boolean | true | none | 密码是否应用到子文件夹 | none |
143+
| »» write | boolean | true | none | 开启写入 | none |
144+
| »» w_sub | boolean | true | none | 开启写入是否应用到子文件夹 | none |
145+
| »» hide | string | true | none | 隐藏 | none |
146+
| »» h_sub | boolean | true | none | 隐藏是否应用到子文件夹 | none |
147+
| »» readme | string | true | none | 说明 | none |
148+
| »» r_sub | boolean | true | none | 说明是否应用到子文件夹 | none |
149149

150150
## POST 新增元信息
151151

@@ -170,20 +170,20 @@ POST /api/admin/meta/create
170170

171171
### 请求参数
172172

173-
|名称|位置|类型|必选|中文名|说明|
174-
|---|---|---|---|---|---|
175-
|Authorization|header|string|||none|
176-
|body|body|object|||none|
177-
|» id|body|integer|| id|none|
178-
|» path|body|string|| 路径|none|
179-
|» password|body|string|| 密码|none|
180-
|» p_sub|body|boolean|| 密码是否应用到子文件夹|none|
181-
|» write|body|boolean|| 开启写入|none|
182-
|» w_sub|body|boolean|| 开启写入是否应用到子文件夹|none|
183-
|» hide|body|string|| 隐藏|none|
184-
|» h_sub|body|boolean|| 隐藏是否应用到子文件夹|none|
185-
|» readme|body|string|| 说明|none|
186-
|» r_sub|body|boolean|| 说明是否应用到子文件夹|none|
173+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
174+
| ------------- | ------ | ------- | ---- | -------------------------- | ---- |
175+
| Authorization | header | string | | | none |
176+
| body | body | object | | | none |
177+
| » id | body | integer | | id | none |
178+
| » path | body | string | | 路径 | none |
179+
| » password | body | string | | 密码 | none |
180+
| » p_sub | body | boolean | | 密码是否应用到子文件夹 | none |
181+
| » write | body | boolean | | 开启写入 | none |
182+
| » w_sub | body | boolean | | 开启写入是否应用到子文件夹 | none |
183+
| » hide | body | string | | 隐藏 | none |
184+
| » h_sub | body | boolean | | 隐藏是否应用到子文件夹 | none |
185+
| » readme | body | string | | 说明 | none |
186+
| » r_sub | body | boolean | | 说明是否应用到子文件夹 | none |
187187

188188
> 返回示例
189189
@@ -199,19 +199,19 @@ POST /api/admin/meta/create
199199

200200
### 返回结果
201201

202-
|状态码|状态码含义|说明|数据模型|
203-
|---|---|---|---|
204-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
202+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
203+
| ------ | ------------------------------------------------------- | ---- | -------- |
204+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
205205

206206
### 返回数据结构
207207

208208
状态码 **200**
209209

210-
|名称|类型|必选|约束|中文名|说明|
211-
|---|---|---|---|---|---|
212-
|» code|integer|true|none||none|
213-
|» message|string|true|none||none|
214-
|» data|null|true|none||none|
210+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
211+
| --------- | ------- | ---- | ---- | ------ | ---- |
212+
| » code | integer | true | none | | none |
213+
| » message | string | true | none | | none |
214+
| » data | null | true | none | | none |
215215

216216
## POST 更新元信息
217217

@@ -236,20 +236,20 @@ POST /api/admin/meta/update
236236

237237
### 请求参数
238238

239-
|名称|位置|类型|必选|中文名|说明|
240-
|---|---|---|---|---|---|
241-
|Authorization|header|string|||none|
242-
|body|body|object|||none|
243-
|» id|body|integer|| id|none|
244-
|» path|body|string|| 路径|none|
245-
|» password|body|string|| 密码|none|
246-
|» p_sub|body|boolean|| 密码是否应用到子文件夹|none|
247-
|» write|body|boolean|| 开启写入|none|
248-
|» w_sub|body|boolean|| 开启写入是否应用到子文件夹|none|
249-
|» hide|body|string|| 隐藏|none|
250-
|» h_sub|body|boolean|| 隐藏是否应用到子文件夹|none|
251-
|» readme|body|string|| 说明|none|
252-
|» r_sub|body|boolean|| 说明是否应用到子文件夹|none|
239+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
240+
| ------------- | ------ | ------- | ---- | -------------------------- | ---- |
241+
| Authorization | header | string | | | none |
242+
| body | body | object | | | none |
243+
| » id | body | integer | | id | none |
244+
| » path | body | string | | 路径 | none |
245+
| » password | body | string | | 密码 | none |
246+
| » p_sub | body | boolean | | 密码是否应用到子文件夹 | none |
247+
| » write | body | boolean | | 开启写入 | none |
248+
| » w_sub | body | boolean | | 开启写入是否应用到子文件夹 | none |
249+
| » hide | body | string | | 隐藏 | none |
250+
| » h_sub | body | boolean | | 隐藏是否应用到子文件夹 | none |
251+
| » readme | body | string | | 说明 | none |
252+
| » r_sub | body | boolean | | 说明是否应用到子文件夹 | none |
253253

254254
> 返回示例
255255
@@ -265,30 +265,30 @@ POST /api/admin/meta/update
265265

266266
### 返回结果
267267

268-
|状态码|状态码含义|说明|数据模型|
269-
|---|---|---|---|
270-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
268+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
269+
| ------ | ------------------------------------------------------- | ---- | -------- |
270+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
271271

272272
### 返回数据结构
273273

274274
状态码 **200**
275275

276-
|名称|类型|必选|约束|中文名|说明|
277-
|---|---|---|---|---|---|
278-
|» code|integer|true|none||none|
279-
|» message|string|true|none||none|
280-
|» data|null|true|none||none|
276+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
277+
| --------- | ------- | ---- | ---- | ------ | ---- |
278+
| » code | integer | true | none | | none |
279+
| » message | string | true | none | | none |
280+
| » data | null | true | none | | none |
281281

282282
## POST 删除元信息
283283

284284
POST /api/admin/meta/delete
285285

286286
### 请求参数
287287

288-
|名称|位置|类型|必选|中文名|说明|
289-
|---|---|---|---|---|---|
290-
|id|query|string|||none|
291-
|Authorization|header|string|||none|
288+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
289+
| ------------- | ------ | ------ | ---- | ------ | ---- |
290+
| id | query | string | | | none |
291+
| Authorization | header | string | | | none |
292292

293293
> 返回示例
294294
@@ -304,19 +304,16 @@ POST /api/admin/meta/delete
304304

305305
### 返回结果
306306

307-
|状态码|状态码含义|说明|数据模型|
308-
|---|---|---|---|
309-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline|
307+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
308+
| ------ | ------------------------------------------------------- | ---- | -------- |
309+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
310310

311311
### 返回数据结构
312312

313313
状态码 **200**
314314

315-
|名称|类型|必选|约束|中文名|说明|
316-
|---|---|---|---|---|---|
317-
|» code|integer|true|none|状态码|none|
318-
|» message|string|true|none|信息|none|
319-
|» data|null|true|none||none|
320-
321-
# 数据模型
322-
315+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
316+
| --------- | ------- | ---- | ---- | ------ | ---- |
317+
| » code | integer | true | none | 状态码 | none |
318+
| » message | string | true | none | 信息 | none |
319+
| » data | null | true | none | | none |

0 commit comments

Comments
 (0)