Skip to content

Commit

Permalink
Merge pull request #66 from TencentBlueKing/develop
Browse files Browse the repository at this point in the history 
release V1.9.0 merge master
  • Loading branch information
@normal-wls
normal-wls authored Nov 19, 2024
2 parents f091da1 + 4c03fa6 commit c93d53d
Show file tree
Hide file tree
Showing 65 changed files with 2,460 additions and 498 deletions.
2 changes: 1 addition & 1 deletion app_desc.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
spec_version: 2
app_version: "1.8.1"
app_version: "1.9.0"
app:
region: default
bk_app_code: &APP_CODE bk_flow_engine
Expand Down
Binary file modified bkflow/apigw/docs/apigw-docs.zip
View file
Binary file not shown.
19 changes: 11 additions & 8 deletions bkflow/apigw/docs/zh/create_mock_task.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@

#### 接口参数

| 字段 | 类型 | 必选 | 描述 |
|-------------|--------|----|----------------------------------------------------------------------------|
| template_id | int | 是 | 模板id |
| name | string | 否 | 任务名 |
| creator | string | 是 | 创建者 |
| description | string | 否 | 描述 |
| constants | dict | 否 | 任务启动参数 |
| mock_data | dict | 否 | mock 数据，包含 nodes（mock 执行选中的节点) 和 outputs（mock 执行对应节点的 mock 数据，没有则表示不 mock) |
| 字段 | 类型 | 必选 | 描述 |
|-------------|--------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| template_id | int | 是 | 模板id |
| name | string | 否 | 任务名 |
| creator | string | 是 | 创建者 |
| description | string | 否 | 描述 |
| constants | dict | 否 | 任务启动参数 |
| mock_data | dict | 否 | mock 数据，包含 nodes（mock 任务使用 mock 执行的节点)，outputs（可选参数，mock 执行对应节点的节点输出)，mock_data_ids（mock 执行对应节点使用的 mock 数据 id，如果 outputs 没有传参，则会自动将创建任务时对应的 mock 数据 作为 outputs） |

### 请求参数示例

Expand All @@ -38,6 +38,9 @@
"nd7927122ef6310eb309c2c8d3f70c23": {
"callback_data": "abc"
}
},
"mock_data_ids": {
"nd7927122ef6310eb309c2c8d3f70c23": 1
}
}
}
Expand Down
62 changes: 62 additions & 0 deletions bkflow/apigw/docs/zh/get_tasks_states.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
### 资源描述

批量获取任务状态

### 输入通用参数说明
| 参数名称 | 参数类型 | 必须 | 参数说明 |
|---------------|--------|----|------------------------------------------------------------|
| bk_app_code | string | 是 | 应用ID(app id)，可以通过 蓝鲸开发者中心 -> 应用基本设置 -> 基本信息 -> 鉴权信息 获取 |
| bk_app_secret | string | 是 | 安全秘钥(app secret)，可以通过 蓝鲸开发者中心 -> 应用基本设置 -> 基本信息 -> 鉴权信息 获取 |

#### 接口参数
| 字段 | 类型 | 必选 | 描述 |
|----------|-----------|----|---------------|
| task_ids | list[int] | 是 | 需要查询的任务 id 列表 |


### 请求参数示例
```json
{
"bk_app_code": "xxxx",
"bk_app_secret": "xxxx",
"bk_username or bk_token": "xxxx",
"task_ids": [1, 2, 3, 4]
}
```


### 返回结果示例

```json
{
"result": true,
"data": {
"3": {
"state": "FINISHED"
},
"2": {
"state": "FINISHED"
},
"1": {
"state": "FINISHED"
}
},
"code": "0",
"message": ""
}
```
### 返回结果参数说明

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

#### data[item]

| 字段 | 类型 | 描述 |
|-----------------|--------|-----------|
| id | string | 任务实例ID |
| state | string | 任务状态 |
69 changes: 69 additions & 0 deletions bkflow/apigw/docs/zh/get_template_mock_data.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
### 资源描述

获取流程 Mock 数据

### 输入通用参数说明
| 参数名称 | 参数类型 | 必须 | 参数说明 |
|---------------|--------|----|------------------------------------------------------------|
| bk_app_code | string | 是 | 应用ID(app id)，可以通过 蓝鲸开发者中心 -> 应用基本设置 -> 基本信息 -> 鉴权信息 获取 |
| bk_app_secret | string | 是 | 安全秘钥(app secret)，可以通过 蓝鲸开发者中心 -> 应用基本设置 -> 基本信息 -> 鉴权信息 获取 |

### 接口参数

| 字段 | 类型 | 必选 | 描述 |
|---------|--------|----|-------------------------|
| node_id | string | 否 | 基于节点 id 过滤对应节点的 Mock 数据 |


### 返回结果示例

```json
{
"result": true,
"data": [
{
"id": 1,
"name": "Mock 数据方案1",
"space_id": 1,
"template_id": 1,
"node_id": "nd64fbd5440932ee9658d47029751f46",
"data": {
"callback_data": {
"abc": "123"
}
},
"is_default": true,
"extra_info": null,
"operator": "admin",
"create_at": "2024-09-14T15:24:39.075179+08:00",
"update_at": "2024-09-14T15:24:39.075289+08:00"
}
],
"code": 0,
"message": ""
}
```
### 返回结果参数说明

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

### data[item]

| 字段 | 类型 | 描述 |
|-------------|--------|------------------|
| id | int | Mock 数据 ID |
| name | string | Mock 数据名称 |
| space_id | int | Mock 数据所属空间 ID |
| template_id | int | Mock 数据所属流程模板 ID |
| node_id | string | Mock 数据所属节点 ID |
| data | dict | Mock 数据内容 |
| is_default | bool | 是否为默认 Mock 数据 |
| extra_info | dict | 额外信息 |
| operator | string | 操作人 |
| create_at | string | 创建时间 |
| update_at | string | 更新时间 |
Loading

0 comments on commit c93d53d

Please sign in to comment.