文档

CreateCommitWithMultipleFiles - 多文件变更提交

创建一个提交,并能够变更多个文件。一般在日常开发中,一个提交通常会有多个文件变动,当前API就是应用于该情况。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v4/projects/repository/commits/files

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdentitystring

代码库 ID 或者全路径

2835387 或 codeup/codeup-demo
bodyobject

请求 Body

branchstring

代码分支名称

master
commitMessagestring

提交说明信息

auto
actionsobject []

操作数组,每个 action 代表一个文件的操作

actionstring

操作类型

  • create:创建文件
  • delete:删除文件
  • move:移动文件
  • update:更新文件
create
filePathstring

文件路径

src/test.java
previousPathstring

变更前的文件路径

src/main/test.java
contentstring

文件内容

注意 若是更新操作,则是完全覆盖,即传入的 content 内容,会直接覆盖原有的文件内容

xxx

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

A7586FEB-E48D-5579-983F-74981FBFF627
successboolean

调用是否成功

true
errorCodestring

错误码

""
errorMsgstring

错误信息

error
resultobject

返回结果

说明 当前 API 返回的结果为提交信息
idstring

提交 ID

de02b625ba8488f92eb204bcb3773a40c1b4ddac
shortIdstring

Commit 短 ID

de02b625
titlestring

提交标题,提交的第一行内容

提交标题
messagestring

提交内容

具体的提交内容
authorNamestring

作者姓名

test-codeup
authorEmailstring

作者邮箱

username@example.com
authoredDatestring

作者提交时间

2022-03-18 15:00:00
committerNamestring

提交人的姓名

committer-codeup
committerEmailstring

提交人的邮箱

username@example.com
committedDatestring

提交人的提交时间

2022-03-18 16:00:00
parentIdsarray

父提交 ID 列表

string

父提交 ID

ff4fb5ac6d1f44f452654336d2dba468ae6c8d04
createdAtstring

创建时间

2022-03-18 14:24:54
authorobject

作者信息

idlong

Codeup 的用户 ID

19927
aliyunPkstring

阿里云账号 ID

284692704493684695
namestring

用户名称

test-codeup
usernamestring

用户登录名

test-codeup
emailstring

用户邮箱

username@example.com
statestring

用户状态,可选值:

  • active - 可用状态
  • blocked - 废弃或不可用
active
avatarUrlstring

头像地址

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100
websiteUrlstring

用户个人网页地址

""
committerobject

提交者信息

idlong

Codeup 用户 ID

24661
aliyunPkstring

阿里云账号 ID

235671547828975455
namestring

用户名称

committer-codeup
usernamestring

用户登录名

committer-codeup
emailstring

用户邮箱

username@example.com
statestring

用户状态,可选值:

  • active - 可用状态
  • blocked - 废弃或不可用
active
avatarUrlstring

头像地址

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
websiteUrlstring

用户个人网页地址

""

示例

正常返回示例

JSON格式

{
  "requestId": "A7586FEB-E48D-5579-983F-74981FBFF627",
  "success": true,
  "errorCode": "\"\"",
  "errorMsg": "error",
  "result": {
    "id": "de02b625ba8488f92eb204bcb3773a40c1b4ddac",
    "shortId": "de02b625",
    "title": "提交标题",
    "message": "具体的提交内容",
    "authorName": "test-codeup",
    "authorEmail": "username@example.com",
    "authoredDate": "2022-03-18 15:00:00",
    "committerName": "committer-codeup",
    "committerEmail": "username@example.com",
    "committedDate": "2022-03-18 16:00:00",
    "parentIds": [
      "ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 "
    ],
    "createdAt": "2022-03-18 14:24:54",
    "author": {
      "id": 19927,
      "aliyunPk": "284692704493684695",
      "name": "test-codeup",
      "username": "test-codeup",
      "email": "username@example.com",
      "state": "active",
      "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c4ef67f1bea827c4/w/100/h/100",
      "websiteUrl": "\"\""
    },
    "committer": {
      "id": 24661,
      "aliyunPk": "235671547828975455",
      "name": "committer-codeup",
      "username": "committer-codeup",
      "email": "username@example.com",
      "state": "active",
      "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
      "websiteUrl": "\"\""
    }
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈