スキーマプレビュー

GitHubのGraphQLスキーマの今後の機能や変更を、GitHubのGraphQL APIに追加される前にプレビューできます。

この記事の内容

スキーマプレビューについて

プレビュー期間中は、開発者からのフィードバックに基づいて機能を変更することがあります。 変更を行う際には、事前の通知なく開発者ブログで発表します。

スキーマ プレビューにアクセスするには、自分の要求の Accept ヘッダーにカスタムのメディアの種類を指定する必要があります。 各プレビューの機能ドキュメントに、どのカスタムメディアタイプを提供するのかが示されています。

Note

プレビュー段階の GraphQL スキーマ メンバーは、現時点ではエクスプローラーからアクセスできません。

Access to package version deletion preview

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

このプレビューを切り替えて次のスキーマ メンバーにアクセスするには、`Accept` ヘッダーにカスタムのメディアの種類を指定する必要があります。

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

プレビューされたスキーマ メンバー:

  • Mutation.deletePackageVersion

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

Merge info preview more detailed information about a pull request's merge state 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

Update refs preview update multiple refs in a single operation preview

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

このプレビューを切り替えて次のスキーマ メンバーにアクセスするには、`Accept` ヘッダーにカスタムのメディアの種類を指定する必要があります。

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

プレビューされたスキーマ メンバー:

  • Mutation.updateRefs
  • GitRefname
  • RefUpdate

Access to a repository's dependency graph preview

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

このプレビューを切り替えて次のスキーマ メンバーにアクセスするには、`Accept` ヘッダーにカスタムのメディアの種類を指定する必要があります。

application/vnd.github.hawkgirl-preview+json

プレビューされたスキーマ メンバー:

  • DependencyGraphManifest
  • Repository.dependencyGraphManifests
  • DependencyGraphManifestEdge
  • DependencyGraphManifestConnection
  • DependencyGraphDependency
  • DependencyGraphDependencyEdge
  • DependencyGraphDependencyConnection

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

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

Team review assignments preview

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

このプレビューを切り替えて次のスキーマ メンバーにアクセスするには、`Accept` ヘッダーにカスタムのメディアの種類を指定する必要があります。

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

プレビューされたスキーマ メンバー:

  • Mutation.updateTeamReviewAssignment
  • TeamReviewAssignmentAlgorithm
  • Team.reviewRequestDelegationEnabled
  • Team.reviewRequestDelegationAlgorithm
  • Team.reviewRequestDelegationMemberCount
  • Team.reviewRequestDelegationNotifyTeam