提交的 REST API 端点

签名验证对象

响应将包含一个verification对象，该对象描述了验证提交签名结果。以下字段包含在verification对象中

名称	类型	描述
verified	布尔值	指示 GitHub 是否认为此提交中的签名已验证。
reason	字符串	verified 值的原因。在下表中枚举了可能的值及其含义。
signature	字符串	从提交中提取的签名。
payload	字符串	已签名的值。

以下是verification对象中reason的可能值

值	描述
expired_key	生成签名的密钥已过期。
not_signing_key	生成签名的 GPG 密钥的用法标志中不包含“签名”标志。
gpgverify_error	与签名验证服务通信时出错。
gpgverify_unavailable	签名验证服务当前不可用。
unsigned	对象不包含签名。
unknown_signature_type	在提交中发现了非 PGP 签名。
no_user	提交中的committer电子邮件地址未关联任何用户。
unverified_email	提交中的committer电子邮件地址已关联用户，但该电子邮件地址在其帐户上未经验证。
bad_email	提交中的committer电子邮件地址未包含在生成签名的 PGP 密钥的身份中。
unknown_key	生成签名的密钥尚未在任何用户的帐户中注册。
malformed_signature	解析签名时出错。
invalid	无法使用签名中找到密钥 ID 的密钥对签名进行密码验证。
valid	以上错误均不适用，因此签名被认为已验证。

受保护分支在使用 GitHub Free 和 GitHub Free for Organizations 的公共仓库中可用，在使用 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库中可用。有关更多信息，请参阅 GitHub 帮助文档中的GitHub 产品。

返回所有分支，其中给定的提交 SHA 是 HEAD 或分支的最新提交。

列出将提交引入存储库的已合并拉取请求。如果提交不存在于默认分支中，则仅返回与提交关联的打开的拉取请求。

要列出与分支关联的打开或已合并的拉取请求，您可以将 commit_sha 参数设置为分支名称。

返回单个提交引用的内容。您必须具有存储库的 read 访问权限才能使用此端点。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。这些媒体类型不支持分页查询参数。

• application/vnd.github.diff：返回提交的差异。较大的差异可能会超时并返回 5xx 状态代码。
• application/vnd.github.patch：返回提交的补丁。包含二进制数据的差异将没有 patch 属性。较大的差异可能会超时并返回 5xx 状态代码。
• application/vnd.github.sha：返回提交的 SHA-1 哈希值。您可以使用此端点通过提供本地 SHA-1 引用作为 ETag 来检查远程引用的 SHA-1 哈希值是否与您的本地引用的 SHA-1 哈希值相同。

签名验证对象

响应将包含一个verification对象，该对象描述了验证提交签名结果。以下字段包含在verification对象中

名称	类型	描述
verified	布尔值	指示 GitHub 是否认为此提交中的签名已验证。
reason	字符串	verified 值的原因。在下表中枚举了可能的值及其含义。
signature	字符串	从提交中提取的签名。
payload	字符串	已签名的值。

以下是verification对象中reason的可能值

值	描述
expired_key	生成签名的密钥已过期。
not_signing_key	生成签名的 GPG 密钥的用法标志中不包含“签名”标志。
gpgverify_error	与签名验证服务通信时出错。
gpgverify_unavailable	签名验证服务当前不可用。
unsigned	对象不包含签名。
unknown_signature_type	在提交中发现了非 PGP 签名。
no_user	提交中的committer电子邮件地址未关联任何用户。
unverified_email	提交中的committer电子邮件地址已关联用户，但该电子邮件地址在其帐户上未经验证。
bad_email	提交中的committer电子邮件地址未包含在生成签名的 PGP 密钥的身份中。
unknown_key	生成签名的密钥尚未在任何用户的帐户中注册。
malformed_signature	解析签名时出错。
invalid	无法使用签名中找到密钥 ID 的密钥对签名进行密码验证。
valid	以上错误均不适用，因此签名被认为已验证。

将两个提交相互比较。您可以在同一个存储库中比较 ref（分支或标签）和提交 SHA，或者比较同一个存储库网络中不同存储库中存在的 ref 和提交 SHA，包括 fork 分支。有关如何查看存储库网络的更多信息，请参阅“了解存储库之间的连接”。

此端点等效于运行 git log BASE..HEAD 命令，但它以不同的顺序返回提交。git log BASE..HEAD 命令以相反的时间顺序返回提交，而 API 以时间顺序返回提交。

此端点支持以下自定义媒体类型。有关更多信息，请参阅“媒体类型”。

• application/vnd.github.diff：返回提交的差异。
• application/vnd.github.patch：返回提交的补丁。包含二进制数据的差异将没有 patch 属性。

API 响应包含有关两个提交之间更改的文件的详细信息。这包括更改的状态（如果文件已添加、删除、修改或重命名），以及更改本身的详细信息。例如，状态为 renamed 的文件具有 previous_filename 字段，显示文件的先前文件名，而状态为 modified 的文件具有 patch 字段，显示对文件所做的更改。

在不使用任何分页参数 (per_page 或 page) 调用此端点时，返回的列表限制为 250 个提交，列表中的最后一个提交是整个比较中最新的提交。

处理大型比较

要处理具有大量提交的响应，请使用查询参数 (per_page 或 page) 对结果进行分页。使用分页时

• 更改的文件列表仅显示在结果的第一页上，并且包含整个比较中最多 300 个更改的文件。
• 结果按时间顺序返回，但如果还有更多页的结果，则返回列表中的最后一个提交可能不是整个集合中最新的提交。

有关使用分页的更多信息，请参阅“在 REST API 中使用分页”。

签名验证对象

响应将包含一个 verification 对象，该对象描述了验证提交签名的结果。verification 对象包含以下字段

名称	类型	描述
verified	布尔值	指示 GitHub 是否认为此提交中的签名已验证。
reason	字符串	verified 值的原因。在下表中枚举了可能的值及其含义。
signature	字符串	从提交中提取的签名。
payload	字符串	已签名的值。

以下是verification对象中reason的可能值

值	描述
expired_key	生成签名的密钥已过期。
not_signing_key	生成签名的 GPG 密钥的用法标志中不包含“签名”标志。
gpgverify_error	与签名验证服务通信时出错。
gpgverify_unavailable	签名验证服务当前不可用。
unsigned	对象不包含签名。
unknown_signature_type	在提交中发现了非 PGP 签名。
no_user	提交中的committer电子邮件地址未关联任何用户。
unverified_email	提交中的committer电子邮件地址已关联用户，但该电子邮件地址在其帐户上未经验证。
bad_email	提交中的committer电子邮件地址未包含在生成签名的 PGP 密钥的身份中。
unknown_key	生成签名的密钥尚未在任何用户的帐户中注册。
malformed_signature	解析签名时出错。
invalid	无法使用签名中找到密钥 ID 的密钥对签名进行密码验证。
valid	以上错误均不适用，因此签名被认为已验证。