Skip to content

Commit a53e87c

Browse files
committed
update
1 parent d00a3fd commit a53e87c

File tree

4 files changed

+110
-2
lines changed

4 files changed

+110
-2
lines changed

api/project/member-del.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
系统管理员或工程管理员可操作
44

5-
65
## URI
76

87
```

api/project/update-status.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# 更新工程状态
2+
3+
更新status。系统管理员或工程管理员可操作
4+
5+
## URI
6+
7+
```
8+
/projects/:id/status
9+
```
10+
11+
## 请求方式
12+
13+
```
14+
POST
15+
```
16+
17+
## 包头
18+
19+
```
20+
Authorization: Bearer <token>
21+
```
22+
23+
## 请求参数
24+
25+
| key | 类型 | 是否必须 | 说明 | 备注 | 例子 |
26+
| --- | --- | --- | --- | --- | --- |
27+
| :id | string || 工程 ID | | |
28+
| status | int || 工程状态 | | |
29+
30+
## 成功
31+
32+
### 成功返回状态码
33+
34+
| 状态码 | 说明 | 备注 |
35+
| --- | --- | --- |
36+
| 204 | 成功 | 无返回数据 |
37+
38+
## 失败
39+
40+
### 失败返回状态码
41+
42+
| 状态码 | 说明 | 备注 |
43+
| --- | --- | --- |
44+
| 401 | token 失效 | |
45+
| 403 | 无权限访问工程 | |
46+
| 422 | status 有误/工程不存在 | |
47+
| 500 | 服务器内部错误 | |
48+
49+
### 失败返回数据实例
50+
51+
```json
52+
{
53+
"message": "token 失效"
54+
}
55+
```

api/user/profile.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# 获取用户信息
2+
3+
获取用户信息,只有管理员能调用
4+
5+
## URI
6+
7+
```
8+
/users/:id/profile
9+
```
10+
11+
## 请求方式
12+
13+
```
14+
GET
15+
```
16+
17+
## 包头
18+
19+
```
20+
Authorization: Bearer <token>
21+
```
22+
23+
## 请求参数
24+
25+
| key | 类型 | 是否必须 | 说明 | 备注 | 例子 |
26+
| --- | --- | --- | --- | --- | --- |
27+
| :id | string || 用户 ID | | |
28+
29+
## 成功
30+
31+
### 成功返回状态码
32+
33+
| 状态码 | 说明 | 备注 |
34+
| --- | --- | --- |
35+
| 200 | 获取成功 | 返回无密码的 [User](../../table/user.md) |
36+
37+
## 失败
38+
39+
### 失败返回数据
40+
41+
| 状态码 | 说明 | 备注 |
42+
| --- | --- | --- |
43+
| 401 | token 失效 | |
44+
| 403 | 无权限 | |
45+
| 422 | 用户不存在 | |
46+
| 500 | 服务器内部错误 | |
47+
48+
### 失败返回数据实例
49+
50+
```json
51+
{
52+
"message": "token 失效"
53+
}
54+
```

api/user/update-status.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Authorization: Bearer <token>
4444
| 400 | 请求参数错误 | |
4545
| 401 | token 失效 | |
4646
| 403 | 无权限修改用户状态 | |
47-
| 404 | 用户不存在 | |
47+
| 422 | status有误/用户不存在 | |
4848
| 500 | 服务器内部错误 | |
4949

5050
### 失败返回数据实例

0 commit comments

Comments
 (0)