Skip to content

fix: 集成测试缺陷修复 --story=153012676 #581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
guohelu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: 集成测试缺陷修复 --story=153012676 #581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified bkflow/apigw/docs/apigw-docs.zip
View file
Open in desktop
Binary file not shown.
11 changes: 11 additions & 0 deletions bkflow/apigw/docs/zh/delete_task.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@
### is_mock 说明
当传参 is_full 时，必须同时传入 is_mock 参数

### 请求参数示例

```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"bk_username or bk_token": "xxxx",
"task_ids": [1,2,3]
}
```


### 返回结果示例

Expand Down
3 changes: 1 addition & 2 deletions bkflow/apigw/docs/zh/delete_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,13 @@
| bk_app_secret | string | 是 | 安全秘钥(app secret)，可以通过 蓝鲸开发者中心 -> 应用基本设置 -> 基本信息 -> 鉴权信息 获取 |



### 请求参数示例

```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"bk_username or bk_token": "xxxx",
"bk_username or bk_token": "xxxx"
}
```

Expand Down
12 changes: 12 additions & 0 deletions bkflow/apigw/docs/zh/get_task_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@
| create_at_start | string | 否 | 创建起始时间，如 2023-08-25 07:49:45 |
| create_at_end | string | 否 | 创建结束时间，如 2023-08-25 07:49:46 |

### 请求参数示例

```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"bk_username or bk_token": "xxxx",
"limit": 20,
"offset": 0
}
```

### 返回结果示例

```json
Expand Down
4 changes: 0 additions & 4 deletions bkflow/apigw/docs/zh/rollback_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@

### 请求参数示例

```
POST /space/{space_id}/template/{template_id}/rollback_template/
```

```json
{
"version": "1.0.0"
Expand Down
2 changes: 1 addition & 1 deletion bkflow/apigw/docs/zh/sdk_calculate_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ GET /sdk/template/{template_id}/calculate_version/
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
5 changes: 3 additions & 2 deletions bkflow/apigw/docs/zh/sdk_copy_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
"template_id": 5,
"template_name": "拷贝的流程名称"
},
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -50,7 +51,7 @@
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
5 changes: 3 additions & 2 deletions bkflow/apigw/docs/zh/sdk_create_default_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@
"is_enabled": true,
"extra_info": {}
},
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -81,7 +82,7 @@
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
2 changes: 1 addition & 1 deletion bkflow/apigw/docs/zh/sdk_delete_snapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ POST /sdk/template/snapshot/{snapshot_id}/delete_snapshot/
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
5 changes: 3 additions & 2 deletions bkflow/apigw/docs/zh/sdk_fetch_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ GET /sdk/template/{template_id}/?with_mock_data=false
"is_enabled": true,
"extra_info": {}
},
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -72,7 +73,7 @@ GET /sdk/template/{template_id}/?with_mock_data=false
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
5 changes: 3 additions & 2 deletions bkflow/apigw/docs/zh/sdk_get_api_plugin_category_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ GET /sdk/plugin_query/uniform_api/category_list/{space_id}/
}
]
},
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -58,7 +59,7 @@ GET /sdk/plugin_query/uniform_api/category_list/{space_id}/
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
24 changes: 15 additions & 9 deletions bkflow/apigw/docs/zh/sdk_get_bk_plugin_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,13 @@

### 请求参数示例

```
GET /sdk/bk_plugin/?tag=4&space_id=213
```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"space_id": 123,
"tag": 4
}
```

### 返回结果示例
Expand All @@ -53,18 +58,19 @@ GET /sdk/bk_plugin/?tag=4&space_id=213
}
]
},
"code": 0
"message": "",
"code": "0"
}
```

### 返回结果参数说明

| 字段 | 类型 | 描述 |
|-----------|----------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | list | 返回数据，插件列表 |
| 字段 | 类型 | 描述 |
|-----------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | list | 返回数据，插件列表 |

#### data[plugins] 字段说明

Expand Down
2 changes: 1 addition & 1 deletion bkflow/apigw/docs/zh/sdk_get_draft_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ GET /sdk/template/{template_id}/get_draft_template/
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
14 changes: 10 additions & 4 deletions bkflow/apigw/docs/zh/sdk_get_plugin_detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,13 @@

### 请求参数示例

```
GET /sdk/plugin/{plugin_id}/?space_id=1&version=1.0.0
```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"space_id": 1,
"version": "1.0.0"
}
```

### 返回结果示例
Expand Down Expand Up @@ -60,7 +65,8 @@ GET /sdk/plugin/{plugin_id}/?space_id=1&version=1.0.0
"group_name": "分组名称",
"status": true
},
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -69,7 +75,7 @@ GET /sdk/plugin/{plugin_id}/?space_id=1&version=1.0.0
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
14 changes: 10 additions & 4 deletions bkflow/apigw/docs/zh/sdk_get_plugin_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,13 @@

### 请求参数示例

```
GET /sdk/plugin/?space_id=1&version=1.0.0
```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"space_id": 1,
"version": "1.0.0"
}
```

### 返回结果示例
Expand All @@ -43,7 +48,8 @@ GET /sdk/plugin/?space_id=1&version=1.0.0
"status": true
}
],
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -52,7 +58,7 @@ GET /sdk/plugin/?space_id=1&version=1.0.0
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | list | 返回数据，插件列表 |

Expand Down
14 changes: 9 additions & 5 deletions bkflow/apigw/docs/zh/sdk_get_plugin_service_app_detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,20 @@

### 请求参数示例

```
GET /sdk/plugin_service/app_detail/?plugin_code=example_plugin
```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"plugin_code": "example_plugin"
}
```

### 返回结果示例

```json
{
"result": true,
"message": null,
"message": "",
"data": {
"url": "http://example.com/",
"urls": [
Expand All @@ -48,7 +52,7 @@ GET /sdk/plugin_service/app_detail/?plugin_code=example_plugin
"priority": 1
}
},
"code": 0
"code": "0"
}
```

Expand All @@ -58,7 +62,7 @@ GET /sdk/plugin_service/app_detail/?plugin_code=example_plugin
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
15 changes: 11 additions & 4 deletions bkflow/apigw/docs/zh/sdk_get_plugin_service_detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,14 @@

### 请求参数示例

```
GET /sdk/plugin_service/detail/?plugin_code=example_plugin&plugin_version=1.0.0&with_app_detail=true
```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"plugin_code": "example_plugin",
"plugin_version": "1.0.0",
"with_app_detail": true
}
```

### 返回结果示例
Expand All @@ -45,7 +51,8 @@ GET /sdk/plugin_service/detail/?plugin_code=example_plugin&plugin_version=1.0.0&
"app_name": "示例应用"
}
},
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -54,7 +61,7 @@ GET /sdk/plugin_service/detail/?plugin_code=example_plugin&plugin_version=1.0.0&
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
13 changes: 9 additions & 4 deletions bkflow/apigw/docs/zh/sdk_get_plugin_service_meta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,12 @@

### 请求参数示例

```
GET /sdk/plugin_service/meta/?plugin_code=example_plugin
```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"plugin_code": "example_plugin"
}
```

### 返回结果示例
Expand All @@ -39,7 +43,8 @@ GET /sdk/plugin_service/meta/?plugin_code=example_plugin
"tags": ["tag1", "tag2"]
}
},
"code": 0
"message": "",
"code": "0"
}
```

Expand All @@ -48,7 +53,7 @@ GET /sdk/plugin_service/meta/?plugin_code=example_plugin
| 字段 | 类型 | 描述 |
|---------|--------|-----------------------|
| result | bool | 返回结果，true为成功，false为失败 |
| code | int | 返回码，0表示成功，其他值表示失败 |
| code | string | 返回码，0表示成功，其他值表示失败 |
| message | string | 错误信息 |
| data | dict | 返回数据 |

Expand Down
Loading
Loading