DeleteFile - 删除文件

更新时间:
复制 MD 格式

通过 OpenAPI 删除指定文件。

适用版本

中心版、Region版

服务接入点与授权信息

产品

资源

所需权限

代码管理

文件

读写

请求语法

中心版

DELETE https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/files/{rest:.*}

Region版

DELETE https://{domain}/oapi/v1/codeup/repositories/{repositoryId}/files/{rest:.*}

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

是

个人访问令牌。

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

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

  • 是:中心版

  • 否:Region版

组织 ID。

60d54f3daccf2bbd6659f3ad

repositoryId

string

path

是

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

2813489或者60de7a6852743a5162b5f957%2FDemoRepo

filePath

string

path

是

文件路径,需使用 URL-Encoder 编码进行处理。

test.txt 或者 src%2Fmain.java

branch

string

query

是

分支名称。

master

commitMessage

string

query

是

提交信息。

delete a file

请求示例

中心版

curl -X 'DELETE' \
  'https://{domain}/oapi/v1/codeup/organizations/60d54f3daccf2bbd6659f3ad/repositories/2813489或者60de7a6852743a5162b5f957%2FDemoRepo/files/{rest:.*}?branch=master&commitMessage=delete a file' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'DELETE' \
  'https://{domain}/oapi/v1/codeup/repositories/2813489或者60de7a6852743a5162b5f957%2FDemoRepo/files/{rest:.*}?branch=master&commitMessage=delete a file' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

object

result

boolean

是否执行成功。

true

返回示例

{
    "result": true
}

错误码

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