# 标签
如果使用 project_full_path，确保 project_full_path 编码过，例子：/api/v3/projects/tencent/code--> /api/v3/projects/tencent%2Fcode (/ 编码 %2F)
# 项目标签
# 新增项目标签
创建一个标签给指定项目，每个项目标签最多100个
POST /api/v3/projects/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| name | string | 标签名 |
| color | string | 标签颜色，举例：#428bca |
返回值：
{
"id": 59891,
"color": "#428bca",
"name": "界面"
}
# 修改项目标签
修改指定项目的某个标签
PUT /api/v3/projects/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| name | string | 旧标签名 |
| new_name | string | 新标签名 |
| color | string (可选) | 标签颜色，举例：#428bca |
返回值：
{
"id": 59891,
"color": "#428bca",
"name": "新界面"
}
# 获取项目标签列表
返回给定项目的所有标签
GET /api/v3/projects/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| include_ancestor_groups | boolean (可选) | 是否包含从父项目组继承的标签，允许 true, false （默认false） |
| type | string（可选） | 类型字段，标签类型有：project(项目标签) / review（评审问题分类标签），(默认project) |
| order_by | string（可选） | 排序字段，允许按 name,created_at排序（默认name） |
| sort | string（可选） | 排序方式，允许 asc,desc（默认asc） |
| page | integer（可选） | 分页（默认值：1） |
| per_page | integer（可选） | 默认页面大小（默认值：20，最大值：100） |
返回值：
[
{
"id": 59891,
"color": "#d9534f",
"name": "bug"
},
{
"id": 59892,
"color": "#d9534f",
"name": "critical"
},
{
"id": 59893,
"color": "#d9534f",
"name": "confirmed"
}
]
# 删除项目标签
删除指定项目某个标签
DELETE /api/v3/projects/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| name | string | 标签名 |
返回值：
删除成功返回 200，参数错误返回 400，标签不存在返回 404
# 项目评审问题分类标签
# 新增项目评审问题分类标签
创建一个评审问题分类标签给指定项目。
POST /api/v3/projects/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| name | string | 标签名 |
| color | string | 标签颜色，举例：#428bca |
| parent_id | integer(可选) | 父级标签的 id，在创建多级标签时使用，默认为-1，表示当前为一级标签 |
| severity | integer(可选) | 标签严重程度：默认为 0 无，1 轻微，2 一般，3 严重 |
| description | string(可选) | 标签描述信息 |
返回值：
{
"id": 136367,
"name": "CR-api1",
"color": "#428bca",
"description": null,
"parent_id": -1,
"severity": 1
}
# 修改项目评审问题分类标签
修改指定项目的某个标签
PUT /api/v3/projects/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| name | string | 旧标签名 |
| new_name | string | 新标签名 |
| color | string (可选) | 标签颜色，举例：#428bca |
| parent_id | integer(可选) | 父级标签的 id，在修改多级标签时使用，默认为-1，表示当前为修改一级标签信息 |
| severity | integer(可选) | 标签严重程度：默认为 0 无，1 轻微，2 一般，3 严重 |
| description | string(可选) | 标签描述信息 |
返回值：
{
"id": 136367,
"name": "CR-api1",
"color": "#428bca",
"description": "修改描述信息",
"parent_id": 136368
}
# 获取项目评审问题分类标签
返回给定项目的所有标签
GET /api/v3/projects/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| include_ancestor_groups | boolean (可选) | 是否包含从父项目组继承的标签，允许 true, false （默认false） |
| order_by | string（可选） | 排序字段，允许按 name,created_at排序（默认name） |
| sort | string（可选） | 排序方式，允许 asc,desc（默认asc） |
| page | integer（可选） | 分页（默认值：1） |
| per_page | integer（可选） | 默认页面大小（默认值：20，最大值：100） |
返回值：
[
{
"id": 136367,
"name": "CR-api1",
"color": "#428bca",
"description": null,
"parent_id": -1,
"severity": 1,
"children": [
{
"id": 193903,
"name": "12",
"color": "#428BCA",
"description": null,
"parent_id": 136367,
"severity": 1,
"children": []
}
]
},
{
"id": 136368,
"name": "update",
"color": "#428bca",
"description": null,
"parent_id": -1,
"severity": 1,
"children": []
}
]
# 删除项目评审问题分类标签
删除指定项目某个标签
DELETE /api/v3/projects/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| name | string | 标签名 |
| parent_id | integer(可选) | 父级标签的 id，在删除多级标签时使用，默认为-1，表示当前为删除的一级标签信息 |
返回值：
删除成功返回 200，参数错误返回 400，标签不存在返回 404
# 使用标签模板应用到项目
在项目中使用标签模板
POST /api/v3/projects/:id/review/labels/template
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目 ID 或 项目全路径 project_full_path |
| template_name | string | 模版名称 |
| template_type | string(可选) | 模板类型，默认为 Review |
| strategy | integer(可选) | 创建策略，默认为 1 可选值 0: 表示在原来的标签基础上增加，重名则合并； 1: 表示覆盖原来的标签，会删除原来的标签，用模板标签替代 |
返回值：
[
{
"id": 338773,
"name": "label",
"color": "#428bca",
"description": null,
"parent_id": -1,
"severity": 0,
"children": []
}
]
# 项目组标签
针对项目组标签进行的所有修改操作，都需要具有项目组 reporter 以上权限。
# 新增项目组标签
创建一个标签给指定项目组
POST /api/v3/groups/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| name | string | 标签名 |
| color | string | 标签颜色，举例：#428bca |
返回值：
{
"id": 79891,
"color": "#428bca",
"name": "界面"
}
# 修改项目组标签
修改指定项目组的某个标签
PUT /api/v3/groups/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| name | string | 旧标签名 |
| new_name | string | 新标签名 |
| color | string (可选) | 标签颜色，举例：#428bca |
返回值：
{
"id": 79891,
"color": "#428bca",
"name": "新界面"
}
# 获取项目组标签列表
返回给定项目组的所有标签
GET /api/v3/groups/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| include_ancestor_groups | boolean (可选) | 是否包含从父项目组继承的标签，允许 true, false |
| type | string（可选） | 类型字段，标签类型有：namespace(项目组标签) / namespacereview（评审问题分类标签），(默认namespace) |
| search | string (可选) | 指定标签 name 进行搜索 |
| order_by | string（可选） | 排序字段，允许按 name,created_at排序（默认name） |
| sort | string（可选） | 排序方式，允许 asc,desc（默认asc） |
| page | integer（可选） | 分页（默认值：1） |
| per_page | integer（可选） | 默认页面大小（默认值：20，最大值：100） |
返回值：
[
{
"id": 79891,
"color": "#d9534f",
"name": "bug"
},
{
"id": 79892,
"color": "#d9534f",
"name": "critical"
},
{
"id": 79893,
"color": "#d9534f",
"name": "confirmed"
}
]
# 删除项目组标签
删除指定项目组某个标签
DELETE /api/v3/groups/:id/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| name | string | 标签名 |
返回值：
删除成功返回 200，参数错误返回 400，标签不存在返回 404
# 项目组评审问题分类标签
# 新增项目组评审问题分类标签
创建一个评审问题分类标签给指定项目组。
POST /api/v3/groups/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| name | string | 标签名 |
| color | string | 标签颜色，举例：#428bca |
| parent_id | integer(可选) | 父级标签的 id，在创建多级标签时使用，默认为-1，表示当前为一级标签 |
| severity | integer(可选) | 标签严重程度：默认为 0 无，1 轻微，2 一般，3 严重 |
| description | string(可选) | 标签描述信息 |
返回值：
{
"id": 709859,
"name": "group-crlabel",
"color": "#428bca",
"description": "api 创建的二级的标签",
"parent_id": 709859,
"severity": 1
}
# 修改项目组评审问题分类标签
修改指定项目组的某个评审问题分类标签
PUT /api/v3/groups/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| name | string | 旧标签名 |
| new_name | string | 新标签名 |
| color | string (可选) | 标签颜色，举例：#428bca |
| parent_id | integer(可选) | 父级标签的 id，在修改多级标签时使用，默认为-1，表示当前为一级标签 |
| severity | integer(可选) | 标签严重程度：默认为 0 无，1 轻微，2 一般，3 严重 |
| description | string(可选) | 标签描述信息 |
返回值：
{
"id": 709859,
"name": "updategroup-crlabel",
"color": "#428bca",
"description": "修改描述信息",
"parent_id": 709859 ,
"severity": 1
}
# 获取项目组评审问题分类标签
返回给定项目组的所有评审问题分类标签
GET /api/v3/groups/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| include_ancestor_groups | boolean (可选) | 是否包含从父项目组继承的标签，允许 true, false （默认false） |
| order_by | string（可选） | 排序字段，允许按 name,created_at排序（默认name） |
| sort | string（可选） | 排序方式，允许 asc,desc（默认asc） |
| page | integer（可选） | 分页（默认值：1） |
| per_page | integer（可选） | 默认页面大小（默认值：20，最大值：100） |
返回值：
[
{
"id": 709859,
"name": "updategroup-crlabel",
"color": "#428bca",
"description": null,
"parent_id": -1,
"severity": 1,
"children": []
},
{
"id": 709436,
"name": "cr-api",
"color": "#428bca",
"description": null,
"parent_id": -1,
"severity": 1,
"children": []
}
]
# 删除项目组评审问题分类标签
删除指定项目组某个评审问题分类标签
DELETE /api/v3/groups/:id/review/labels
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| name | string | 标签名 |
| parent_id | integer(可选) | 父级标签的 id，在删除多级标签时使用，默认为-1，表示当前为一级标签 |
返回值：
删除成功返回 200，参数错误返回 400，标签不存在返回 404
# 使用标签模板应用到项目组
在项目组中使用标签模板
POST /api/v3/projects/:id/review/labels/template
参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| id | integer 或 string | 项目组 ID 或 项目组全路径 group_full_path |
| template_name | string | 模版名称 |
| template_type | string(可选) | 模板类型，默认为 Review |
| strategy | integer(可选) | 创建策略，默认为 1 可选值 0: 表示在原来的标签基础上增加，重名则合并； 1: 表示覆盖原来的标签，会删除原来的标签，用模板标签替代 |
返回值：
[
{
"id": 338773,
"name": "label",
"color": "#428bca",
"description": null,
"parent_id": -1,
"severity": 0,
"children": []
}
]