我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 已停止服务 2021-03-02. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

架构预览

您可以在即将推出的功能和 GitHub GraphQL 架构变更添加至 GitHub GraphQL API 之前预览它们。

本文内容

关于架构预览

在预览期间,我们可以根据开发者的反馈更改某些功能。 如果我们要执行变更,将在开发者博客上宣布消息,不会事先通知。

要访问架构预览,需要在 Accept 标头中为您的请求提供自定义媒体类型。 每个预览的功能文档可指定要提供的自定义媒体类型。

注:目前无法通过 Explorer 访问预览下的 GraphQL 架构成员。

GitHub packages preview

This preview adds support for objects relating to GitHub Packages.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.packages-preview+json

预览的架构成员:

  • Package

  • PackageFile

  • PackageFileOrder

  • PackageFileOrderField

  • PackageOrder

  • PackageOrderField

  • PackageOwner

  • PackageStatistics

  • PackageTag

  • PackageVersion

  • PackageVersionOrder

  • PackageVersionOrderField

  • PackageVersionStatistics

  • Organization.packages

  • PackageMetadatum.packageVersion

  • Repository.packages

  • User.packages

  • PackageConnection.nodes

  • PackageFileConnection.nodes

  • PackageTagConnection.nodes

  • PackageVersionConnection.nodes

  • PackageEdge.node

  • PackageFileEdge.node

  • PackageTagEdge.node

  • PackageVersionEdge.node

  • CreateRegistryPackageFilePayload.packageFile

  • CreateRegistryPackageVersionMetadataPayload.packageVersion

  • CreateRegistryPackageVersionPayload.packageVersion

  • DeleteRegistryPackagePayload.package

  • DeleteRegistryPackageTagPayload.package

  • SetRegistryPackageTagPayload.package

  • UpdateRegistryPackageFilePayload.packageFile

  • UpdateRegistryPackageVersionPayload.packageVersion

  • CreatePackageVersionPayload.packageVersion

  • UpdatePackageVersionPayload.packageVersion

  • CreatePackageFilePayload.packageFile

  • UpdatePackageFilePayload.packageFile

  • CreatePackageVersionMetadataPayload.packageVersion

  • AddPackageTagPayload.package

  • DeletePackageTagPayload.package

Deployments preview

This preview adds support for deployments mutations and new deployments features.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.flash-preview+json

预览的架构成员:

  • DeploymentStatus.environment

  • Mutation.createDeploymentStatus

  • Mutation.createDeployment

Draft pull requests preview

This preview adds support for draft pull requests.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.shadow-cat-preview+json

预览的架构成员:

  • Mutation.markPullRequestReadyForReview

  • CreatePullRequestInput.draft

  • PullRequest.isDraft

Checks preview

This preview adds support for reading checks created by GitHub Apps.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.antiope-preview+json

预览的架构成员:

  • CheckAnnotationRange

  • CheckAnnotationPosition

  • CheckAnnotationSpan

  • CheckAnnotation

  • CheckAnnotationConnection.nodes

  • CheckAnnotationData

  • CheckAnnotationEdge.node

  • CheckAnnotationLevel

  • CheckConclusionState

  • CheckStatusState

  • CheckSuiteAutoTriggerPreference

  • CheckRun

  • CheckRunConnection.nodes

  • CheckRunEdge.node

  • CheckRunAction

  • CheckRunFilter

  • CheckRunOutput

  • CheckRunOutputImage

  • CheckRunType

  • CheckSuite

  • CheckSuiteConnection.nodes

  • CheckSuiteEdge.node

  • CheckSuiteFilter

  • Commit.checkSuites

  • Mutation.createCheckRun

  • Mutation.createCheckSuite

  • Mutation.rerequestCheckSuite

  • Mutation.updateCheckRun

  • Mutation.updateCheckSuitePreferences

  • Push

  • RequestableCheckStatusState

  • UpdateCheckSuitePayload.checkSuite

Merge info preview

This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.merge-info-preview+json

预览的架构成员:

  • PullRequest.canBeRebased

  • PullRequest.mergeStateStatus

Update refs preview

This preview adds support for updating multiple refs in a single operation.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.update-refs-preview+json

预览的架构成员:

  • Mutation.updateRefs

  • GitRefname

  • RefUpdate

Project event details preview

This preview adds project, project card, and project column details to project-related issue events.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.starfox-preview+json

预览的架构成员:

  • AddedToProjectEvent.project

  • AddedToProjectEvent.projectCard

  • AddedToProjectEvent.projectColumnName

  • ConvertedNoteToIssueEvent.project

  • ConvertedNoteToIssueEvent.projectCard

  • ConvertedNoteToIssueEvent.projectColumnName

  • MovedColumnsInProjectEvent.project

  • MovedColumnsInProjectEvent.projectCard

  • MovedColumnsInProjectEvent.projectColumnName

  • MovedColumnsInProjectEvent.previousProjectColumnName

  • RemovedFromProjectEvent.project

  • RemovedFromProjectEvent.projectColumnName

Minimize comments preview

This preview adds support for minimizing comments on issues, pull requests, commits, and gists.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.queen-beryl-preview+json

预览的架构成员:

  • Mutation.minimizeComment

  • Mutation.unminimizeComment

  • Minimizable

Create content attachments preview

This preview adds support for creating content attachments.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.corsair-preview+json

预览的架构成员:

  • Mutation.createContentAttachment

Pinned issues preview

This preview adds support for pinned issues.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.elektra-preview+json

预览的架构成员:

  • Repository.pinnedIssues

  • PinnedIssue

  • PinnedIssueEdge

  • PinnedIssueConnection

  • Mutation.pinIssue

  • Mutation.unpinIssue

Labels preview

This preview adds support for adding, updating, creating and deleting labels.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.bane-preview+json

预览的架构成员:

  • Mutation.createLabel

  • Mutation.deleteLabel

  • Mutation.updateLabel

Import project preview

This preview adds support for importing projects.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.slothette-preview+json

预览的架构成员:

  • Mutation.importProject

Multi line comments preview

This preview adds support for blob-positioned and multi-line comments.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.comfort-fade-preview+json

预览的架构成员:

  • Mutation.addPullRequestReviewThread

  • AddPullRequestReviewInput.threads

  • DiffSide

  • PullRequestReviewThread.startLine

  • PullRequestReviewThread.originalStartLine

  • PullRequestReviewThread.startDiffSide

  • PullRequestReviewThread.line

  • PullRequestReviewThread.originalLine

  • PullRequestReviewThread.diffSide

Team review assignments preview

This preview adds support for updating the settings for team review assignment.

要切换此预览并访问以下架构成员,必须在 Accept 标头中提供自定义媒体类型:

application/vnd.github.stone-crop-preview+json

预览的架构成员:

  • Mutation.updateTeamReviewAssignment

  • TeamReviewAssignmentAlgorithm

  • Team.reviewRequestDelegationEnabled

  • Team.reviewRequestDelegationAlgorithm

  • Team.reviewRequestDelegationMemberCount

  • Team.reviewRequestDelegationNotifyTeam