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.

Access to package version deletion

This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.

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

application/vnd.github.package-deletes-preview+json

Previewed schema members:

  • Mutation.deletePackageVersion

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

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

  • UpdateCheckSuitePayload.checkSuite

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

UpdateRefsPreview - Update multiple refs in a single operation.

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

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

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

Previewed schema members:

  • Mutation.updateRefs

  • GitRefname

  • RefUpdate

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

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

Create content attachments

This preview adds support for creating content attachments.

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

application/vnd.github.corsair-preview+json

Previewed schema members:

  • Mutation.createContentAttachment

Pinned Issues Preview

This preview adds support for pinned 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.elektra-preview+json

Previewed schema members:

  • Repository.pinnedIssues

  • PinnedIssue

  • PinnedIssueEdge

  • PinnedIssueConnection

  • Mutation.pinIssue

  • Mutation.unpinIssue

Labels Preview

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

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

application/vnd.github.bane-preview+json

Previewed schema members:

  • Mutation.createLabel

  • Mutation.deleteLabel

  • Mutation.updateLabel

Import Project

This preview adds support for importing projects.

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

application/vnd.github.slothette-preview+json

Previewed schema members:

  • Mutation.importProject

Team Review Assignments Preview

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

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

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

Previewed schema members:

  • Mutation.updateTeamReviewAssignment

  • TeamReviewAssignmentAlgorithm

  • Team.reviewRequestDelegationEnabled

  • Team.reviewRequestDelegationAlgorithm

  • Team.reviewRequestDelegationMemberCount

  • Team.reviewRequestDelegationNotifyTeam