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

按产品浏览

GraphQL API
简体中文 (Simplified Chinese)

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

文章版本： Enterprise Server 2.18
GitHub.com Enterprise Server 2.21 Enterprise Server 2.20 Enterprise Server 2.19 Enterprise Server 2.18

架构预览

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

本文内容

关于架构预览

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

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

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

Audit log preview

This preview adds support for reading Audit Log entries.

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

application/vnd.github.audit-log-preview+json

预览的架构成员：

  • AccountPlanChangeAuditEntry.actorLocation

  • BusinessAddOrganizationAuditEntry.actorLocation

  • IssueCommentUpdateAuditEntry.actorLocation

  • OauthApplicationDestroyAuditEntry.actorLocation

  • OauthApplicationResetSecretAuditEntry.actorLocation

  • OauthApplicationRevokeTokensAuditEntry.actorLocation

  • OauthApplicationTransferAuditEntry.actorLocation

  • OrgAcceptBusinessInvitationAuditEntry.actorLocation

  • Organization.auditLog

  • OrgAuditLogExportAuditEntry.actorLocation

  • OrgBillingSignupErrorAuditEntry.actorLocation

  • OrgCancelBusinessInvitationAuditEntry.actorLocation

  • OrgCancelInvitationAuditEntry.actorLocation

  • OrgConfigDisableContributorsOnlyAuditEntry.actorLocation

  • OrgConfigDisableSockpuppetDisallowedAuditEntry.actorLocation

  • OrgConfigEnableContributorsOnlyAuditEntry.actorLocation

  • OrgConfigEnableSockpuppetDisallowedAuditEntry.actorLocation

  • OrgCreateAuditEntry.actorLocation

  • OrgRenameAuditEntry.actorLocation

  • PrivateRepositoryForkingClearAuditEntry.actorLocation

  • ProjectCreateAuditEntry.actorLocation

  • RepoAddTopicAuditEntry.actorLocation

  • RepoArchivedAuditEntry.actorLocation

  • RepoChangeMergeSettingAuditEntry.actorLocation

  • RepoCreateAuditEntry.actorLocation

  • RepoDestroyAuditEntry.actorLocation

  • RepoDisableAuditEntry.actorLocation

  • RepoEnableAuditEntry.actorLocation

  • RepoPagesCnameAuditEntry.actorLocation

  • RepoPagesCreateAuditEntry.actorLocation

  • RepoPagesDestroyAuditEntry.actorLocation

  • RepoPagesHttpsRedirectDisabledAuditEntry.actorLocation

  • RepoPagesHttpsRedirectEnabledAuditEntry.actorLocation

  • RepoPagesSourceAuditEntry.actorLocation

  • RepoRemoveTopicAuditEntry.actorLocation

  • RepoRenameAuditEntry.actorLocation

  • RepositoryVisibilityChangeClearAuditEntry.actorLocation

  • RepoTransferAuditEntry.actorLocation

  • RepoTransferStartAuditEntry.actorLocation

  • RepoUnarchivedAuditEntry.actorLocation

  • RepoUpdateMemberAuditEntry.actorLocation

  • TeamChangePrivacyAuditEntry.actorLocation

  • TeamCreateAuditEntry.actorLocation

  • TeamDeleteAuditEntry.actorLocation

  • TeamDestroyAuditEntry.actorLocation

  • TeamRenameAuditEntry.actorLocation

  • TeamUpdatePermissionAuditEntry.actorLocation

  • TeamUpdateRepositoryPermissionAuditEntry.actorLocation

  • UserAddEmailAuditEntry.actorLocation

  • UserStatusUpdateAuditEntry.actorLocation

  • AuditEntryActor

  • OrganizationAuditEntry

  • OrgRestoreMemberAuditEntryMembership

  • AuditLogOrder

  • AuditEntry

  • EnterpriseAuditEntryData

  • OauthApplicationAuditEntryData

  • OrganizationAuditEntryData

  • RepositoryAuditEntryData

  • TeamAuditEntryData

  • ActorLocation

  • MembersCanDeleteReposClearAuditEntry

  • MembersCanDeleteReposDisableAuditEntry

  • MembersCanDeleteReposEnableAuditEntry

  • OauthApplicationCreateAuditEntry

  • OrgAddBillingManagerAuditEntry

  • OrgAddMemberAuditEntry

  • OrgBlockUserAuditEntry

  • OrgConfigDisableCollaboratorsOnlyAuditEntry

  • OrgConfigEnableCollaboratorsOnlyAuditEntry

  • OrgDisableOauthAppRestrictionsAuditEntry

  • OrgDisableSamlAuditEntry

  • OrgDisableTwoFactorRequirementAuditEntry

  • OrgEnableOauthAppRestrictionsAuditEntry

  • OrgEnableSamlAuditEntry

  • OrgEnableTwoFactorRequirementAuditEntry

  • OrgInviteMemberAuditEntry

  • OrgInviteToBusinessAuditEntry

  • OrgOauthAppAccessApprovedAuditEntry

  • OrgOauthAppAccessDeniedAuditEntry

  • OrgOauthAppAccessRequestedAuditEntry

  • OrgRemoveBillingManagerAuditEntry

  • OrgRemoveMemberAuditEntry

  • OrgRemoveOutsideCollaboratorAuditEntry

  • OrgRestoreMemberAuditEntry

  • OrgRestoreMemberMembershipOrganizationAuditEntryData

  • OrgRestoreMemberMembershipRepositoryAuditEntryData

  • OrgRestoreMemberMembershipTeamAuditEntryData

  • OrgUnblockUserAuditEntry

  • OrgUpdateDefaultRepositoryPermissionAuditEntry

  • OrgUpdateMemberAuditEntry

  • OrgUpdateMemberRepositoryCreationPermissionAuditEntry

  • OrgUpdateMemberRepositoryInvitationPermissionAuditEntry

  • PrivateRepositoryForkingDisableAuditEntry

  • PrivateRepositoryForkingEnableAuditEntry

  • RepoAccessAuditEntry

  • RepoAddMemberAuditEntry

  • RepoConfigDisableAnonymousGitAccessAuditEntry

  • RepoConfigDisableCollaboratorsOnlyAuditEntry

  • RepoConfigDisableContributorsOnlyAuditEntry

  • RepoConfigDisableSockpuppetDisallowedAuditEntry

  • RepoConfigEnableAnonymousGitAccessAuditEntry

  • RepoConfigEnableCollaboratorsOnlyAuditEntry

  • RepoConfigEnableContributorsOnlyAuditEntry

  • RepoConfigEnableSockpuppetDisallowedAuditEntry

  • RepoConfigLockAnonymousGitAccessAuditEntry

  • RepoConfigUnlockAnonymousGitAccessAuditEntry

  • RepoRemoveMemberAuditEntry

  • RepositoryVisibilityChangeDisableAuditEntry

  • RepositoryVisibilityChangeEnableAuditEntry

  • TeamAddMemberAuditEntry

  • TeamAddRepositoryAuditEntry

  • TeamChangeParentTeamAuditEntry

  • TeamRemoveMemberAuditEntry

  • TeamRemoveRepositoryAuditEntry

  • AuditLogOrderField

  • OauthApplicationCreateAuditEntryState

  • OauthApplicationRevokeTokensAuditEntryState

  • OrgAddMemberAuditEntryPermission

  • OrgRemoveBillingManagerAuditEntryReason

  • OrgRemoveMemberAuditEntryMembershipType

  • OrgRemoveMemberAuditEntryReason

  • OrgRemoveOutsideCollaboratorAuditEntryMembershipType

  • OrgRemoveOutsideCollaboratorAuditEntryReason

  • OrgUpdateDefaultRepositoryPermissionAuditEntryPermission

  • OrgUpdateMemberAuditEntryPermission

  • OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility

  • RepoAccessAuditEntryVisibility

  • RepoAddMemberAuditEntryVisibility

  • RepoRemoveMemberAuditEntryVisibility

  • PreciseDateTime

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

Team discussions preview

Adds support for reading and managing discussions within teams.

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

application/vnd.github.echo-preview+json

预览的架构成员：

  • Mutation.createTeamDiscussion

  • Mutation.createTeamDiscussionComment

  • Mutation.deleteTeamDiscussion

  • Mutation.deleteTeamDiscussionComment

  • Mutation.updateTeamDiscussion

  • Mutation.updateTeamDiscussionComment

  • Team.discussion

  • Team.discussions

  • Team.discussionsResourcePath

  • Team.discussionsUrl

  • TeamDiscussion

  • TeamDiscussionComment

  • TeamDiscussionCommentConnection

  • TeamDiscussionCommentEdge

  • TeamDiscussionCommentOrder

  • TeamDiscussionCommentOrderField

  • TeamDiscussionConnection

  • TeamDiscussionEdge

  • TeamDiscussionOrder

  • TeamDiscussionOrderField

Hovercards preview

This preview adds support for reading hovercard contextual data

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

application/vnd.github.hagar-preview+json

预览的架构成员：

  • Issue.hovercard

  • PullRequest.hovercard

  • User.hovercard

  • HovercardContext

  • GenericHovercardContext

  • Hovercard

  • OrganizationTeamsHovercardContext

  • OrganizationsHovercardContext

  • ReviewStatusHovercardContext

  • ViewerHovercardContext

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

Repository vulnerability alerts preview

This preview adds support for viewing vulnerability alerts for a repository.

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

application/vnd.github.vixen-preview+json

预览的架构成员：

  • RepositoryVulnerabilityAlert

  • Repository.vulnerabilityAlerts

  • RepositoryVulnerabilityAlertConnection

  • RepositoryVulnerabilityAlertEdge

Temporary cloning token for private repositories preview

This preview adds support for accessing a temporary token field for cloning private repositories.

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

application/vnd.github.daredevil-preview+json

预览的架构成员：

  • Repository.tempCloneToken

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

问问别人

找不到要找的内容？

联系我们

产品

平台

支持

公司