Skip to content

Commit d3dfe6c

Browse files
KirCuteKirCute
authored
docs(sftp-server): update docs (#395)
* docs(sftp-server): update docs * fix
1 parent d1b61cd commit d3dfe6c

File tree

4 files changed

+461
-1
lines changed

4 files changed

+461
-1
lines changed

‎docs/guide/api/admin/user.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,3 +397,90 @@ POST /api/admin/user/del_cache
397397
| » code | integer | true | none | 状态码 | none |
398398
| » message | string | true | none | 信息 | none |
399399
| » data | null | true | none | | none |
400+
401+
## GET 列出用户的 SFTP 公钥
402+
403+
GET /api/admin/user/sshkey/list
404+
405+
### 请求参数
406+
407+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
408+
| ------------- | ------ | ------ | ---- | ------ | ---- |
409+
| Authorization | header | string | 是 | | none |
410+
| uid | query | string | 是 | 用户id | none |
411+
412+
### 返回示例
413+
414+
> 成功
415+
416+
```json
417+
{
418+
"code": 200,
419+
"message": "success",
420+
"data": {
421+
"content": [
422+
{
423+
"id": 1,
424+
"title": "Test-SSH-Key",
425+
"fingerprint": "SHA256:aAFI5C******************************KD6hYhs",
426+
"added_time": "2024-12-15T20:09:28.1777368+08:00",
427+
"last_used_time": "2024-12-15T20:10:07.7846528+08:00"
428+
},
429+
{
430+
"id": 2,
431+
"title": "Test-SSH-Key-2",
432+
"fingerprint": "SHA256:P2zrSs******************************h0Q5BOQ",
433+
"added_time": "2024-12-20T20:09:28.1777368+08:00",
434+
"last_used_time": "2024-12-25T20:10:07.7846528+08:00"
435+
},
436+
],
437+
"total": 2
438+
}
439+
}
440+
```
441+
442+
### 返回结果
443+
444+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
445+
| ------ | ------------------------------------------------------- | ---- | -------- |
446+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
447+
448+
### 返回数据结构
449+
450+
状态码 **200**
451+
452+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
453+
| ------------- | ------- | ---- | ---- | ---------------- | ---- |
454+
| » code | integer | true | none | 状态码 | none |
455+
| » message | string | true | none | 信息 | none |
456+
| » data | object | true | none | 数据 | none |
457+
| »» content | [object] | true | none | | none |
458+
| »»» id | integer | true | none | 公钥主键 | none |
459+
| »»» title | string | true | none | 公钥名称 | none |
460+
| »»» fingerprint | string | true | none | 公钥指纹 | none |
461+
| »»» added_time | string | true | none | 添加时间 | none |
462+
| »»» last_used_time | string | true | none | 上次认证时间 | none |
463+
| »» total | integer | true | none | 总数 | none |
464+
465+
## POST 删除用户的 SFTP 公钥
466+
467+
POST /api/admin/user/sshkey/delete
468+
469+
### 请求参数
470+
471+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
472+
| ------------- | ------ | ------ | ---- | ------ | ---- |
473+
| Authorization | header | string | 是 | | none |
474+
| id | query | integer | 是 | 公钥主键 | none |
475+
476+
### 返回示例
477+
478+
> 成功
479+
480+
```json
481+
{
482+
"code": 200,
483+
"message": "success",
484+
"data": null
485+
}
486+
```

‎docs/guide/api/auth.md

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,3 +277,146 @@ GET /api/me
277277
| »» permission | integer | true | none | 权限 | none |
278278
| »» sso_id | string | true | none | sso id | none |
279279
| »» otp | boolean | true | none | 是否开启二步验证 | none |
280+
281+
## GET 列出当前用户 SFTP 公钥
282+
283+
GET /api/me/sshkey/list
284+
285+
### 请求参数
286+
287+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
288+
| ------------- | ------ | ------ | ---- | ------ | ---- |
289+
| Authorization | header | string | 是 | | none |
290+
291+
### 返回示例
292+
293+
> 成功
294+
295+
```json
296+
{
297+
"code": 200,
298+
"message": "success",
299+
"data": {
300+
"content": [
301+
{
302+
"id": 1,
303+
"title": "Test-SSH-Key",
304+
"fingerprint": "SHA256:aAFI5C******************************KD6hYhs",
305+
"added_time": "2024-12-15T20:09:28.1777368+08:00",
306+
"last_used_time": "2024-12-15T20:10:07.7846528+08:00"
307+
},
308+
{
309+
"id": 2,
310+
"title": "Test-SSH-Key-2",
311+
"fingerprint": "SHA256:P2zrSs******************************h0Q5BOQ",
312+
"added_time": "2024-12-20T20:09:28.1777368+08:00",
313+
"last_used_time": "2024-12-25T20:10:07.7846528+08:00"
314+
},
315+
],
316+
"total": 2
317+
}
318+
}
319+
```
320+
321+
### 返回结果
322+
323+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
324+
| ------ | ------------------------------------------------------- | ---- | -------- |
325+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
326+
327+
### 返回数据结构
328+
329+
状态码 **200**
330+
331+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
332+
| ------------- | ------- | ---- | ---- | ---------------- | ---- |
333+
| » code | integer | true | none | 状态码 | none |
334+
| » message | string | true | none | 信息 | none |
335+
| » data | object | true | none | 数据 | none |
336+
| »» content | [object] | true | none | | none |
337+
| »»» id | integer | true | none | 公钥主键 | none |
338+
| »»» title | string | true | none | 公钥名称 | none |
339+
| »»» fingerprint | string | true | none | 公钥指纹 | none |
340+
| »»» added_time | string | true | none | 添加时间 | none |
341+
| »»» last_used_time | string | true | none | 上次认证时间 | none |
342+
| »» total | integer | true | none | 总数 | none |
343+
344+
## POST 给当前用户添加 SFTP 公钥
345+
346+
POST /api/me/sshkey/add
347+
348+
### 请求参数
349+
350+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
351+
| ------------- | ------ | ------ | ---- | ------ | ---- |
352+
| Authorization | header | string | 是 | | none |
353+
| body | body | object | 否 | | none |
354+
| » title | body | string | 是 | 公钥名 | none |
355+
| » key | body | string | 是 | 公钥内容 | none |
356+
357+
### 返回示例
358+
359+
> 成功
360+
361+
```json
362+
{
363+
"code": 200,
364+
"message": "success",
365+
"data": null
366+
}
367+
```
368+
369+
### 返回结果
370+
371+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
372+
| ------ | ------------------------------------------------------- | ---- | -------- |
373+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
374+
375+
### 返回数据结构
376+
377+
状态码 **200**
378+
379+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
380+
| ------------- | ------- | ---- | ---- | ---------------- | ---- |
381+
| » code | integer | true | none | 状态码 | none |
382+
| » message | string | true | none | 信息 | none |
383+
| » data | null | true | none | | none |
384+
385+
## POST 删除当前用户的 SFTP 公钥
386+
387+
POST /api/me/sshkey/delete
388+
389+
### 请求参数
390+
391+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
392+
| ------------- | ------ | ------ | ---- | ------ | ---- |
393+
| Authorization | header | string | 是 | | none |
394+
| id | query | integer | 是 | 公钥主键 | none |
395+
396+
### 返回示例
397+
398+
> 成功
399+
400+
```json
401+
{
402+
"code": 200,
403+
"message": "success",
404+
"data": null
405+
}
406+
```
407+
408+
### 返回结果
409+
410+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
411+
| ------ | ------------------------------------------------------- | ---- | -------- |
412+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
413+
414+
### 返回数据结构
415+
416+
状态码 **200**
417+
418+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
419+
| ------------- | ------- | ---- | ---- | ---------------- | ---- |
420+
| » code | integer | true | none | 状态码 | none |
421+
| » message | string | true | none | 信息 | none |
422+
| » data | null | true | none | | none |

‎docs/zh/guide/api/admin/user.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,3 +397,90 @@ POST /api/admin/user/del_cache
397397
| » code | integer | true | none | 状态码 | none |
398398
| » message | string | true | none | 信息 | none |
399399
| » data | null | true | none | | none |
400+
401+
## GET 列出用户的 SFTP 公钥
402+
403+
GET /api/admin/user/sshkey/list
404+
405+
### 请求参数
406+
407+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
408+
| ------------- | ------ | ------ | ---- | ------ | ---- |
409+
| Authorization | header | string | 是 | | none |
410+
| uid | query | string | 是 | 用户id | none |
411+
412+
### 返回示例
413+
414+
> 成功
415+
416+
```json
417+
{
418+
"code": 200,
419+
"message": "success",
420+
"data": {
421+
"content": [
422+
{
423+
"id": 1,
424+
"title": "Test-SSH-Key",
425+
"fingerprint": "SHA256:aAFI5C******************************KD6hYhs",
426+
"added_time": "2024-12-15T20:09:28.1777368+08:00",
427+
"last_used_time": "2024-12-15T20:10:07.7846528+08:00"
428+
},
429+
{
430+
"id": 2,
431+
"title": "Test-SSH-Key-2",
432+
"fingerprint": "SHA256:P2zrSs******************************h0Q5BOQ",
433+
"added_time": "2024-12-20T20:09:28.1777368+08:00",
434+
"last_used_time": "2024-12-25T20:10:07.7846528+08:00"
435+
},
436+
],
437+
"total": 2
438+
}
439+
}
440+
```
441+
442+
### 返回结果
443+
444+
| 状态码 | 状态码含义 | 说明 | 数据模型 |
445+
| ------ | ------------------------------------------------------- | ---- | -------- |
446+
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline |
447+
448+
### 返回数据结构
449+
450+
状态码 **200**
451+
452+
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
453+
| ------------- | ------- | ---- | ---- | ---------------- | ---- |
454+
| » code | integer | true | none | 状态码 | none |
455+
| » message | string | true | none | 信息 | none |
456+
| » data | object | true | none | 数据 | none |
457+
| »» content | [object] | true | none | | none |
458+
| »»» id | integer | true | none | 公钥主键 | none |
459+
| »»» title | string | true | none | 公钥名称 | none |
460+
| »»» fingerprint | string | true | none | 公钥指纹 | none |
461+
| »»» added_time | string | true | none | 添加时间 | none |
462+
| »»» last_used_time | string | true | none | 上次认证时间 | none |
463+
| »» total | integer | true | none | 总数 | none |
464+
465+
## POST 删除用户的 SFTP 公钥
466+
467+
POST /api/admin/user/sshkey/delete
468+
469+
### 请求参数
470+
471+
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
472+
| ------------- | ------ | ------ | ---- | ------ | ---- |
473+
| Authorization | header | string | 是 | | none |
474+
| id | query | integer | 是 | 公钥主键 | none |
475+
476+
### 返回示例
477+
478+
> 成功
479+
480+
```json
481+
{
482+
"code": 200,
483+
"message": "success",
484+
"data": null
485+
}
486+
```

0 commit comments

Comments
 (0)