Schema Previews

Schema previews let you try out new features and changes to our GraphQL schema before they become part of the official GitHub API.

During the preview period, we may change some features based on developer feedback. If we do make changes, we'll announce them on the developer blog without advance notice.

To access a schema preview, you'll need to provide a custom media type in the Accept header for your requests. Feature documentation for each preview specifies which custom media type to provide.

Note: The GraphQL schema members under preview cannot be accessed via the Explorer at this time.

Deployments

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

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.flash-preview+json

Previewed schema members:

  • DeploymentStatus.environment

  • Mutation.createDeploymentStatus

  • Mutation.createDeployment

  • DeploymentState.IN_PROGRESS

  • DeploymentState.QUEUED

Checks

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

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.antiope-preview+json

Previewed schema members:

  • 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

Team discussions

Adds support for reading and managing discussions within teams.

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.echo-preview+json

Previewed schema members:

  • 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

Protected Branch: Required Signatures

This preview adds support for reading the required signatures settings of a protected branch.

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.zzzax-preview+json

Previewed schema members:

  • ProtectedBranch.hasRequiredSignatures

Hovercards

This preview adds support for reading hovercard contextual data

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.hagar-preview+json

Previewed schema members:

  • User.hovercard

  • Hovercard

  • HovercardContext

  • GenericHovercardContext

  • OrganizationsHovercardContext

  • OrganizationTeamsHovercardContext

Protected Branch: Multiple Required Approving Reviews

This preview adds support for reading the approving reviews count settings of a protected branch.

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.luke-cage-preview+json

Previewed schema members:

  • ProtectedBranch.requiredApprovingReviewCount

MergeInfoPreview - More detailed information about a pull request's merge state.

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

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

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

Previewed schema members:

  • PullRequest.canBeRebased

  • PullRequest.mergeStateStatus

Access to a Repositories Dependency Graph

This preview adds support for reading a dependency graph for a repository.

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.hawkgirl-preview+json

Previewed schema members:

  • DependencyGraphManifest

  • Repository.dependencyGraphManifests

  • DependencyGraphManifestEdge

  • DependencyGraphManifestConnection

  • DependencyGraphDependency

  • DependencyGraphDependencyEdge

  • DependencyGraphDependencyConnection

  • DependencyGraphPackageRelease.dependencies

Repository Vulnerability Alerts

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

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.vixen-preview+json

Previewed schema members:

  • RepositoryVulnerabilityAlert

  • Repository.vulnerabilityAlerts

  • RepositoryVulnerabilityAlertConnection

  • RepositoryVulnerabilityAlertEdge

Temporary Cloning Token for Private Repositories

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

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.daredevil-preview+json

Previewed schema members:

  • Repository.tempCloneToken

Resolvable Threads Preview

This preview adds support for resolvable threads when interacting with pull request review threads.

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.cateye-preview+json

Previewed schema members:

  • Mutation.resolveReviewThread

  • Mutation.unresolveReviewThread

  • PullRequestReviewThread.isResolved

  • PullRequestReviewThread.resolvedBy

  • PullRequestReviewThread.viewerCanResolve

  • PullRequestReviewThread.viewerCanUnresolve

Project Event Details

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

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.starfox-preview+json

Previewed schema members:

  • AddedToProjectEvent.project

  • AddedToProjectEvent.projectCard

  • AddedToProjectEvent.projectColumnName

  • ConvertedNoteToIssueEvent.project

  • ConvertedNoteToIssueEvent.projectCard

  • ConvertedNoteToIssueEvent.projectColumnName

  • MovedColumnsInProjectEvent.project

  • MovedColumnsInProjectEvent.projectCard

  • MovedColumnsInProjectEvent.projectColumnName

  • MovedColumnsInProjectEvent.previousProjectColumnName

  • RemovedFromProjectEvent.project

  • RemovedFromProjectEvent.projectColumnName

Issues Preview

This preview adds support for a more complete workflow when interacting with issues.

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.starfire-preview+json

Previewed schema members:

  • Mutation.addAssigneesToAssignable

  • Mutation.addLabelsToLabelable

  • Mutation.clearLabelsFromLabelable

  • Mutation.removeAssigneesFromAssignable

  • Mutation.removeLabelsFromLabelable

  • Mutation.updateIssue

  • Mutation.updateIssueComment

  • Mutation.createIssue

  • IssueFilters

  • Label.issues.filterBy

  • Repository.issues.filterBy

  • Milestone.issues.filterBy

  • User.issues.filterBy

  • Mutation.closeIssue

  • Mutation.reopenIssue

  • Issue.timelineItems

  • PullRequest.timelineItems

  • PullRequestCommitCommentThread

  • PullRequestRevisionMarker

  • Mutation.deleteIssueComment

  • Mutation.unmarkIssueAsDuplicate

  • Mutation.convertProjectCardNoteToIssue

Access to GitHub Security Advisories

This preview adds support for accessing security advisories and vulnerabilities published by GitHub.

To toggle this preview and access the following schema members, you must provide a custom media type in the Accept header:

application/vnd.github.heimdall-preview+json

Previewed schema members:

  • Query.securityAdvisory

  • Query.securityAdvisories

  • Query.securityVulnerabilities

  • SecurityAdvisory

  • SecurityAdvisoryConnection

  • SecurityAdvisoryEcosystem

  • SecurityAdvisoryEdge

  • SecurityAdvisoryIdentifier

  • SecurityAdvisoryIdentifierFilter

  • SecurityAdvisoryIdentifierType

  • SecurityAdvisoryOrder

  • SecurityAdvisoryOrderField

  • SecurityAdvisoryPackage

  • SecurityAdvisoryPackageVersion

  • SecurityAdvisoryReference

  • SecurityAdvisorySeverity

  • SecurityVulnerability

  • SecurityVulnerabilityConnection

  • SecurityVulnerabilityEdge

  • SecurityVulnerabilityOrder

  • SecurityVulnerabilityOrderField