We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

This version of GitHub Enterprise was discontinued on 2023-01-18. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Schema previews

In this article

You can preview upcoming features and changes to the GitHub GraphQL schema before they are added to the GitHub GraphQL API.

About schema previews

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 preview

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 preview

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

Merge info preview

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

Update refs preview

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

Project event details preview

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 preview

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

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 preview

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