Skip to content

Commit e574138

Browse files
greedbellgreedbell
committed
release version
1 parent 635d28b commit e574138

30 files changed

+238
-69
lines changed

‎api/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@
2424

2525
请求的头
2626

27+
### Content-Type
28+
29+
请求数据格式
30+
31+
```
32+
Content-Type: application/json
33+
```
34+
2735
### Accept
2836

2937
发送端（客户端）希望接受的数据类型
@@ -95,8 +103,8 @@ eg:
95103

96104
| key | 说明 | 备注 |
97105
| --- | --- | --- |
98-
| iat | token 发布时间 | 单位/秒 |
99-
| exp | token 有效期 | 单位/秒 |
106+
| iat | token 发布时间 | 单位/毫秒 |
107+
| exp | token 有效期 | 单位/毫秒 |
100108
| id | 用户 ID | |
101109
| scope | token 权限 | [详细说明](#scope) |
102110

‎api/patch/add.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ Authorization: Bearer <token>
2626
| --- | --- | --- | --- | --- | --- |
2727
| :project | string | 是 | 工程 ID | | |
2828
| client | string | 是 | 终端类型 | | |
29-
| app_version | string | 是 | 应用版本 | | |
30-
| patch_version | string | 否 | 当前补丁版本号 | 和 app_version 对应 | |
31-
| hash | string | 补丁 hash 值 | | |
32-
| patch_url | string | 补丁下载地址 | | |
29+
| project_version | string | 是 | 工程版本 | | |
30+
| patch_version | string | 是 | 当前补丁版本号 | 和 app_version 对应 | |
31+
| hash | string | 是 | 补丁 hash 值 | | |
32+
| patch_url | string | 是 | 补丁下载地址 | | |
3333

3434
## 成功
3535

@@ -44,26 +44,22 @@ Authorization: Bearer <token>
4444
| key | 类型 | 说明 | 备注 | 例子 |
4545
| --- | --- | --- | --- | --- |
4646
| id | string | 补丁 ID | | |
47-
| bundle_id | string | 应用标识符 | | |
48-
| client | string | 终端类型 | | |
49-
| app_version | string | 应用版本 | | |
47+
| project_id | string | 工程 ID | | |
48+
| project_version | string | 工程版本 | | |
5049
| patch_version | string | 最新补丁版本号 | | |
5150
| hash | string | 补丁 hash 值 | | |
5251
| patch_url | string | 补丁下载地址 | | |
53-
| timestamp | int | 创建时间 | | |
5452

5553
### 成功返回数据实例
5654

5755
```json
5856
{
5957
"id": "DSF565ew",
60-
"bundle_id": "com.greedlab.greedpatch",
61-
"client": "ios",
62-
"app_version": "1.0",
58+
"project_id": "DSF565ew",
59+
"project_version": "1.0",
6360
"patch_version": "1",
6461
"hash": "FDSJFEIoidwiew12",
65-
"patch_url": "http://www.greedpatch.greedlab.com/patch/XXXXXX.zip",
66-
"timestamp": 234137167
62+
"patch_url": "http://www.greedpatch.greedlab.com/patch/XXXXXX.zip"
6763
}
6864
```
6965

@@ -86,3 +82,9 @@ Authorization: Bearer <token>
8682
"message": "token 失效"
8783
}
8884
```
85+
86+
## example
87+
88+
```
89+
curl -H "Accept: application/vnd.greedlab+json" -H "Content-Type: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X POST -d '{"project_version": "1.0","patch_version": "1", "hash":"hash","patch_url":"patch_url"}' localhost:4002/projects/57bfebadd2dbc1cea6430f8b/patches
90+
```

‎api/patch/check.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
## 请求方式
1212

1313
```
14-
GET
14+
POST
1515
```
1616

1717
## 包头
@@ -24,10 +24,9 @@ Authorization: Bearer <token>
2424

2525
| key | 类型 | 是否必须 | 说明 | 备注 | 例子 |
2626
| --- | --- | --- | --- | --- | --- |
27-
| bundle_id | string | 是 | 应用标识符 | | |
28-
| client | string | 是 | 终端类型 | | |
29-
| app_version | string | 是 | 应用版本 | | |
30-
| patch_version | string | 否 | 当前补丁版本号 | 和 app_version 对应 | |
27+
| project_id | string | 是 | 工程 ID | | |
28+
| project_version | string | 是 | 工程版本 | | |
29+
| patch_version | string | 否 | 当前补丁版本号 | 和 project_version 对应 | |
3130

3231
## 成功
3332

@@ -38,24 +37,24 @@ Authorization: Bearer <token>
3837
| 200 | 有补丁 | 有数据返回 |
3938
| 204 | 无补丁 | 不返回任何数据 |
4039

41-
### 有补丁返回数据
40+
### 成功返回数据
4241

4342
| key | 类型 | 说明 | 备注 | 例子 |
4443
| --- | --- | --- | --- | --- |
45-
| bundle_id | string | 应用标识符 | | |
46-
| client | string | 终端类型 | | |
47-
| app_version | string | 应用版本 | | |
44+
| id | string | 补丁 ID | | |
45+
| project_id | string | 工程 ID | | |
46+
| project_version | string | 工程版本 | | |
4847
| patch_version | string | 最新补丁版本号 | | |
4948
| hash | string | 补丁 hash 值 | | |
5049
| patch_url | string | 补丁下载地址 | | |
5150

52-
### 有补丁返回数据实例
51+
### 成功返回数据实例
5352

5453
```json
5554
{
56-
"bundle_id": "com.greedlab.greedpatch",
57-
"client": "ios",
58-
"app_version": "1.0",
55+
"id": "DSF565ew",
56+
"project_id": "DSF565ew",
57+
"project_version": "1.0",
5958
"patch_version": "1",
6059
"hash": "FDSJFEIoidwiew12",
6160
"patch_url": "http://www.greedpatch.greedlab.com/patch/XXXXXX.zip"
@@ -81,3 +80,9 @@ Authorization: Bearer <token>
8180
"message": "bundle_id 不存在"
8281
}
8382
```
83+
84+
## example
85+
86+
```
87+
curl -H "Accept: application/vnd.greedlab+json" -H "Content-Type: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X POST -d '{"project_id":"57bfebadd2dbc1cea6430f8b","project_version":"1.0"}' localhost:4002/patches/check
88+
```

‎api/patch/del.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,9 @@ Authorization: Bearer <token>
5252
"message": "删除失败"
5353
}
5454
```
55+
56+
## example
57+
58+
```
59+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X DELETE localhost:4002/patches/57bff6d74bf68967a8bb1b0f
60+
```

‎api/patch/detail.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,13 @@ Authorization: Bearer <token>
3434
| --- | --- | --- |
3535
| 200 | 获取成功 | |
3636

37-
#### 成功返回数据
37+
### 成功返回数据
3838

3939
| key | 类型 | 说明 | 备注 | 例子 |
4040
| --- | --- | --- | --- | --- |
4141
| id | string | 补丁 ID | | |
42-
| bundle_id | string | 应用标识符 | | |
43-
| client | string | 终端类型 | | |
44-
| app_version | string | 应用版本 | | |
42+
| project_id | string | 工程 ID | | |
43+
| project_version | string | 工程版本 | | |
4544
| patch_version | string | 最新补丁版本号 | | |
4645
| hash | string | 补丁 hash 值 | | |
4746
| patch_url | string | 补丁下载地址 | | |
@@ -51,9 +50,8 @@ Authorization: Bearer <token>
5150
```json
5251
{
5352
"id": "DSF565ew",
54-
"bundle_id": "com.greedlab.greedpatch",
55-
"client": "ios",
56-
"app_version": "1.0",
53+
"project_id": "DSF565ew",
54+
"project_version": "1.0",
5755
"patch_version": "1",
5856
"hash": "FDSJFEIoidwiew12",
5957
"patch_url": "http://www.greedpatch.greedlab.com/patch/XXXXXX.zip"
@@ -78,3 +76,9 @@ Authorization: Bearer <token>
7876
"message": "补丁不存在"
7977
}
8078
```
79+
80+
## example
81+
82+
```
83+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X GET localhost:4002/patches/57bff6d74bf68967a8bb1b0f
84+
```

‎api/patch/list.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,32 +40,25 @@ Authorization: Bearer <token>
4040
| key | 类型 | 说明 | 备注 | 例子 |
4141
| --- | --- | --- | --- | --- |
4242
| id | string | 补丁 ID | | |
43-
| bundle_id | string | 应用标识符 | | |
44-
| client | string | 终端类型 | | |
45-
| app_version | string | 应用版本 | | |
43+
| project_id | string | 工程 ID | | |
44+
| project_version | string | 工程版本 | | |
4645
| patch_version | string | 最新补丁版本号 | | |
4746
| hash | string | 补丁 hash 值 | | |
4847
| patch_url | string | 补丁下载地址 | | |
49-
| timestamp | int | 创建时间 | | |
5048

51-
### 有补丁返回数据实例
49+
### 成功返回数据实例
5250

5351
```json
54-
{
55-
"patches": [
56-
{
57-
"id": "DSF565ew",
58-
"bundle_id": "com.greedlab.greedpatch",
59-
"client": "ios",
60-
"app_version": "1.0",
61-
"patch_version": "1",
62-
"hash": "FDSJFEIoidwiew12",
63-
"patch_url": "http://www.greedpatch.greedlab.com/patch/XXXXXX.zip",
64-
"timestamp": 234137167
65-
}
66-
]
67-
}
68-
52+
[
53+
{
54+
"id": "DSF565ew",
55+
"project_id": "DSF565ew",
56+
"project_version": "1.0",
57+
"patch_version": "1",
58+
"hash": "FDSJFEIoidwiew12",
59+
"patch_url": "http://www.greedpatch.greedlab.com/patch/XXXXXX.zip"
60+
}
61+
]
6962
```
7063

7164
## 失败
@@ -86,3 +79,9 @@ Authorization: Bearer <token>
8679
"message": "工程不存在"
8780
}
8881
```
82+
83+
## example
84+
85+
```
86+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X GET localhost:4002/projects/57bfebadd2dbc1cea6430f8b/patches
87+
```

‎api/permission/get.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## URI
66

77
```
8-
/permissions/:id
8+
/permissions/:type
99
```
1010

1111
## 请求方式
@@ -24,7 +24,7 @@ Authorization: Bearer <token>
2424

2525
| key | 类型 | 是否必须 | 说明 | 备注 | 例子 |
2626
| --- | --- | --- | --- | --- | --- |
27-
| :id | string | 是 | 权限类型 | [详细说明](../../table/permission.md#id) | |
27+
| :type | int | 是 | 权限类型 | [详细说明](../../table/permission.md#type) | |
2828

2929
## 成功
3030

@@ -38,15 +38,15 @@ Authorization: Bearer <token>
3838

3939
| key | 类型 | 说明 | 备注 | 例子 |
4040
| --- | --- | --- | --- | --- |
41-
| id | string | 权限类型 | [详细说明](../../table/permission.md#id) | 0 |
41+
| type | int | 权限类型 | [详细说明](../../table/permission.md#type) | 0 |
4242
| permission | int | 权限 | [详细说明](../../table/permission.md#permission) | 0 |
4343
| domains | array | 限定的邮箱域名 | status=2 时有效 | [greedlab.com] |
4444

4545
### 成功返回数据实例
4646

4747
```json
4848
{
49-
"id": 0,
49+
"type": 0,
5050
"permission": 2,
5151
"domains": [
5252
"greedlab.com"
@@ -72,3 +72,9 @@ Authorization: Bearer <token>
7272
"message": "无权限"
7373
}
7474
```
75+
76+
## example
77+
78+
```
79+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxNzkzOTI4MTgsImV4cCI6MTQ3NDc3MTM5MjgxOCwiaWQiOiI1N2JmYTljZDUwMWMzOTE5YTI1YTdkNGMiLCJzY29wZSI6ImRlZmF1bHQifQ.z1Mm55-ItrO2KZj3Fakvt22JNmqjf2jBMeP-UVA2i7M" -X GET localhost:4002/permissions/1
80+
```

‎api/permission/set.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## URI
66

77
```
8-
/permissions/:id
8+
/permissions/:type
99
```
1010

1111
## 请求方式
@@ -24,7 +24,7 @@ Authorization: Bearer <token>
2424

2525
| key | 类型 | 是否必须 | 说明 | 备注 | 例子 |
2626
| --- | --- | --- | --- | --- | --- |
27-
| :id | string | 是 | 权限类型 | [详细说明](../../table/permission.md#id) | |
27+
| :type | int | 是 | 权限类型 | [详细说明](../../table/permission.md#type) | |
2828
| permission | int | 是 | 权限 | [详细说明](../../table/permission.md#permission) | 0 |
2929
| domains | array | 否 | 限定的邮箱域名 | status=2 时有效 | [greedlab.com] |
3030

@@ -54,3 +54,9 @@ Authorization: Bearer <token>
5454
"message": "无权限"
5555
}
5656
```
57+
58+
## example
59+
60+
```
61+
curl -H "Accept: application/vnd.greedlab+json" -H "Content-Type: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxNzkzOTI4MTgsImV4cCI6MTQ3NDc3MTM5MjgxOCwiaWQiOiI1N2JmYTljZDUwMWMzOTE5YTI1YTdkNGMiLCJzY29wZSI6ImRlZmF1bHQifQ.z1Mm55-ItrO2KZj3Fakvt22JNmqjf2jBMeP-UVA2i7M" -X PUT -d '{"permission": 2,"domains": ["greedlab.com"]}' localhost:4002/permissions/0
62+
```

‎api/project/add.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,9 @@ Authorization: Bearer <token>
7878
"message": "bundle_id 已存在"
7979
}
8080
```
81+
82+
## example
83+
84+
```
85+
curl -H "Accept: application/vnd.greedlab+json" -H "Content-Type: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X POST -d '{"bundle_id": "com.greedlab.greedpatch", "name": "greedpatch", "introduction": "hot patch"}' localhost:4002/projects
86+
```

‎api/project/del.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,13 @@ Authorization: Bearer <token>
5252
"message": "删除失败"
5353
}
5454
```
55+
56+
## example
57+
58+
```
59+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X DELETE localhost:4002/projects/57bfbf324681acd0a46e5a80
60+
```
61+
62+
```
63+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxNzkzOTI4MTgsImV4cCI6MTQ3NDc3MTM5MjgxOCwiaWQiOiI1N2JmYTljZDUwMWMzOTE5YTI1YTdkNGMiLCJzY29wZSI6ImRlZmF1bHQifQ.z1Mm55-ItrO2KZj3Fakvt22JNmqjf2jBMeP-UVA2i7M" -X DELETE localhost:4002/projects/57bfbf324681acd0a46e5a80
64+
```

‎api/project/detail.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,9 @@ Authorization: Bearer <token>
7676
"message": "工程不存在"
7777
}
7878
```
79+
80+
## example
81+
82+
```
83+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X GET localhost:4002/projects/57bfbf324681acd0a46e5a80
84+
```

‎api/project/list-all.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,9 @@ Authorization: Bearer <token>
7272
"message": "工程不存在"
7373
}
7474
```
75+
76+
## example
77+
78+
```
79+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxNzkzOTI4MTgsImV4cCI6MTQ3NDc3MTM5MjgxOCwiaWQiOiI1N2JmYTljZDUwMWMzOTE5YTI1YTdkNGMiLCJzY29wZSI6ImRlZmF1bHQifQ.z1Mm55-ItrO2KZj3Fakvt22JNmqjf2jBMeP-UVA2i7M" -X GET localhost:4002/projects
80+
```

‎api/project/list-my.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,9 @@ Authorization: Bearer <token>
7070
"message": "工程不存在"
7171
}
7272
```
73+
74+
## example
75+
76+
```
77+
curl -H "Accept: application/vnd.greedlab+json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X GET localhost:4002/projects/my
78+
```

‎api/project/member-add.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,9 @@ Authorization: Bearer <token>
5353
"message": "用户不存在"
5454
}
5555
```
56+
57+
## example
58+
59+
```
60+
curl -H "Accept: application/vnd.greedlab+json" -H "Content-Type: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0NzIxODEyMzUxMzksImV4cCI6MTQ3NDc3MzIzNTEzOSwiaWQiOiI1N2JmOWJhMWNlODRjOTk5YTBlZmQ1YjciLCJzY29wZSI6ImRlZmF1bHQifQ.ESm0koiqDc8nfRTiHp4Uwo7PKNCtPRU5dfVfLT6MUSk" -X POST -d '{"email":"[email protected]"}' localhost:4002/projects/57bfebadd2dbc1cea6430f8b/members
61+
```

0 commit comments

Comments
 (0)