Delete a file - GitHub API

Deletes a file in a repository.

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

curl --location --request DELETE 'https://api.github.com/repos///contents/' \ --header 'Content-Type: application/json' \ --data-raw '{ "committer": { "email": "octocat@github.com", "name": "Monalisa Octocat" }, "message": "my commit message", "sha": "329688480d39049927147c162b9d2deaf885005f" }'

{ "commit": { "author": { "date": "string", "email": "string", "name": "string" }, "committer": { "date": "string", "email": "string", "name": "string" }, "html_url": "string", "message": "string", "node_id": "string", "parents": [ { "html_url": "string", "sha": "string", "url": "string" } ], "sha": "string", "tree": { "sha": "string", "url": "string" }, "url": "string", "verification": { "payload": "string", "reason": "string", "signature": "string", "verified": true } }, "content": { "_links": { "git": "string", "html": "string", "self": "string" }, "download_url": "string", "git_url": "string", "html_url": "string", "name": "string", "path": "string", "sha": "string", "size": 0, "type": "string", "url": "string" } }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

path

string

必需

path parameter

Body 参数application/json

author

object

可选

object containing information about the author.

string

可选

The email of the author (or committer) of the commit

name

string

可选

The name of the author (or committer) of the commit

branch

string

可选

The branch name. Default: the repository’s default branch (usually master)

committer

object

可选

object containing information about the committer.

string

可选

The email of the author (or committer) of the commit

name

string

可选

The name of the author (or committer) of the commit

message

string

必需

The commit message.

sha

string

必需

The blob SHA of the file being replaced.

示例

返回响应

🟢200Response

application/json

Body

File Commit

commit

object

必需

author

object

可选

committer

object

可选

html_url

string

可选

message

string

可选

node_id

string

可选

parents

array [object {3}]

可选

sha

string

可选

tree

object

可选

url

string

可选

verification

object

可选

content

object | null

必需

_links

object

可选

download_url

string

可选

git_url

string

可选

html_url

string

可选

name

string

可选

path

string

可选

sha

string

可选

size

integer

可选

type

string

可选

url

string

可选

🟠404404

🟠409409

🟠422422

🔴503503