Delete
Removes a file from the repository.
Required scopes: WORKSPACE
, REPOSITORY_WRITE
Resource URL
DELETE /workspaces/:domain/projects/:project_name/repository/contents/:path
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
path Required | String | The file or directory location in the repository. |
project_name Required | String | The name ID of the project. |
POST Parameters
Name | Type | Description |
---|---|---|
message Required | String | The log message of the commit. |
branch | String | The target branch for the commit operation. |
Example
Request
DELETE https://api.buddy.works/workspaces/buddy/projects/company-website/repository/contents/test.txt
JSON
{
"branch": "development",
"message": "delete test.txt"
}
Sample Response
HTTP
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits/a276b914f11f7dfeb88e46375b0b1e51b8c1578c",
"html_url": "https://app.buddy.works/buddy/company-website/repository/commit/a276b914f11f7dfeb88e46375b0b1e51b8c1578c",
"revision": "a276b914f11f7dfeb88e46375b0b1e51b8c1578c",
"author_date": "2016-03-02T12:31:51Z",
"commit_date": "2016-03-02T12:31:51Z",
"message": "delete test.txt",
"committer": {
"url": "https://api.buddy.works/workspaces/buddy/member/1",
"html_url": "https://app.buddy.works/buddy/profile/1",
"id": 1,
"name": "Mike Benson",
"avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png"
},
"author": {
"url": "https://api.buddy.works/workspaces/buddy/member/1",
"html_url": "https://app.buddy.works/buddy/profile/1",
"id": 1,
"name": "Mike Benson",
"avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png"
}
}
Last modified on April 26, 2022