ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
日本語

製品で調べる

GraphQL API
日本語

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2021-06-09. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

記事のバージョン： Enterprise Server 2.21
記事のバージョン： Enterprise Server 2.21

スキーマプレビュー

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

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

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

スキーマプレビューにアクセスするには、リクエストの Acceptヘッダー内でカスタムのメディアタイプを提供しなければなりません。 各プレビューの機能ドキュメントに、どのカスタムメディアタイプを提供するのかが示されています。

ノート: 現時点では、プレビューのGraphQLスキーマメンバーは、Explorerからはアクセスできません。

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

  • RegistryPackageVersion.deleted

GitHub packages preview

This preview adds support for objects relating to GitHub Packages.

このプレビューを切り替えて以下のスキーマメンバーにアクセスするには、Acceptヘッダー内でカスタムのメディアタイプを渡さなければなりません。

application/vnd.github.packages-preview+json

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

  • Package

  • PackageFile

  • PackageFileOrder

  • PackageFileOrderField

  • PackageOrder

  • PackageOrderField

  • PackageOwner

  • PackageStatistics

  • PackageTag

  • PackageVersion

  • PackageVersionOrder

  • PackageVersionOrderField

  • PackageVersionStatistics

  • Organization.packages

  • PackageMetadatum.packageVersion

  • Repository.packages

  • User.packages

  • PackageConnection.nodes

  • PackageFileConnection.nodes

  • PackageTagConnection.nodes

  • PackageVersionConnection.nodes

  • PackageEdge.node

  • PackageFileEdge.node

  • PackageTagEdge.node

  • PackageVersionEdge.node

  • CreatePackageVersionPayload.packageVersion

  • UpdatePackageVersionPayload.packageVersion

  • CreatePackageFilePayload.packageFile

  • UpdatePackageFilePayload.packageFile

  • CreatePackageVersionMetadataPayload.packageVersion

  • AddPackageTagPayload.package

  • DeletePackageTagPayload.package

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

Checks preview

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

このプレビューを切り替えて以下のスキーマメンバーにアクセスするには、Acceptヘッダー内でカスタムのメディアタイプを渡さなければなりません。

application/vnd.github.antiope-preview+json

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

  • 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.

このプレビューを切り替えて以下のスキーマメンバーにアクセスするには、Acceptヘッダー内でカスタムのメディアタイプを渡さなければなりません。

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

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

  • PullRequest.canBeRebased

  • PullRequest.mergeStateStatus

Update refs 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

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

Create content attachments preview

This preview adds support for creating content attachments.

このプレビューを切り替えて以下のスキーマメンバーにアクセスするには、Acceptヘッダー内でカスタムのメディアタイプを渡さなければなりません。

application/vnd.github.corsair-preview+json

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

  • Mutation.createContentAttachment

Pinned issues preview

This preview adds support for pinned issues.

このプレビューを切り替えて以下のスキーマメンバーにアクセスするには、Acceptヘッダー内でカスタムのメディアタイプを渡さなければなりません。

application/vnd.github.elektra-preview+json

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

  • Repository.pinnedIssues

  • PinnedIssue

  • PinnedIssueEdge

  • PinnedIssueConnection

  • Mutation.pinIssue

  • Mutation.unpinIssue

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

問題がまだ解決していませんか？

GitHubコミュニティで質問するサポートへの連絡