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

製品で調べる

GraphQL API
日本語 (Japanese)

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

記事のバージョン： Enterprise Server 2.18
GitHub.com Enterprise Server 2.21 Enterprise Server 2.20 Enterprise Server 2.19 Enterprise Server 2.18

スキーマプレビュー

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

ここには以下の内容があります:

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

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

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

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

Audit log preview

This preview adds support for reading Audit Log entries.

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

application/vnd.github.audit-log-preview+json

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

  • AccountPlanChangeAuditEntry.actorLocation

  • BusinessAddOrganizationAuditEntry.actorLocation

  • IssueCommentUpdateAuditEntry.actorLocation

  • OauthApplicationDestroyAuditEntry.actorLocation

  • OauthApplicationResetSecretAuditEntry.actorLocation

  • OauthApplicationRevokeTokensAuditEntry.actorLocation

  • OauthApplicationTransferAuditEntry.actorLocation

  • OrgAcceptBusinessInvitationAuditEntry.actorLocation

  • Organization.auditLog

  • OrgAuditLogExportAuditEntry.actorLocation

  • OrgBillingSignupErrorAuditEntry.actorLocation

  • OrgCancelBusinessInvitationAuditEntry.actorLocation

  • OrgCancelInvitationAuditEntry.actorLocation

  • OrgConfigDisableContributorsOnlyAuditEntry.actorLocation

  • OrgConfigDisableSockpuppetDisallowedAuditEntry.actorLocation

  • OrgConfigEnableContributorsOnlyAuditEntry.actorLocation

  • OrgConfigEnableSockpuppetDisallowedAuditEntry.actorLocation

  • OrgCreateAuditEntry.actorLocation

  • OrgRenameAuditEntry.actorLocation

  • PrivateRepositoryForkingClearAuditEntry.actorLocation

  • ProjectCreateAuditEntry.actorLocation

  • RepoAddTopicAuditEntry.actorLocation

  • RepoArchivedAuditEntry.actorLocation

  • RepoChangeMergeSettingAuditEntry.actorLocation

  • RepoCreateAuditEntry.actorLocation

  • RepoDestroyAuditEntry.actorLocation

  • RepoDisableAuditEntry.actorLocation

  • RepoEnableAuditEntry.actorLocation

  • RepoPagesCnameAuditEntry.actorLocation

  • RepoPagesCreateAuditEntry.actorLocation

  • RepoPagesDestroyAuditEntry.actorLocation

  • RepoPagesHttpsRedirectDisabledAuditEntry.actorLocation

  • RepoPagesHttpsRedirectEnabledAuditEntry.actorLocation

  • RepoPagesSourceAuditEntry.actorLocation

  • RepoRemoveTopicAuditEntry.actorLocation

  • RepoRenameAuditEntry.actorLocation

  • RepositoryVisibilityChangeClearAuditEntry.actorLocation

  • RepoTransferAuditEntry.actorLocation

  • RepoTransferStartAuditEntry.actorLocation

  • RepoUnarchivedAuditEntry.actorLocation

  • RepoUpdateMemberAuditEntry.actorLocation

  • TeamChangePrivacyAuditEntry.actorLocation

  • TeamCreateAuditEntry.actorLocation

  • TeamDeleteAuditEntry.actorLocation

  • TeamDestroyAuditEntry.actorLocation

  • TeamRenameAuditEntry.actorLocation

  • TeamUpdatePermissionAuditEntry.actorLocation

  • TeamUpdateRepositoryPermissionAuditEntry.actorLocation

  • UserAddEmailAuditEntry.actorLocation

  • UserStatusUpdateAuditEntry.actorLocation

  • AuditEntryActor

  • OrganizationAuditEntry

  • OrgRestoreMemberAuditEntryMembership

  • AuditLogOrder

  • AuditEntry

  • EnterpriseAuditEntryData

  • OauthApplicationAuditEntryData

  • OrganizationAuditEntryData

  • RepositoryAuditEntryData

  • TeamAuditEntryData

  • ActorLocation

  • MembersCanDeleteReposClearAuditEntry

  • MembersCanDeleteReposDisableAuditEntry

  • MembersCanDeleteReposEnableAuditEntry

  • OauthApplicationCreateAuditEntry

  • OrgAddBillingManagerAuditEntry

  • OrgAddMemberAuditEntry

  • OrgBlockUserAuditEntry

  • OrgConfigDisableCollaboratorsOnlyAuditEntry

  • OrgConfigEnableCollaboratorsOnlyAuditEntry

  • OrgDisableOauthAppRestrictionsAuditEntry

  • OrgDisableSamlAuditEntry

  • OrgDisableTwoFactorRequirementAuditEntry

  • OrgEnableOauthAppRestrictionsAuditEntry

  • OrgEnableSamlAuditEntry

  • OrgEnableTwoFactorRequirementAuditEntry

  • OrgInviteMemberAuditEntry

  • OrgInviteToBusinessAuditEntry

  • OrgOauthAppAccessApprovedAuditEntry

  • OrgOauthAppAccessDeniedAuditEntry

  • OrgOauthAppAccessRequestedAuditEntry

  • OrgRemoveBillingManagerAuditEntry

  • OrgRemoveMemberAuditEntry

  • OrgRemoveOutsideCollaboratorAuditEntry

  • OrgRestoreMemberAuditEntry

  • OrgRestoreMemberMembershipOrganizationAuditEntryData

  • OrgRestoreMemberMembershipRepositoryAuditEntryData

  • OrgRestoreMemberMembershipTeamAuditEntryData

  • OrgUnblockUserAuditEntry

  • OrgUpdateDefaultRepositoryPermissionAuditEntry

  • OrgUpdateMemberAuditEntry

  • OrgUpdateMemberRepositoryCreationPermissionAuditEntry

  • OrgUpdateMemberRepositoryInvitationPermissionAuditEntry

  • PrivateRepositoryForkingDisableAuditEntry

  • PrivateRepositoryForkingEnableAuditEntry

  • RepoAccessAuditEntry

  • RepoAddMemberAuditEntry

  • RepoConfigDisableAnonymousGitAccessAuditEntry

  • RepoConfigDisableCollaboratorsOnlyAuditEntry

  • RepoConfigDisableContributorsOnlyAuditEntry

  • RepoConfigDisableSockpuppetDisallowedAuditEntry

  • RepoConfigEnableAnonymousGitAccessAuditEntry

  • RepoConfigEnableCollaboratorsOnlyAuditEntry

  • RepoConfigEnableContributorsOnlyAuditEntry

  • RepoConfigEnableSockpuppetDisallowedAuditEntry

  • RepoConfigLockAnonymousGitAccessAuditEntry

  • RepoConfigUnlockAnonymousGitAccessAuditEntry

  • RepoRemoveMemberAuditEntry

  • RepositoryVisibilityChangeDisableAuditEntry

  • RepositoryVisibilityChangeEnableAuditEntry

  • TeamAddMemberAuditEntry

  • TeamAddRepositoryAuditEntry

  • TeamChangeParentTeamAuditEntry

  • TeamRemoveMemberAuditEntry

  • TeamRemoveRepositoryAuditEntry

  • AuditLogOrderField

  • OauthApplicationCreateAuditEntryState

  • OauthApplicationRevokeTokensAuditEntryState

  • OrgAddMemberAuditEntryPermission

  • OrgRemoveBillingManagerAuditEntryReason

  • OrgRemoveMemberAuditEntryMembershipType

  • OrgRemoveMemberAuditEntryReason

  • OrgRemoveOutsideCollaboratorAuditEntryMembershipType

  • OrgRemoveOutsideCollaboratorAuditEntryReason

  • OrgUpdateDefaultRepositoryPermissionAuditEntryPermission

  • OrgUpdateMemberAuditEntryPermission

  • OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility

  • RepoAccessAuditEntryVisibility

  • RepoAddMemberAuditEntryVisibility

  • RepoRemoveMemberAuditEntryVisibility

  • PreciseDateTime

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

Draft pull requests preview

This preview adds support for draft pull requests.

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

application/vnd.github.shadow-cat-preview+json

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

  • Mutation.markPullRequestReadyForReview

  • CreatePullRequestInput.draft

  • PullRequest.isDraft

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

Team discussions preview

Adds support for reading and managing discussions within teams.

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

application/vnd.github.echo-preview+json

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

  • Mutation.createTeamDiscussion

  • Mutation.createTeamDiscussionComment

  • Mutation.deleteTeamDiscussion

  • Mutation.deleteTeamDiscussionComment

  • Mutation.updateTeamDiscussion

  • Mutation.updateTeamDiscussionComment

  • Team.discussion

  • Team.discussions

  • Team.discussionsResourcePath

  • Team.discussionsUrl

  • TeamDiscussion

  • TeamDiscussionComment

  • TeamDiscussionCommentConnection

  • TeamDiscussionCommentEdge

  • TeamDiscussionCommentOrder

  • TeamDiscussionCommentOrderField

  • TeamDiscussionConnection

  • TeamDiscussionEdge

  • TeamDiscussionOrder

  • TeamDiscussionOrderField

Hovercards preview

This preview adds support for reading hovercard contextual data

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

application/vnd.github.hagar-preview+json

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

  • Issue.hovercard

  • PullRequest.hovercard

  • User.hovercard

  • HovercardContext

  • GenericHovercardContext

  • Hovercard

  • OrganizationTeamsHovercardContext

  • OrganizationsHovercardContext

  • ReviewStatusHovercardContext

  • ViewerHovercardContext

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

Repository vulnerability alerts preview

This preview adds support for viewing vulnerability alerts for a repository.

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

application/vnd.github.vixen-preview+json

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

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

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

application/vnd.github.daredevil-preview+json

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

  • Repository.tempCloneToken

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

Minimize comments preview

This preview adds support for minimizing comments on issues, pull requests, commits, and gists.

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

application/vnd.github.queen-beryl-preview+json

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

  • Mutation.minimizeComment

  • Mutation.unminimizeComment

  • Minimizable

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

担当者にお尋ねください

探しているものが見つからなかったでしょうか？

弊社にお問い合わせください

製品

プラットフォーム

サポート

会社