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.
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
Draft pull requests preview
This preview adds support for draft pull requests.
To toggle this preview and access the following schema members, you must provide a custom media type in the Accept
header:
application/vnd.github.shadow-cat-preview+json
Previewed schema members:
-
Mutation.markPullRequestReadyForReview
-
CreatePullRequestInput.draft
-
PullRequest.isDraft
Checks preview
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
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
Repository vulnerability alerts preview
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 preview
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
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
Minimize comments preview
This preview adds support for minimizing comments on issues, pull requests, commits, and gists.
To toggle this preview and access the following schema members, you must provide a custom media type in the Accept
header:
application/vnd.github.queen-beryl-preview+json
Previewed schema members:
-
Mutation.minimizeComment
-
Mutation.unminimizeComment
-
Minimizable
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
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 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
Multi line comments preview
This preview adds support for blob-positioned and multi-line comments.
To toggle this preview and access the following schema members, you must provide a custom media type in the Accept
header:
application/vnd.github.comfort-fade-preview+json
Previewed schema members:
-
Mutation.addPullRequestReviewThread
-
AddPullRequestReviewInput.threads
-
DiffSide
-
PullRequestReviewThread.startLine
-
PullRequestReviewThread.originalStartLine
-
PullRequestReviewThread.startDiffSide
-
PullRequestReviewThread.line
-
PullRequestReviewThread.originalLine
-
PullRequestReviewThread.diffSide