华为云用户手册

  • Commit 接口 说明 查询某个仓库的提交信息 根据仓库短ID获取提交信息,支持根据文件路径,查询这个路径下所有的commits列表。 创建提交 能够一次提交位于不同目录的多个文件,目录不存在时,能自动创建目录。支持强制覆盖选项,当选择强制覆盖标志为true时,忽略冲突,强制提交。 查询某个仓库的特定提交信息 获取由commit id或分支或标记的名称标识的特定提交。 查询某个仓库的提交差异信息 根据commit id查询提交差异信息。
  • 响应示例 状态码: 200 OK { "result" : { "total" : 14, "repositories" : { "repository_uuid" : "d0457f74cc5b43d989ded7248f71b4e5", "repository_id" : 468480, "repository_name" : "CreatRepository_2qD5i", "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:Demo00228/CreatRepository_2qD5i.git", "https_url" : "https://repo.alpha.devcloud.inhuawei.com/Demo00228/CreatRepository_2qD5i.git", "group_name" : "Demo00228", "web_url" : "https://alpha.devcloud.inhuawei.com/repo/468480/home", "visibility_level" : 0, "created_at" : "2019-10-15 09:40:26", "updated_at" : "2019-10-15 09:40:26", "repository_size" : "0.06M", "lfs_size" : "0.00M", "creator_name" : "repo", "domain_name" : "repo", "star" : false, "status" : 0, "is_owner" : 1, "iam_user_uuid" : "a618e34bd5704be3ae3395dfede06041", "project_uuid" : "4838955a48e2492bbe44b31bc4c272f6", "project_is_deleted" : "false", "userRole" : null } }, "status" : "success" }
  • URI GET /v2/projects/{project_uuid}/repositories 表1 路径参数 参数 是否必选 参数类型 描述 project_uuid 是 String 项目ID,获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 page_index 否 Integer 分页索引,从1开始计数 page_size 否 Integer 每页条目数 search 否 String 搜索关键字
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoListInfoV2 object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 RepoListInfoV2 参数 参数类型 描述 repositories Array of RepoInfoV2 objects 仓库列表 total Integer 仓库总数 表7 RepoInfoV2 参数 参数类型 描述 created_at String 创建时间 creator_name String 创建者的用户名,在用户是租户的情况下,用户名和租户名相等 domain_name String 创建者的租户名 group_name String 仓库组名(克隆地址中域名后面仓库名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) https_url String 使用 https 克隆仓库时所使用的 url iam_user_uuid String 用户的 iam user uuid is_owner Integer 当前用户是否是仓库的创建者,1:是,0:不是 lfs_size String 仓库 LFS 容量,单位为M,大于 1024M 则单位为 G project_is_deleted String 项目是否被删除 project_uuid String 项目ID,获取方式请参见获取项目ID。 repository_id Integer 仓库主键id repository_name String 仓库名 repository_size String 仓库总容量 = 仓库 LFS 容量 + git 库容量,单位为M,大于 1024M 则单位为 G repository_uuid String 仓库uuid(由CreateRepository接口返回) ssh_url String 使用 ssh 方式克隆仓库时所使用的 url star Boolean 当前用户是否收藏该仓库 status Integer 仓库状态, 0:仓库正常创建成功 1:仓库创建中 2:创建失败 3:仓库冻结 4:仓库已经关闭 updated_at String 更新时间 userRole Integer 用户在仓库中的权限:20:只读成员 30:普通成员 40:管理员 visibility_level Integer 是否可见:0私有仓库,20公有仓库 web_url String web url 路径,访问它将跳转至仓库详情页
  • URI GET /v2/projects/{project_uuid}/repositories/template-status 表1 路径参数 参数 是否必选 参数类型 描述 project_uuid 是 String 项目ID,获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 page_no 否 Integer 分页页数 page_size 否 Integer 每页数据数
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result TemplateListInfo object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 TemplateListInfo 参数 参数类型 描述 repos Array of DevstarRepoInfo objects 仓库列表 total_count Integer 仓库总数 表7 DevstarRepoInfo 参数 参数类型 描述 uuid String 仓库的uuid repo_id String 仓库ID repo_name String 仓库名称 ssh_url String 仓库SSH地址 code_url String 仓库HTTPS地址 detail_url String 仓库预览地址
  • 响应示例 状态码: 200 OK { "result" : { "repos" : [ { "uuid" : "36f532939c4b4e2191c10f5353ccf34c", "repo_id" : 487773, "repo_name" : "DDDDDDDD", "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:CHEN_TEST00001/DDDDDDDD.git", "code_url" : "https://repo.alpha.devcloud.inhuawei.com/CHEN_TEST00001/DDDDDDDD.git", "detail_url" : "https://alpha.devcloud.inhuawei.com/repo/487773/home" } ], "total_count" : 100 }, "status" : "success" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 template_type 是 String 模板类型 code_title 否 String 代码模板名称 creator_name 否 String 创建者名称 code_description 否 String 代码模板描述 languages 否 Array of strings 模板语言 plateform 否 Array of strings 模板平台 entertype 否 Array of strings 模板类型
  • 请求示例 PUT https://{endpoint}/v2/repositories/{repository_uuid}/template-status { "template_type": "SHARE", "code_title": "exampleTitle", "creator_name": "exampleName", "code_description": "exampleDescription", "languages": ['Java'], "plateform": ['Console'], "entertype": ['AI'] }
  • 响应示例 状态码: 200 OK { "result" : { "total" : 29, "repositories" : { "repository_uuid" : "0bf1e7ceb5b341318cb72b42901abe54", "repository_id" : 468564, "repository_name" : "test", "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:test_new00001/test.git", "https_url" : "https://repo.alpha.devcloud.inhuawei.com/test_new00001/test.git", "group_name" : "test_new00001", "web_url" : "https://alpha.devcloud.inhuawei.com/repo/468564/home", "visibility_level" : 0, "created_at" : "2019-10-15 11:00:11", "updated_at" : "2019-10-15 11:00:11", "repository_size" : "0.05M", "lfs_size" : "0.00M", "creator_name" : "repo", "domain_name" : "repo", "star" : true, "status" : 0, "is_owner" : 1, "iam_user_uuid" : "a618e34bd5704be3ae3395dfede06041", "project_uuid" : "dc19b3ca6f334ce894a1ec467689797d", "project_is_deleted" : "false", "userRole" : null } }, "status" : "success" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoListInfoV2 object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 RepoListInfoV2 参数 参数类型 描述 repositories Array of RepoInfoV2 objects 仓库列表 total Integer 仓库总数 表6 RepoInfoV2 参数 参数类型 描述 created_at String 创建时间 creator_name String 创建者的用户名,在用户是租户的情况下,用户名和租户名相等 domain_name String 创建者的租户名 group_name String 仓库组名(克隆地址中域名后面仓库名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) https_url String 使用 https 克隆仓库时所使用的 url iam_user_uuid String 用户的 iam user uuid is_owner Integer 当前用户是否是仓库的创建者,1:是,0:不是 lfs_size String 仓库 LFS 容量,单位为M,大于 1024M 则单位为 G project_is_deleted String 项目是否被删除 project_uuid String 项目ID,获取方式请参见获取项目ID。 repository_id Integer 仓库主键id repository_name String 仓库名 repository_size String 仓库总容量 = 仓库 LFS 容量 + git 库容量,单位为M,大于 1024M 则单位为 G repository_uuid String 仓库uuid(由CreateRepository接口返回) ssh_url String 使用 ssh 方式克隆仓库时所使用的 url star Boolean 当前用户是否收藏该仓库 status Integer 仓库状态, 0:仓库正常创建成功 1:仓库创建中 2:创建失败 3:仓库冻结 4:仓库已经关闭 updated_at String 更新时间 userRole Integer 用户在仓库中的权限:20:只读成员 30:普通成员 40:管理员 visibility_level Integer 是否可见:0私有仓库,20公有仓库 web_url String web url 路径,访问它将跳转至仓库详情页
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Repository object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 Repository 参数 参数类型 描述 repository_uuid String 创建仓库的UUID 最小长度:32 最大长度:32
  • 请求示例 POST https://{endpoint}/v2/repositories/{repository_id}/merge_requests/{merge_request_iid}/discussions { "body" : "检视意见内容", "position" : { "new_path" : "a.txt", "old_path" : "a.txt", "new_line" : 1, "old_line" : -1 }, "severity" : "suggestion" }
  • 响应示例 状态码: 200 OK { "result" : { "id" : "b7d95c35c08e0b328bfbafd45408bd2ac28b73f9", "individual_note" : false, "notes" : [ { "id" : 2111886200, "type" : "DiffNote", "body" : "检视意见内容", "author" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "created_at" : "2023-06-01T17:05:12.000+08:00", "updated_at" : "2023-06-01T17:05:12.000+08:00", "system" : false, "noteable_id" : 19387, "noteable_type" : "MergeRequest", "resolvable" : true, "is_reply" : true, "noteable_iid" : 2, "discussion_id" : "8bbe6d4e797169c4c1ce56507fdf1abc11f95601", "project" : "DevOpsqlcylxm00004/project-test", "diff_file" : "7", "diff" : "@@ -0,0 +1,0 @@\n+7", "archived" : false, "review_categories" : "regulations", "review_categories_cn" : "编程军规问题", "review_categories_en" : "Regulations", "review_modules" : "aaa,bbb", "severity" : "suggestion", "assignee" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "proposer" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "position" : { "base_sha" : "973bcc0211c32dbaa8473561c6767f74e1a81471", "start_sha" : "973bcc0211c32dbaa8473561c6767f74e1a81471", "head_sha" : "f5bf0230f9b996ed6c0d64d2b2fef789d91b164c", "old_path" : "7", "new_path" : "7", "position_type" : "text", "new_line" : 1 }, "resolved" : false, "is_outdated" : false } ], "project_id" : 2111699786, "noteable_type" : "MergeRequest", "project_full_path" : "DevOpsqlcylxm00004/project-test", "a_mode" : "0", "b_mode" : "100644", "deleted_file" : false, "new_file" : true, "resolved" : false, "archived" : false, "review_categories" : "regulations", "review_categories_cn" : "编程军规问题", "review_categories_en" : "Regulations", "review_modules" : "aaa,bbb", "severity" : "suggestion", "severity_cn" : "建议", "severity_en" : "Suggestion", "assignee" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "proposer" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "diff_file" : "@@ -0,0 +1,0 @@\n+7", "added_lines" : 1, "removed_lines" : 0 }, "status" : "success" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result MergeRequestDiscussionDto object 响应结果 status String 响应状态 表6 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表7 MergeRequestDiscussionDto 参数 参数类型 描述 id String 评论id individual_note Boolean individual_note notes Array of NoteDto objects 主评和回复列表 数组长度:0 - 1 project_id Integer 仓库id 最小值:1 最大值:2147483647 noteable_type String 目标类型 commit_id String 关联的提交id project_full_path String 仓库路径 a_mode String 变更前文件模式 b_mode String 变更后文件模式 deleted_file Boolean 此次变更是否删除文件 new_file Boolean 此次变更是否新增文件 resolved Boolean 检视意见是否解决 archived Boolean 检视意见是否存档 review_categories String 检视意见分类 review_categories_cn String 检视意见分类中文名 review_categories_en String 检视意见分类英文名 review_modules String 检视意见模块 severity String 严重程度 severity_cn String 严重程度中文名 severity_en String 严重程度英文名 assignee UserBasicDto object 指派人 proposer UserBasicDto object 提出人 merge_request_version_params MergeRequestVersionParamsDto object MR版本信息 diff_file String 变更文件 added_lines Integer 新增行数 最小值:1 最大值:2147483647 removed_lines Integer 删除行数 最小值:1 最大值:2147483647 表8 NoteDto 参数 参数类型 描述 id Integer note id 最小值:1 最大值:2147483647 type String note类型 body String 检视意见内容 attachment String 附件 author UserBasicDto object 作者 created_at String 创建时间 updated_at String 更新时间 system Boolean 是否是系统生成的日志 noteable_id Integer 目标id 最小值:1 最大值:2147483647 noteable_type String 目标类型 commit_id String 关联的提交id resolvable Boolean 是否可解决 is_reply Boolean 是否是回复 resolved_by UserBasicDto object 解决人 noteable_iid Integer 目标iid 最小值:1 最大值:2147483647 discussion_id String 讨论id project String 所属项目 diff_file String 变更文件 diff String 变更内容 archived Boolean 是否存档 review_categories String 检视意见分类 review_categories_cn String 检视意见分类中文名 review_categories_en String 检视意见分类英文名 review_modules String 检视意见模块 severity String 严重程度 severity_cn String 严重程度中文名 severity_en String 严重程度英文名 file_path String 文件路径 line String 行号 assignee UserBasicDto object 指派人 proposer UserBasicDto object 提出人 position PositionDto object 关联的代码位置 resolved Boolean 是否解决 is_outdated Boolean 是否过时 表9 PositionDto 参数 参数类型 描述 base_sha String 源分支base提交节点 start_sha String 目标分支最新提交节点 head_sha String 源分支最新提交节点 old_path String 修改前文件路径 new_path String 修改后文件路径 position_type String 变更类型 old_line Integer 修改前行号 new_line Integer 修改后行号 表10 UserBasicDto 参数 参数类型 描述 id Integer 用户id 最小值:1 最大值:2147483647 name String 姓名 username String 用户名 state String 状态 avatar_url String 头像url avatar_path String 头像路径 email String 邮箱 name_cn String 中文名 web_url String 主页 nick_name String 昵称 tenant_name String 租户名称 表11 MergeRequestVersionParamsDto 参数 参数类型 描述 diff_id Integer MR最新变更id 最小值:1 最大值:2147483647 start_sha String 目标分支最新提交 commit_id String 源分支最新提交
  • URI POST /v2/repositories/{repository_id}/merge_requests/{merge_request_iid}/discussions 表1 路径参数 参数 是否必选 参数类型 描述 repository_id 是 Integer 仓库短id 最小值:1 最大值:2147483647 merge_request_iid 是 Integer 合并请求iid 最小值:1 最大值:2147483647
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 body 是 String 检视意见内容 severity 否 String 严重程度 assignee_id 否 String 指派人id review_categories 否 String 检视意见分类 review_modules 否 String 检视意见模块 proposer_id 否 String 提出人id position 否 PositionDto object 代码位置信息 表4 PositionDto 参数 是否必选 参数类型 描述 base_sha 否 String 源分支base提交节点 start_sha 否 String 目标分支最新提交节点 head_sha 否 String 源分支最新提交节点 old_path 否 String 修改前文件路径 new_path 否 String 修改后文件路径 position_type 否 String 变更类型 old_line 否 Integer 修改前行号 new_line 否 Integer 修改后行号
  • 响应示例 状态码: 200 OK { "result" : [ { "diff" : "@@ -1,4 +1,7 @@\n y_mr_0721\n+\n+![CloudIDE成功运行](./image/截图.PNG)\n+\n edwwd\n # css \n **hhrh**", "old_path" : "README.md", "new_path" : "README.md", "a_mode" : "100644", "b_mode" : "100644", "new_file" : false, "renamed_file" : false, "deleted_file" : false } ], "status" : "success" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Array of DiffCommitInfo objects 差异列表 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 DiffCommitInfo 参数 参数类型 描述 old_path String 变更前文件路径 new_path String 变更后文件路径 a_mode String 变更前文件模式 b_mode String 变更后文件模式 new_file Boolean 此次变更是否新增文件 renamed_file Boolean 此次变更是否重命名文件 deleted_file Boolean 此次变更是否删除文件 diff Boolean 差异信息
  • 响应示例 状态码: 200 OK { "result" : { "id" : "85a0a9d5c6e43bc9c3e443ac01f789e24eeef02b", "title" : "some commit message", "message" : "some commit message", "short_id" : "85a0a9d5", "author_name" : "repo", "author_email" : null, "committer_name" : "repo", "committer_email" : null, "created_at" : "2021-09-26T03:44:51.000Z", "parent_ids" : [ "5c114bb316dff4d4a046e09a5c44c816f2433140" ], "committed_date" : "2021-09-26T03:44:51.000Z", "authored_date" : null, "stats" : { "additions" : 1, "deletions" : 0, "total" : 1 }, "last_pipeline" : { "id" : 292811, "sha" : "2202af08836f0afd762d1b151d15ac510b974bdf", "ref" : "master", "status" : "running", "web_url" : "https://repo.devcloud.cn-north-208.ulanqab.huawei.com/Pipeline_Beta_sdcs00001/202107171926/pipelines/292811" } }, "status" : "success" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result SpecificCommitInfo object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 SpecificCommitInfo 参数 参数类型 描述 id String 提交对应的SHA id short_id String 提交对应的短SHA id title String 提交标题 author_name String 作者 author_email String 作者邮箱 committer_name String 提交作者 committer_email String 提交作者邮箱 created_at String 创建时间 message String 提交信息 parent_ids Array of strings 父提交id committed_date String 提交时间 authored_date String 作者提交时间 stats stats object 变更行数 last_pipeline last_pipeline object 流水线信息 表7 stats 参数 参数类型 描述 additions Integer 变更增加的行数 deletions Integer 变更删除的行数 total Integer 变更的总行数 表8 last_pipeline 参数 参数类型 描述 id Integer 流水线id sha String 提交对应的SHA id ref String 分支名 status String 流水线状态 web_url String 流水线url
  • URI GET /v2/projects/{repo_id}/repository/commits/{sha} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 Integer 仓库短id sha 是 String commit id,仓库的branch名或tag名 表2 Query参数 参数 是否必选 参数类型 描述 stats 否 Boolean 包括提交统计信息。默认值为true
  • 响应示例 状态码: 200 OK { "result" : { "id" : "b7d95c35c08e0b328bfbafd45408bd2ac28b73f9", "individual_note" : false, "notes" : [ { "id" : 2111886200, "type" : "DiffNote", "body" : "检视意见内容", "author" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "created_at" : "2023-06-01T17:05:12.000+08:00", "updated_at" : "2023-06-01T17:05:12.000+08:00", "system" : false, "noteable_id" : 19387, "noteable_type" : "MergeRequest", "resolvable" : true, "is_reply" : true, "noteable_iid" : 2, "discussion_id" : "8bbe6d4e797169c4c1ce56507fdf1abc11f95601", "project" : "DevOpsqlcylxm00004/project-test", "diff_file" : "7", "diff" : "@@ -0,0 +1,0 @@\n+7", "archived" : false, "review_categories" : "regulations", "review_categories_cn" : "编程军规问题", "review_categories_en" : "Regulations", "review_modules" : "aaa,bbb", "severity" : "suggestion", "assignee" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "proposer" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "position" : { "base_sha" : "973bcc0211c32dbaa8473561c6767f74e1a81471", "start_sha" : "973bcc0211c32dbaa8473561c6767f74e1a81471", "head_sha" : "f5bf0230f9b996ed6c0d64d2b2fef789d91b164c", "old_path" : "7", "new_path" : "7", "position_type" : "text", "new_line" : 1 }, "resolved" : false, "is_outdated" : false } ], "project_id" : 2111699786, "noteable_type" : "MergeRequest", "project_full_path" : "DevOpsqlcylxm00004/project-test", "a_mode" : "0", "b_mode" : "100644", "deleted_file" : false, "new_file" : true, "resolved" : false, "archived" : false, "review_categories" : "regulations", "review_categories_cn" : "编程军规问题", "review_categories_en" : "Regulations", "review_modules" : "aaa,bbb", "severity" : "suggestion", "severity_cn" : "建议", "severity_en" : "Suggestion", "assignee" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "proposer" : { "id" : 1234, "name" : "beta", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "name_cn" : "beta" }, "diff_file" : "@@ -0,0 +1,0 @@\n+7", "added_lines" : 1, "removed_lines" : 0 }, "status" : "success" }
  • 请求示例 GET https://{endpoint}/v2/repositories/{repository_id}/merge_requests/{merge_request_iid}/discussions { "body" : "获取意见内容", "position" : { "new_path" : "a.txt", "old_path" : "a.txt", "new_line" : 1, "old_line" : -1 }, "severity" : "suggestion" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result MergeRequestDiscussionDto object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 MergeRequestDiscussionDto 参数 参数类型 描述 id String 评论id individual_note Boolean individual_note notes Array of NoteDto objects 主评和回复列表 数组长度:0 - 1 project_id Integer 仓库id 最小值:1 最大值:2147483647 noteable_type String 目标类型 commit_id String 关联的提交id project_full_path String 仓库路径 a_mode String 变更前文件模式 b_mode String 变更后文件模式 deleted_file Boolean 此次变更是否删除文件 new_file Boolean 此次变更是否新增文件 resolved Boolean 检视意见是否解决 archived Boolean 检视意见是否存档 review_categories String 检视意见分类 review_categories_cn String 检视意见分类中文名 review_categories_en String 检视意见分类英文名 review_modules String 检视意见模块 severity String 严重程度 severity_cn String 严重程度中文名 severity_en String 严重程度英文名 assignee UserBasicDto object 指派人 proposer UserBasicDto object 提出人 merge_request_version_params MergeRequestVersionParamsDto object MR版本信息 diff_file String 变更文件 added_lines Integer 新增行数 最小值:1 最大值:2147483647 removed_lines Integer 删除行数 最小值:1 最大值:2147483647 表6 NoteDto 参数 参数类型 描述 id Integer note id 最小值:1 最大值:2147483647 type String note类型 body String 检视意见内容 attachment String 附件 author UserBasicDto object 作者 created_at String 创建时间 updated_at String 更新时间 system Boolean 是否是系统生成的日志 noteable_id Integer 目标id 最小值:1 最大值:2147483647 noteable_type String 目标类型 commit_id String 关联的提交id resolvable Boolean 是否可解决 is_reply Boolean 是否是回复 resolved_by UserBasicDto object 解决人 noteable_iid Integer 目标iid 最小值:1 最大值:2147483647 discussion_id String 讨论id project String 所属项目 diff_file String 变更文件 diff String 变更内容 archived Boolean 是否存档 review_categories String 检视意见分类 review_categories_cn String 检视意见分类中文名 review_categories_en String 检视意见分类英文名 review_modules String 检视意见模块 severity String 严重程度 severity_cn String 严重程度中文名 severity_en String 严重程度英文名 file_path String 文件路径 line String 行号 assignee UserBasicDto object 指派人 proposer UserBasicDto object 提出人 position PositionDto object 关联的代码位置 resolved Boolean 是否解决 is_outdated Boolean 是否过时 表7 PositionDto 参数 参数类型 描述 base_sha String 源分支base提交节点 start_sha String 目标分支最新提交节点 head_sha String 源分支最新提交节点 old_path String 修改前文件路径 new_path String 修改后文件路径 position_type String 变更类型 old_line Integer 修改前行号 new_line Integer 修改后行号 表8 UserBasicDto 参数 参数类型 描述 id Integer 用户id 最小值:1 最大值:2147483647 name String 姓名 username String 用户名 state String 状态 avatar_url String 头像url avatar_path String 头像路径 email String 邮箱 name_cn String 中文名 web_url String 主页 nick_name String 昵称 tenant_name String 租户名称 表9 MergeRequestVersionParamsDto 参数 参数类型 描述 diff_id Integer MR最新变更id 最小值:1 最大值:2147483647 start_sha String 目标分支最新提交 commit_id String 源分支最新提交
  • URI GET /v2/repositories/{repository_id}/merge_requests/{merge_request_iid}/discussions 表1 路径参数 参数 是否必选 参数类型 描述 repository_id 是 String The ID of a project merge_request_iid 是 Integer The ID of the merge request 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String To filter discussions between user and system 枚举值: user system unresolved 否 String To filter unresolved discussions author_id 否 String Filter by author user ID or username page 否 Integer Current page number 缺省值:1 per_page 否 Integer Number of items per page 缺省值:20
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 branch 是 String 分支名 project_id 是 String 项目ID,获取方式请参见获取项目ID。 related_id 是 Array of strings 工作项集合 repo_id 是 String 仓库id
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result ReviewSettingDto object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 ReviewSettingDto 参数 参数类型 描述 categories_and_modules_enabled Boolean 是否开启检视意见分类和模块 secondary_category_enabled Boolean 是否开启二级分类 forbidden_add_to_issue Boolean 是否禁止关联issue primary_categories Array of CategoryDto objects 一级分类 数组长度:0 - 100 review_default_categories Array of strings 默认分类 数组长度:0 - 100 review_customized_categories Array of strings 自定义分类 数组长度:0 - 100 review_modules Array of strings 检视意见模块 数组长度:0 - 100 source_id Integer 目标id 最小值:1 最大值:2147483647 source_type String 目标类型 source_path String 目标路径 secondary_category_type String 二级分类类型 secondary_categories Array of CategoryDto objects 二级分类 表6 CategoryDto 参数 参数类型 描述 key String key name_zh String 中文名 name_en String 英文名 sub_categories Array of CategoryDto objects 二级分类 数组长度:0 - 100
  • 请求示例 GET https://{endpoint}/v2/repositories/{repository_id}/review_setting { "body" : "检视意见标题", "review_categories" : "", "review_modules" : "", "severity" : "suggestion", "assignee_id" : 9124 }
  • 响应示例 状态码: 200 OK { "result" : { "categories_and_modules_enabled" : true, "secondary_category_enabled" : false, "primary_categories" : [ { "key" : "design", "name_zh" : "代码设计", "name_en" : "Code design" }, { "key" : "regulations", "name_zh" : "编程军规问题", "name_en" : "Programming guideline" } ], "review_default_categories" : [ "design", "regulations" ], "review_customized_categories" : [ "xxx", "yyy" ], "review_modules" : [ "aaa", "bbb", "ccc" ], "source_id" : 2111699786, "source_type" : "Project", "source_path" : "DevOpsqlcylxm00004/project-test" }, "status" : "success" }
共100000条