文档

CreateFile - 创建文件

更新时间:

通过OpenAPI创建代码库文件。

适用版本

企业专属版、企业标准版

服务接入点与授权信息

产品

资源

所需权限

代码管理

文件

读写

请求语法

POST https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/files

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

60de7a6852743a5162b5f957

repositoryId

string

path

代码库 ID 或者 URL-Encoder 编码的全路径。

2080972

-

object

body

branch

string

body

分支名称。

master

commitMessage

string

body

提交信息,非空,不超过102400个字符。

创建xxx文件

content

string

body

文件内容。

""

encoding

string

body

编码规则,可选值{text, base64},默认为 text。

text

filePath

string

body

文件路径,非空,一般不要使用包含特殊符号的文件路径。

/src/main/test.java

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/files' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "branch": "master",
        "commitMessage": "创建xxx文件",
        "content": "",
        "encoding": "text",
        "filePath": "/src/main/test.java"
    }'

返回参数

参数

类型

描述

示例值

-

object

branch

string

分支名称。

master

filePath

string

文件路径。

/src/main/test.java

newOid

string

文件 git object id。

""

返回示例

{
    "branch": "master",
    "filePath": "/src/main/test.java",
    "newOid": ""
}

错误码

访问错误码中心查看 API 相关错误码。