文件 | 文件 | |
CreateFile | 创建文件 | 创建代码库文件。 |
DeleteFile | 删除文件 | 删除代码库指定文件。 |
UpdateFile | 修改文件 | 修改代码库某个文件。 |
GetFileBlobs | 查询文件内容 | 查询代码库某个文件的具体内容。 |
ListRepositoryTree | 查询文件树 | 查询代码库的文件树。 |
提交 | 提交 | |
GetFileLastCommit | 查询文件最近一次提交信息 | 查询指定文件的最近一次Git提交。 |
GetRepositoryCommit | 查询代码库提交信息 | 查询代码库的单个提交信息。 |
ListRepositoryCommits | 查询代码库提交列表 | 查询代码库的提交历史信息,支持滚动分页。 |
ListRepositoryCommitDiff | 查询代码库单个提交的提交内容 | 根据代码库ID(repositoryId)和SHA值(sha),可选上下文行数参数(contextLine),获取到当前代码库中单个提交的提交内容。 |
CreateCommitWithMultipleFiles | 多文件变更提交 | 创建一个提交,并能够变更多个文件。一般在日常开发中,一个提交通常会有多个文件变动,当前API就是应用于该情况。 |
成员 | 成员 | |
AddRepositoryMember | 增加代码库成员 | 增加代码库成员,以阿里云账号ID(aliyunPk)作为标识,支持以阿里云账号ID批量添加成员(aliyunPks以逗号作为分隔符号)。 |
AddGroupMember | 添加组成员 | 添加代码组的成员。 |
DeleteRepositoryMember | 删除代码库成员 | 根据阿里云账号ID来移除某个指定的代码库成员。 |
DeleteGroupMember | 删除组成员 | 根据阿里云账号ID来删除指定代码组下的某个成员。 |
UpdateRepositoryMember | 更改代码库成员的权限 | 根据代码库ID(repositoryId)、用户ID(userId)以及更新内容,更改当前代码库下对应成员的权限或角色。
注意:后续会将用户ID统一为阿里云账号ID(aliyunPk),请注意关注。 |
UpdateGroupMember | 修改组成员 | 修改组成员,主要是成员的权限修改。 |
ListRepositoryMemberWithInherited | 查询代码库成员列表 | 查询代码库成员列表,无分页。 |
GetProjectMember | 查询代码库成员 | 根据阿里云账号ID(aliyunPk)查询代码库成员信息。 |
ListGroupMember | 查询组成员列表 | 查询代码组下的成员列表,无分页,无排序。 |
仓库 | 仓库 | |
CreateRepository | 创建/导入代码库 | 创建或者导入代码库。 |
DeleteRepository | 删除代码库 | 删除代码库。(为了保证规范性,必须填写删除理由)。 |
UpdateRepository | 更新代码库 | 更新代码库基本信息、常用设置。 |
TriggerRepositoryMirrorSync | 触发仓库同步 | 从其他平台导入到Codeup的仓库,触发Codeup仓库从远程同步。 |
TransferRepository | 转移代码库 | 转移代码库至指定的代码组,其中groupId和repositoryId均可使用全路径。 |
ListRepositories | 查询代码库列表 | 查询代码库列表,支持分页、排序功能,支持关键字搜索,支持归档条件过滤。 |
GetRepository | 查询代码库 | 查询代码库,支持按代码库ID和代码库路径(Path)查询。 |
分支 | 分支 | |
CreateBranch | 创建分支 | 创建代码库分支。 |
CreateProtectdBranch | 创建保护分支 | 创建代码库保护分支。 |
DeleteBranch | 删除分支 | 删除代码库分支。 |
DeleteProtectedBranch | 删除保护分支 | 删除代码库保护分支。 |
UpdateProtectedBranches | 更改保护分支设置 | 更改保护分支设置。 支持对于保护分支规则的详细设置,包括分支、推送规则、合并规则、要求合并前通过代码评审以及要求合并前通过自动化状态检查。 |
GetBranchInfo | 查询分支信息 | 查询代码库分支的信息。 |
ListRepositoryBranches | 查询代码库分支列表 | 查询代码库分支列表。 |
ListProtectedBranches | 查询保护分支列表 | 查询代码库保护分支列表。 |
合并请求 | 合并请求 | |
GetMergeRequest | 查询合并请求 | 查询单个合并请求详情。 |
ListMergeRequests | 查询合并请求列表 | 查询合并请求列表,支持分页、排序和筛选。
该API能同时查询旧版和新版的合并请求,若没有使用过旧版合并请求,或者已经没有旧版合并请求数据,那么直接忽略返回信息中跟旧版合并请求相关的字段。 |
CreateMergeRequest | 创建合并请求 | 创建合并请求。 |
UpdateMergeRequest | 更新合并请求 | 该API仅支持修改合并请求的标题和描述信息。 |
UpdateMergeRequestPersonnel | 更新合并请求的干系人 | 更新合并请求的干系人,包含评审人、订阅人。 |
MergeMergeRequest | 合并合并请求 | 合并当前合并请求。 |
ReviewMergeRequest | 评审合并请求 | 评审合并请求,发表评审意见。 |
CloseMergeRequest | 关闭合并请求 | 关闭指定的合并请求。 |
ReopenMergeRequest | 重新开启合并请求 | 对关闭的合并请求重新打开,其中已合并的合并请求无法执行重新代开操作。 |
ListMergeRequestPatchSets | 查询合并请求版本列表 | 查询合并请求下的所有版本信息,包括合并源的版本和合并目标的版本。 |
GetMergeRequestChangeTree | 查询合并请求Diff统计信息 | 查询合并请求的Diff统计信息,包括总变更文件树、总新增行、总删减行以及每个文件的新增行与删减行。 |
ListMergeRequestFilesReads | 查询合并请求变更文件已读情况 | 查询合并请求变更文件的已读情况,主要获取变更文件的已读人列表。 |
ListMergeRequestComments | 查询合并请求评论列表 | 查询合并请求中的评论列表,不分页。其中,评论仅支持三级结构。 |
CreateComment | 创建合并请求评论 | 创建合并请求评论,可创建整体评论和行内评论。创建的评论层级一般不要超过3层。 |
比较 | 比较 | |
GetCompareDetail | Compare接口 | 比较两个commit(branch和tag本质也是commit),返回两个commit之间的commits列表以及diff内容(可从diff内容中获取到文件变更树)。 |
提交状态 | 提交状态 | |
CreateCommitStatus | 添加提交状态记录 | 给指定的Commit添加一条提交状态记录。 |
ListCommitStatuses | 查询提交状态列表 | 查询提交状态列表,支持分页。 |
检查运行 | 检查运行 | |
CreateCheckRun | 添加检查运行记录 | 添加检查运行记录,仅创建。 |
UpdateCheckRun | 更新检查运行 | 更新check run记录信息,须当前身份与check run的写入人身份一致,才能进行更新。 |
GetCheckRun | 查询检查运行 | 查询单个check run记录。 |
ListCheckRuns | 查询检查运行列表 | 查询check run列表,支持分页功能。 |
标签 | 标签 | |
CreateTag | 创建标签Tag | 创建代码库标签(Tag)。 |
DeleteTag | 删除标签Tag | 删除代码库标签(Tag)。 |
GetRepositoryTag | 查询单个标签信息 | 查询代码库的单个标签信息。 |
ListRepositoryTags | 查询标签列表 | 查询代码库的标签(Tag)列表。 |
类标 | 类标 | |
CreateProjectLabel | 创建类标 | 创建代码库类标。 |
UpdateProjectLabel | 更新类标 | 更新代码库类标信息。 |
DeleteProjectLabel | 删除类标 | 删除代码库类标。 |
ListProjectLabels | 查询类标列表 | 查询代码库类标列表,支持分页、字段排序以及关键字搜索。 |
ListMergeRequestLabels | 查询合并请求类标列表 | 查询指定合并请求下关联的类标列表。 |
LinkMergeRequestLabel | 关联合并请求 | 将类标(Label)关联到合并请求中。 |
Webhook | Webhook | |
AddWebhook | 创建代码库Webhook | 创建代码库Webhook。 |
DeleteRepositoryWebhook | 删除代码库Webhook | 删除代码库下的Webhook。 |
ListRepositoryWebhook | 查询代码仓库的webhook列表 | 批量查询在代码仓库上配置的webhook记录,支持分页功能。 |
代码组 | 代码组 | |
CreateRepositoryGroup | 创建代码组 | 创建代码组。 |
DeleteRepositoryGroup | 删除代码组 | 删除某个指定的代码库。 |
UpdateGroup | 更新代码组信息 | 更新单个代码组信息,以pathWithNamespace作为唯一标识。 |
GetGroupDetail | 查询代码组信息 | 查询指定的某个代码组信息。 |
GetGroupByPath | 查询代码组信息(Path) | 根据代码组全路径查询代码组信息。 |
ListRepositoryGroups | 查询代码组列表 | 查询代码组列表,支持分页、按创建时间和更新时间排序以及关键字搜索。 |
ListGroupRepositories | 查询代码组下的库列表 | 根据代码组ID查询其组下的代码库列表。 |
推送评审 | 推送评审 | |
UpdatePushReviewOnOff | 推送评审模式开关 | 打开或关闭指定代码库的推送评审设置(需要有管理员权限)。 |
推送规则 | 推送规则 | |
CreatePushRule | 创建推送规则 | 创建推送规则。 |
UpdatePushRule | 更新推送规则 | 更新指定的推送规则,更新方式为覆盖式更新,若是新增规则项,需要确保原有的也存在,否则会被新内容覆盖。 |
DeletePushRule | 删除推送规则 | 删除指定的推送规则。 |
GetPushRule | 查询推送规则 | 查询指定的推送规则。 |
ListPushRules | 查询推送规则列表 | 查询指定代码库下的推送规则列表,无分页。 |
部署密钥 | 部署密钥 | |
CreateDeployKey | 创建部署密钥 | 在代码库中创建新的部署密钥。 |
EnableDeployKey | 启用部署密钥 | 启用代码库中已有的部署密钥。 |
SSH密钥 | SSH密钥 | |
CreateUserKey | 创建用户SSH密钥 | 创建当前用户的SSH-Key密钥。 |
DeleteUserKey | 删除指定的SSH密钥 | 为当前用户删除指定的SSH密钥。 |
ListUserKeys | 查询SSH密钥列表 | 查询当前用户的SSH密钥列表。 |
代码搜索 | 代码搜索 | |
ListSearchSourceCode | 搜索代码片段数据 | 根据筛选条件搜索相应的代码片段。 |
ListSearchRepository | 搜索代码仓库数据 | 根据查询条件搜索代码仓库数据。 |
ListSearchCommit | 搜索代码提交数据 | 根据筛选条件搜索提交的相关数据。 |
GetSearchCodePreview | 查询预览代码片段 | 根据文档ID和关键字获取到预览代码片段。 |
企业信息 | 企业信息 | |
GetCodeupOrganization | 查询Codeup仓库所属企业信息 | 根据企业标识(云效企业ID或者企业路径)获取Codeup侧的企业信息。 |
ListOrganizations | 查询用户的企业列表 | 查询当前用户的企业列表。 |
用户 | 用户 | |
GetUserInfo | 查询当前用户信息 | 该接口用于获取Codeup侧的用户信息。 |
审计 | 审计 | |
ListUserResources | 获取用户有权限的资源 | 获取指定用户名下的有权限的代码库和代码组信息,以及角色信息,支持分页,以用户维度进行分页。请注意,仅限企业管理员以上权限的用户可调用。 |
鉴权 | 鉴权 | |
CreateOAuthToken | 创建OAuthToken | 创建OAuthToken(此接口内测中,暂不支持使用)。 |