更新时间:2023-09-12 GMT+08:00

API概览

SSH KEY

接口

说明

获取ssh key列表

获取ssh key列表。

添加ssh key

添加ssh key。

检验私钥是否有拉取代码的权限

检验私钥是否有拉取代码的权限。

Repository

接口

说明

获取分支目录下的文件

获取分支目录下的文件。

获取仓库统计数据

获取仓库统计数据。

获取一个仓库下特定分支的图片文件

获取一个仓库下特定分支的图片文件。

修改被流水线引用的仓库状态

修改被流水线引用的仓库状态。

判断用户是否有仓库的管理员权限

判断用户是否有仓库的管理员权限。

设置仓库是公开状态还是私有状态

设置仓库是公开状态还是私有状态。

获取一个仓库下特定分支指定文件内容

获取一个仓库下特定分支指定文件内容。

获取公开示例模板列表

获取公开示例模板列表。

创建仓库

用指定的名称在指定项目上创建仓库。传入参数:仓库名、模板id、是否导入项目成员、归属项目。

根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url

获取仓库短id,用于获取仓库详情页面url。

根据组名和仓库名查询某仓库某分支对应的提交

根据仓库组名、仓库名和分支获取提交列表。

查询某仓库对应的分支

根据仓库id获取指定仓库的分支列表。

根据仓库id查询仓库某分支对应的提交,提供更多可选参数

根据仓库id查询仓库某分支对应的提交。

添加部署密钥

添加部署密钥。

删除仓库部署密钥

删除仓库部署密钥。

获取仓库上一次的提交统计信息

获取仓库上一次的提交统计信息。

仓库统计

根据仓库短id,查询仓库的代码提交记录统计。

删除仓库

根据仓库32位uuid删除指定的仓库。

查看仓库的创建状态

获取仓库状态。

查询某仓库的标签列表

查询指定仓库对应的分支。

新建标签

新建标签。

查询某个仓库的详细信息

根据仓库UUID获取仓库信息仓库信息。返回 包含id,name,组名,仓库访问URL。

获取代码提交行数

获取指定日期内代码仓指定分支的代码提交行数。

下载仓库

按照指定格式下载仓库。

新建保护分支

新建保护分支。

获取仓库分支列表

获取仓库分支列表。

获取仓库合并请求列表

获取仓库合并请求列表。

获取仓库合并请求详情

获取仓库合并请求详情。

V2Project

接口

说明

查询用户的所有仓库

获取用户的所有仓库信息。

创建项目、仓库

创建项目后,创建仓库组由后台生成方式 传入参数:仓库名、模板id、是否导入项目成员、归属项目。

创建项目并fork仓库

创建仓库后fork仓库 传入参数:仓库名、是否导入项目成员、归属项目。

查询项目下的所有仓库

获取仓库列表,模糊查询支持范围,如果未传入project uuid,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。

分支关联工作项

分支关联工作项。

RepoMenber

接口

说明

获取仓库所有成员记录

获取仓库成员列表,可通过关键字搜索某成员。

添加仓库成员

调用方codehubportal,添加仓库成员。

设置成员在仓库中的角色

给仓库中成员设置仓库的操作权限。

删除仓库成员

删除仓库成员。

Commit

接口

说明

查询某个仓库的提交信息

根据仓库短ID获取提交信息,支持根据文件路径,查询这个路径下所有的commits列表。

创建提交

能够一次提交位于不同目录的多个文件,目录不存在时,能自动创建目录。支持强制覆盖选项,当选择强制覆盖标志为true时,忽略冲突,强制提交。

查询某个仓库的特定提交信息

获取由commit id或分支或标记的名称标识的特定提交。

查询某个仓库的提交差异信息

根据commit id查询提交差异信息。

File

接口

说明

查询某个仓库的文件信息

获取仓库中文件的信息,如名称、大小、内容。请注意,文件内容是Base64编码的。

User

接口

说明

https账号密码校验

判断用户使用 https 上传/下载代码时输入的用户名和密码是否合法。

WebHook

接口

说明

查询指定仓库的webhook

获取仓库webhook。

为指定仓库添加hook

提交代码自动触发编译构建,添加仓库钩子。

删除指定仓库的 hook

提交代码自动触发编译构建,删除仓库钩子。

Project

接口

说明

获取一个项目下可以设置为公开状态的仓库列表

获取一个项目下可以设置为公开状态的仓库列表。

校验指定项目下的仓库名

一般创建仓库时调用。通过传入项目uuid,仓库名,调用CoudeHubAdapter接口,查询数据库来判断仓库是否重名。

v2仓库管理

接口

说明

创建分支

根据仓库id在指定仓库中创建分支。

Discussion

接口

说明

创建MR检视意见

创建MR检视意见。

回复MR检视意见

回复MR检视意见。

获取检视意见设置

获取检视意见设置。