v5.80.0:REST API 新增工作项类型方案

更新时间:2024年4月1日

更新内容

  1. 新增工作项类型方案
  2. 重构工作项和工作项类型的 API
  3. 扩展创建项目的场景

新增工作项类型方案

工作项类型方案主要用于表示某个项目能够使用哪些工作项类型。例如一个项目 A 开启了本地化,那么系统中就会自动增加一个所属于项目 A 的工作项类型方案,如果这个方案中只包含特性、用户故事和缺陷,这意味着项目 A 能创建这三个类型的工作项;例如一个 Scrum 类型的项目 B 没有开启本地化,那么项目 B 将使用全局的、Scrum 项目的工作项类型方案,这个方案里如果包含了史诗,这意味着项目 B 就可以创建史诗类型的工作项。工作项类型方案对应的 API 如下:

获取工作项类型方案列表
GET /v1/project/work_item_type_plans
向工作项类型方案中添加一个工作项类型
POST /v1/project/work_item_type_plans/{work_item_type_plan_id}/work_item_types
获取工作项类型方案中的工作项类型列表
GET /v1/project/work_item_type_plans/{work_item_type_plan_id}/work_item_types
在工作项类型方案中移除一个工作项类型
DELETE /v1/project/work_item_type_plans/{work_item_type_plan_id}/work_item_types/{work_item_type_id}

重构工作项和工作项类型相关的 API

为支持后续版本的功能,我们重构了一些与工作项类型直接相关的 API:

创建一个工作项
POST /v1/project/work_items
部分更新一个工作项
PATCH /v1/project/work_items/{work_item_id}
批量部分更新工作项属性
PATCH /v1/project/work_items
获取工作项列表
GET /v1/project/work_items
获取工作项类型列表
GET /v1/project/work_item/types?project_id={project_id}
创建一个工作项类型
POST /v1/project/work_item_types
部分更新一个工作项类型
PATCH /v1/project/work_item_types/{work_item_type_id}
获取全部工作项类型列表
GET /v1/project/work_item_types

扩展创建项目的场景

创建项目时,支持指定项目所属为组织/团队,支持指定项目的可见性,支持初始化项目成员为”团队“。

POST /v1/project/projects // 创建一个所属团队的项目
{
  	...
    "scope_type": "user_group",
    "scope_id": "63c8fb32729dee3334d96af7", // user_group_id
    "visibility": "private",
    "members": [
        {
            "id": "a0417f68e846aae315c85d24643678a9", // 来自该 user_group 的企业成员的id
            "type": "user"
        }
    ],
    ...
}

    POST /v1/project/projects // 创建一个所属组织的项目
{
  	...
    "scope_type": "organization",
    "visibility": "private",
    "members": [
        {
            "id": "a0417f68e846aae315c85d24643678a9", // 来自该 user_group 的企业成员的id
            "type": "user"
        },
        {
            "id": "63c8fb32729dee3334d96af7",
            "type": "user_group"
        }
    ],
    ...
}

    

一些其他的修改

  • 保留评论内容中的换行符,统一使用”\n“来表示
  • 获取测试计划关联缺陷时,将测试计划中的执行用例关联的缺陷也一并返回
  • 优化级联单选和级联多选的更新操作
  • 修复一些已知缺陷