API 预览允许您试用新的 API 以及对现有 API 方法的更改(在它们被纳入正式的 GitHub API 之前)。
在预览期间,我们可以根据开发者的反馈更改某些功能。 如果我们要执行变更,将在开发者博客上宣布消息,不会事先通知。
要访问 API 预览,需要在 Accept
标头中为您的请求提供自定义媒体类型。 每个预览的功能文档可指定要提供的自定义媒体类型。
增强型部署
使用更多信息和更精细的方式更好地控制部署。
自定义媒体类型: ant-man-preview
公布日期: 2016-04-06
反应
管理对提交、议题和注释的反应。
自定义媒体类型: squirrel-girl-preview
公布日期: 2016-05-12 更新日期: 2016-06-07
时间表
获取针对议题或拉取请求的事件列表。
自定义媒体类型: mockingbird-preview
公布日期: 2016-05-23
预接收环境
创建、列出、更新和删除预接收挂钩的环境。
自定义媒体类型: eye-scream-preview
公布日期: 2015-07-29
集成
通过 API 管理集成。
自定义媒体类型: machine-man-preview
公布日期: 2016-09-14
项目
管理项目。
自定义媒体类型: inertia-preview
公布日期: 2016-09-14 更新日期: 2016-10-27
提交搜索
搜索提交。
自定义媒体类型: cloak-preview
公布日期: 2017-01-05
仓库主题
自定义媒体类型: mercy-preview
公布日期: 2017-01-31
行为准则
查看所有行为准则或获取仓库的当前行为准则。
自定义媒体类型: scarlet-witch-preview
全局 web 挂钩
为组织和用户事件类型启用全局 web 挂钩。 此 API 预览仅适用于 GitHub Enterprise Server。
自定义媒体类型: superpro-preview
公布日期: 2017-12-12
添加锁定原因
现在,您可以在锁定议题时添加原因。
自定义媒体类型: sailor-v-preview
公布日期: 2018-01-10
要求签名提交
现在,您可以使用 API 来管理要求在受保护的分支上进行签名提交的设置。
自定义媒体类型: zzzax-preview
公布日期: 2018-02-22
要求多次审批
现在,您可以使用 API 要求多次审批拉取请求。
自定义媒体类型: luke-cage-preview
公布日期: 2018-03-16
检查运行和检查套件 API
允许 GitHub 应用程序对仓库的代码运行外部检查。 更多信息请参阅检查运行和检查套件 API。
自定义媒体类型: antiope-preview
公布日期: 2018-05-07
项目卡详细信息
REST API 对议题事件和议题时间表事件的响应现在可返回项目相关事件的 project_card
字段。
自定义媒体类型: starfox-preview
公布日期: 2018-09-05
部署状态
现在,您可以更新部署状态的 environment
并使用 in_progress
和 queued
状态。 创建部署状态时,现在可以使用 auto_inactive
参数将旧的 production
部署标记为 inactive
。
自定义媒体类型: flash-preview
公布日期: 2018-10-16
仓库创建权限
现在,您可以配置组织成员是否可以创建仓库以及他们可以创建哪些类型的仓库。 更多信息请参阅“更新组织”。
自定义媒体类型: surtur-preview
公布日期: 2019-12-03
内容附件
现在,您可以在 GitHub 中使用 内容附件 API 提供有关链接到注册域的 URL 的更多信息。 更多信息请参阅“使用内容附件”。
自定义媒体类型: corsair-preview
公布日期: 2018-12-10
启用和禁用页面
您可以使用页面 API 中的新端点来启用或禁用页面。 要了解有关页面的更多信息,请参阅“GitHub Pages 基础知识”。
自定义媒体类型: switcheroo-preview
公布日期: 2019-03-14
列出提交的分支或拉取请求
您可以使用提交 API 中的两个新端点来列出提交的分支或拉取请求。
自定义媒体类型: groot-preview
公布日期: 2019-04-11
为仓库启用或禁用漏洞警报
您可以使用仓库 API 中的两个新端点来启用或禁用漏洞警报。
自定义媒体类型: dorian-preview
公布日期: 2019-04-24
更新拉取请求分支
您可以使用新的端点根据上游分支的 HEAD 更改来更新拉取请求分支。
自定义媒体类型: lydian-preview
公布日期: 2019-05-29
创建和使用仓库模板
您可以使用新的端点来利用模板创建仓库,并通过将 is_template
参数设置为 true
,为经过身份验证的用户创建模板仓库。 获取仓库以检查是否使用 is_template
键将其设置为模板仓库。
自定义媒体类型: baptiste-preview
公布日期: 2019-07-05
仓库 API 的新可见性参数
您可以在仓库 API 中设置和检索仓库可见性。
自定义媒体类型: nebula-preview
公布日期: 2019-11-25