Create a tree

POST

/repos/{owner}/{repo}/git/trees

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "Create a commit" and "Update a reference."

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///git/trees' \
--header 'Content-Type: application/json' \
--data-raw '{
    "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
    "tree": [
        {
            "mode": "100644",
            "path": "file.rb",
            "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
            "type": "blob"
        }
    ]
}'

响应示例

201 - 示例 1

{
    "sha": "string",
    "tree": [
        {
            "mode": "100644",
            "path": "file.rb",
            "properties": {
                "mode": {
                    "type": "string"
                },
                "path": {
                    "type": "string"
                },
                "sha": {
                    "type": "string"
                },
                "size": {
                    "type": "integer"
                },
                "type": {
                    "type": "string"
                },
                "url": {
                    "type": "string"
                }
            },
            "required": [
                "path",
                "mode",
                "type",
                "sha",
                "url",
                "size"
            ],
            "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
            "size": 30,
            "type": "blob",
            "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
        }
    ],
    "truncated": true,
    "url": "http://example.com"
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

owner

string

必需

repo

string

必需

Body 参数application/json

base_tree

string

可选

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.
If not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

tree

array [object {5}]

必需

Objects (of path, mode, type, and sha) specifying a tree structure.

content

string

可选

The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

mode

enum<string>

可选

The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

枚举值:

100644100755040000160000120000

path

string

可选

The file referenced in the tree.

sha

string | null

可选

The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

type

enum<string>

可选

Either blob, tree, or commit.

枚举值:

blobtreecommit

示例

返回响应

🟢201Response

application/json

Body

The hierarchy between files in a Git repository.

sha

string

必需

tree

array [object {6}]

必需

Objects specifying a tree structure

示例值:

[{"mode":"100644","path":"file.rb","properties":{"mode":{"type":"string"},"path":{"type":"string"},"sha":{"type":"string"},"size":{"type":"integer"},"type":{"type":"string"},"url":{"type":"string"}},"required":["path","mode","type","sha","url","size"],"sha":"44b4fc6d56897b048c772eb4087f854f46256132","size":30,"type":"blob","url":"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"}]

mode

string

可选

示例值:

040000

path

string

可选

示例值:

test/file.rb

sha

string

可选

示例值:

23f6827669e43831def8a7ad935069c8bd418261

size

integer

可选

示例值:

type

string

可选

示例值:

tree

url

string

可选

示例值:

https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261

truncated

boolean

必需

url

string <uri>

必需

🟠403403

🟠404404

🟠422422

修改于 2022-08-24 13:05:06

Get a tag

Get a tree