Update a file in a repository

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Path 参数

owner

string

必需

owner of the repo

repo

string

必需

name of the repo

filepath

string

必需

path of the file to update

Body 参数application/json

UpdateFileOptions options for updating files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

author

object (Identity)

可选

Identity for a person's identity like an author or committer

string <email>

可选

name

string

可选

branch

string

可选

branch (optional) to base this file from. if not given, the default branch is used

committer

object (Identity)

可选

Identity for a person's identity like an author or committer

content

string

必需

content must be base64 encoded

dates

object (CommitDateOptions)

可选

CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE

author

string <date-time>

可选

committer

string <date-time>

可选

from_path

string

可选

from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL

message

string

可选

message (optional) for the commit of this file. if not supplied, a default message will be used

new_branch

string

可选

new_branch (optional) will make a new branch from branch before creating the file

sha

string

必需

sha is the SHA for the file that already exists

signoff

boolean

可选

Add a Signed-off-by trailer by the committer at the end of the commit log message.

示例

{
    "author": {
        "email": "user@example.com",
        "name": "string"
    },
    "branch": "string",
    "committer": {
        "email": "user@example.com",
        "name": "string"
    },
    "content": "string",
    "dates": {
        "author": "2019-08-24T14:15:22Z",
        "committer": "2019-08-24T14:15:22Z"
    },
    "from_path": "string",
    "message": "string",
    "new_branch": "string",
    "sha": "string",
    "signoff": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

FileResponse contains information about a repo's file

commit

object (FileCommitResponse contains information generated from a Git commit for a repo's file.)

可选

author

object (CommitUser contains information of a user in the context of a commit.)

可选

committer

object (CommitUser contains information of a user in the context of a commit.)

可选

created

string <date-time>

可选

html_url

string

可选

message

string

可选

parents

array[object (CommitMeta contains meta information of a commit in terms of API.) {3}]

可选

sha

string

可选

tree

object (CommitMeta contains meta information of a commit in terms of API.)

可选

url

string

可选

content

object (ContentsResponse)

可选

ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content

_links

object (FileLinksResponse)

可选

FileLinksResponse contains the links for a repo's file

content

string

可选

content is populated when type is file, otherwise null

download_url

string

可选

encoding

string

可选

encoding is populated when type is file, otherwise null

git_url

string

可选

html_url

string

可选

last_commit_sha

string

可选

name

string

可选

path

string

可选

sha

string

可选

size

integer <int64>

可选

submodule_git_url

string

可选

submodule_git_url is populated when type is submodule, otherwise null

target

string

可选

target is populated when type is symlink, otherwise null

type

string

可选

type will be file, dir, symlink, or submodule

url

string

可选

verification

object (PayloadCommitVerification)

可选

PayloadCommitVerification represents the GPG verification of a commit

payload

string

可选

reason

string

可选

signature

string

可选

signer

object (PayloadUser)

可选

PayloadUser represents the author or committer of a commit

verified

boolean

可选

示例

{
    "commit": {
        "author": {
            "date": "string",
            "email": "user@example.com",
            "name": "string"
        },
        "committer": {
            "date": "string",
            "email": "user@example.com",
            "name": "string"
        },
        "created": "2019-08-24T14:15:22Z",
        "html_url": "string",
        "message": "string",
        "parents": [
            {
                "created": "2019-08-24T14:15:22Z",
                "sha": "string",
                "url": "string"
            }
        ],
        "sha": "string",
        "tree": {
            "created": "2019-08-24T14:15:22Z",
            "sha": "string",
            "url": "string"
        },
        "url": "string"
    },
    "content": {
        "_links": {
            "git": "string",
            "html": "string",
            "self": "string"
        },
        "content": "string",
        "download_url": "string",
        "encoding": "string",
        "git_url": "string",
        "html_url": "string",
        "last_commit_sha": "string",
        "name": "string",
        "path": "string",
        "sha": "string",
        "size": 0,
        "submodule_git_url": "string",
        "target": "string",
        "type": "string",
        "url": "string"
    },
    "verification": {
        "payload": "string",
        "reason": "string",
        "signature": "string",
        "signer": {
            "email": "user@example.com",
            "name": "string",
            "username": "string"
        },
        "verified": true
    }
}

🟠403403

🟠404404

🟠422422