Skip to main content

このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となります: 2024-06-29. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

ミューテーションの種類では、サーバー上のデータを変更する GraphQL 操作を定義します。

この記事の内容

ミューテーションについて

すべてのGraphQLスキーマは、クエリとミューテーションの両方についてルート型を持っています。 ミューテーションの種類では、サーバー上のデータを変更する GraphQL 操作を定義します。 これは、POSTPATCHDELETE などの HTTP 動詞を実行するのと似ています。

詳しくは、「GraphQLでの呼び出しの作成」を参照してください。

abortQueuedMigrations

Clear all of a customer's queued migrations.

abortQueuedMigrations の入力フィールド

abortQueuedMigrations の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

addAssigneesToAssignable

Adds assignees to an assignable object.

addAssigneesToAssignable の入力フィールド

addAssigneesToAssignable の戻り値フィールド

名前説明

assignable (Assignable)

The item that was assigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.

addComment

Adds a comment to an Issue or Pull Request.

addComment の入力フィールド

addComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentEdge (IssueCommentEdge)

The edge from the subject's comment connection.

subject (Node)

The subject.

timelineEdge (IssueTimelineItemEdge)

The edge from the subject's timeline connection.

addDiscussionComment

Adds a comment to a Discussion, possibly as a reply to another comment.

addDiscussionComment の入力フィールド

addDiscussionComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The newly created discussion comment.

addDiscussionPollVote

Vote for an option in a discussion poll.

addDiscussionPollVote の入力フィールド

addDiscussionPollVote の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOption (DiscussionPollOption)

The poll option that a vote was added to.

addEnterpriseAdmin

Adds an administrator to the global enterprise account.

addEnterpriseAdmin の入力フィールド

addEnterpriseAdmin の戻り値フィールド

名前説明

admin (User)

The user who was added as an administrator.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

role (EnterpriseAdministratorRole)

The role of the administrator.

viewer (User)

The viewer performing the mutation.

addEnterpriseOrganizationMember

Adds enterprise members to an organization within the enterprise.

addEnterpriseOrganizationMember の入力フィールド

addEnterpriseOrganizationMember の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

users ([User!])

The users who were added to the organization.

addLabelsToLabelable

Adds labels to a labelable object.

addLabelsToLabelable の入力フィールド

addLabelsToLabelable の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was labeled.

addProjectCard

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

addProjectCard の入力フィールド

addProjectCard の戻り値フィールド

名前説明

cardEdge (ProjectCardEdge)

The edge from the ProjectColumn's card connection.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The ProjectColumn.

addProjectColumn

Adds a column to a Project.

addProjectColumn の入力フィールド

addProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The edge from the project's column connection.

project (Project)

The project.

addProjectV2DraftIssue

Creates a new draft issue and add it to a Project.

addProjectV2DraftIssue の入力フィールド

addProjectV2DraftIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectItem (ProjectV2Item)

The draft issue added to the project.

addProjectV2ItemById

Links an existing content instance to a Project.

addProjectV2ItemById の入力フィールド

addProjectV2ItemById の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item added to the project.

addPullRequestReview

Adds a review to a Pull Request.

addPullRequestReview の入力フィールド

addPullRequestReview の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The newly created pull request review.

reviewEdge (PullRequestReviewEdge)

The edge from the pull request's review connection.

addPullRequestReviewComment

Adds a comment to a review.

addPullRequestReviewComment の入力フィールド

addPullRequestReviewComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created comment.

commentEdge (PullRequestReviewCommentEdge)

The edge from the review's comment connection.

addPullRequestReviewThread

Adds a new thread to a pending Pull Request Review.

addPullRequestReviewThread の入力フィールド

addPullRequestReviewThread の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The newly created thread.

addReaction

Adds a reaction to a subject.

addReaction の入力フィールド

addReaction の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

reactionGroups ([ReactionGroup!])

The reaction groups for the subject.

subject (Reactable)

The reactable subject.

addStar

Adds a star to a Starrable.

addStar の入力フィールド

addStar の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

addUpvote

Add an upvote to a discussion or discussion comment.

addUpvote の入力フィールド

addUpvote の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

addVerifiableDomain

Adds a verifiable domain to an owning account.

addVerifiableDomain の入力フィールド

addVerifiableDomain の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was added.

approveDeployments

Approve all pending deployments under one or more environments.

approveDeployments の入力フィールド

approveDeployments の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

approveVerifiableDomain

Approve a verifiable domain for notification delivery.

approveVerifiableDomain の入力フィールド

approveVerifiableDomain の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was approved.

archiveProjectV2Item

Archives a ProjectV2Item.

archiveProjectV2Item の入力フィールド

archiveProjectV2Item の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item archived from the project.

archiveRepository

Marks a repository as archived.

archiveRepository の入力フィールド

archiveRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was marked as archived.

changeUserStatus

Update your status on GitHub.

changeUserStatus の入力フィールド

changeUserStatus の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

status (UserStatus)

Your updated status.

clearLabelsFromLabelable

Clears all labels from a labelable object.

clearLabelsFromLabelable の入力フィールド

clearLabelsFromLabelable の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The item that was unlabeled.

clearProjectV2ItemFieldValue

This mutation clears the value of a field for an item in a Project. Currently only text, number, date, assignees, labels, single-select, iteration and milestone fields are supported.

clearProjectV2ItemFieldValue の入力フィールド

clearProjectV2ItemFieldValue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

cloneProject

Creates a new project by cloning configuration from an existing project.

cloneProject の入力フィールド

cloneProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

jobStatusId (String)

The id of the JobStatus for populating cloned fields.

project (Project)

The new cloned project.

cloneTemplateRepository

Create a new repository with the same files and directory structure as a template repository.

cloneTemplateRepository の入力フィールド

cloneTemplateRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

closeDiscussion

Close a discussion.

closeDiscussion の入力フィールド

closeDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was closed.

closeIssue

Close an issue.

closeIssue の入力フィールド

closeIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was closed.

closePullRequest

Close a pull request.

closePullRequest の入力フィールド

closePullRequest の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was closed.

convertProjectCardNoteToIssue

Convert a project note card to one associated with a newly created issue.

convertProjectCardNoteToIssue の入力フィールド

convertProjectCardNoteToIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

convertPullRequestToDraft

Converts a pull request to draft.

convertPullRequestToDraft の入力フィールド

convertPullRequestToDraft の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is now a draft.

copyProjectV2

Copy a project.

copyProjectV2 の入力フィールド

copyProjectV2 の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The copied project.

createAttributionInvitation

Invites a user to claim reattributable data.

createAttributionInvitation の入力フィールド

createAttributionInvitation の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (Organization)

The owner scoping the reattributable data.

source (Claimable)

The account owning the data to reattribute.

target (Claimable)

The account which may claim the data.

createBranchProtectionRule

Create a new branch protection rule.

createBranchProtectionRule の入力フィールド

createBranchProtectionRule の戻り値フィールド

名前説明

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckRun

Create a check run.

createCheckRun の入力フィールド

createCheckRun の戻り値フィールド

名前説明

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckSuite

Create a check suite.

createCheckSuite の入力フィールド

createCheckSuite の戻り値フィールド

名前説明

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCommitOnBranch

Appends a commit to the given branch as the authenticated user.

This mutation creates a commit whose parent is the HEAD of the provided branch and also updates that branch to point to the new commit. It can be thought of as similar to git commit.

Locating a Branch

Commits are appended to a branch of type Ref. This must refer to a git branch (i.e. the fully qualified path must begin with refs/heads/, although including this prefix is optional.

Callers may specify the branch to commit to either by its global node ID or by passing both of repositoryNameWithOwner and refName. For more details see the documentation for CommittableBranch.

Describing Changes

fileChanges are specified as a FilesChanges object describing FileAdditions and FileDeletions.

Please see the documentation for FileChanges for more information on how to use this argument to describe any set of file changes.

Authorship

Similar to the web commit interface, this mutation does not support specifying the author or committer of the commit and will not add support for this in the future.

A commit created by a successful execution of this mutation will be authored by the owner of the credential which authenticates the API request. The committer will be identical to that of commits authored using the web interface.

If you need full control over author and committer information, please use the Git Database REST API instead.

Commit Signing

Commits made using this mutation are automatically signed by GitHub if supported and will be marked as verified in the user interface.

createCommitOnBranch の入力フィールド

createCommitOnBranch の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

commit (Commit)

The new commit.

ref (Ref)

The ref which has been updated to point to the new commit.

createDeployment

Creates a new deployment event.

Note

createDeployment is available under the Deployments preview. プレビュー期間中、API は通知なしに変更されることがあります。

createDeployment の入力フィールド

createDeployment の戻り値フィールド

名前説明

autoMerged (Boolean)

True if the default branch has been auto-merged into the deployment ref.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployment (Deployment)

The new deployment.

createDeploymentStatus

Create a deployment status.

Note

createDeploymentStatus is available under the Deployments preview. プレビュー期間中、API は通知なしに変更されることがあります。

createDeploymentStatus の入力フィールド

createDeploymentStatus の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.

createDiscussion

Create a discussion.

createDiscussion の入力フィールド

createDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just created.

createEnterpriseOrganization

Creates an organization as part of an enterprise account.

createEnterpriseOrganization の入力フィールド

createEnterpriseOrganization の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise that owns the created organization.

organization (Organization)

The organization that was created.

createEnvironment

Creates an environment or simply returns it if already exists.

createEnvironment の入力フィールド

createEnvironment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The new or existing environment.

createIpAllowListEntry

Creates a new IP allow list entry.

createIpAllowListEntry の入力フィールド

createIpAllowListEntry の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was created.

createIssue

Creates a new issue.

createIssue の入力フィールド

createIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The new issue.

createLabel

Creates a new label.

Note

createLabel is available under the Labels preview. プレビュー期間中、API は通知なしに変更されることがあります。

createLabel の入力フィールド

createLabel の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The new label.

createLinkedBranch

Create a branch linked to an issue.

createLinkedBranch の入力フィールド

createLinkedBranch の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

linkedBranch (LinkedBranch)

The new branch issue reference.

createMigrationSource

Creates a GitHub Enterprise Importer (GEI) migration source.

createMigrationSource の入力フィールド

createMigrationSource の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationSource (MigrationSource)

The created migration source.

createProject

Creates a new project.

createProject の入力フィールド

createProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.

createProjectV2

Creates a new project.

createProjectV2 の入力フィールド

createProjectV2 の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The new project.

createProjectV2Field

Create a new project field.

createProjectV2Field の入力フィールド

createProjectV2Field の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The new field.

createPullRequest

Create a new pull request.

createPullRequest の入力フィールド

createPullRequest の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.

createRef

Create a new Git Ref.

createRef の入力フィールド

createRef の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The newly created ref.

createRepository

Create a new repository.

createRepository の入力フィールド

createRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The new repository.

createTeamDiscussion

Creates a new team discussion.

createTeamDiscussion の入力フィールド

createTeamDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The new discussion.

createTeamDiscussionComment

Creates a new team discussion comment.

createTeamDiscussionComment の入力フィールド

createTeamDiscussionComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The new comment.

deleteBranchProtectionRule

Delete a branch protection rule.

deleteBranchProtectionRule の入力フィールド

deleteBranchProtectionRule の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDeployment

Deletes a deployment.

deleteDeployment の入力フィールド

deleteDeployment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteDiscussion

Delete a discussion and all of its replies.

deleteDiscussion の入力フィールド

deleteDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just deleted.

deleteDiscussionComment

Delete a discussion comment. If it has replies, wipe it instead.

deleteDiscussionComment の入力フィールド

deleteDiscussionComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The discussion comment that was just deleted.

deleteEnvironment

Deletes an environment.

deleteEnvironment の入力フィールド

deleteEnvironment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteIpAllowListEntry

Deletes an IP allow list entry.

deleteIpAllowListEntry の入力フィールド

deleteIpAllowListEntry の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was deleted.

deleteIssue

Deletes an Issue object.

deleteIssue の入力フィールド

deleteIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the issue belonged to.

deleteIssueComment

Deletes an IssueComment object.

deleteIssueComment の入力フィールド

deleteIssueComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLabel

Deletes a label.

Note

deleteLabel is available under the Labels preview. プレビュー期間中、API は通知なしに変更されることがあります。

deleteLabel の入力フィールド

deleteLabel の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteLinkedBranch

Unlink a branch from an issue.

deleteLinkedBranch の入力フィールド

deleteLinkedBranch の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue the linked branch was unlinked from.

deletePackageVersion

Delete a package version.

Note

deletePackageVersion is available under the Access to package version deletion preview. プレビュー期間中、API は通知なしに変更されることがあります。

deletePackageVersion の入力フィールド

deletePackageVersion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Whether or not the operation succeeded.

deleteProject

Deletes a project.

deleteProject の入力フィールド

deleteProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (ProjectOwner)

The repository or organization the project was removed from.

deleteProjectCard

Deletes a project card.

deleteProjectCard の入力フィールド

deleteProjectCard の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

column (ProjectColumn)

The column the deleted card was in.

deletedCardId (ID)

The deleted card ID.

deleteProjectColumn

Deletes a project column.

deleteProjectColumn の入力フィールド

deleteProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedColumnId (ID)

The deleted column ID.

project (Project)

The project the deleted column was in.

deleteProjectV2

Delete a project.

deleteProjectV2 の入力フィールド

deleteProjectV2 の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The deleted Project.

deleteProjectV2Field

Delete a project field.

deleteProjectV2Field の入力フィールド

deleteProjectV2Field の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The deleted field.

deleteProjectV2Item

Deletes an item from a Project.

deleteProjectV2Item の入力フィールド

deleteProjectV2Item の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedItemId (ID)

The ID of the deleted item.

deleteProjectV2Workflow

Deletes a project workflow.

deleteProjectV2Workflow の入力フィールド

deleteProjectV2Workflow の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedWorkflowId (ID)

The ID of the deleted workflow.

projectV2 (ProjectV2)

The project the deleted workflow was in.

deletePullRequestReview

Deletes a pull request review.

deletePullRequestReview の入力フィールド

deletePullRequestReview の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The deleted pull request review.

deletePullRequestReviewComment

Deletes a pull request review comment.

deletePullRequestReviewComment の入力フィールド

deletePullRequestReviewComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The pull request review the deleted comment belonged to.

pullRequestReviewComment (PullRequestReviewComment)

The deleted pull request review comment.

deleteRef

Delete a Git Ref.

deleteRef の入力フィールド

deleteRef の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussion

Deletes a team discussion.

deleteTeamDiscussion の入力フィールド

deleteTeamDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteTeamDiscussionComment

Deletes a team discussion comment.

deleteTeamDiscussionComment の入力フィールド

deleteTeamDiscussionComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteVerifiableDomain

Deletes a verifiable domain.

deleteVerifiableDomain の入力フィールド

deleteVerifiableDomain の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

The owning account from which the domain was deleted.

disablePullRequestAutoMerge

Disable auto merge on the given pull request.

disablePullRequestAutoMerge の入力フィールド

disablePullRequestAutoMerge の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request auto merge was disabled on.

dismissPullRequestReview

Dismisses an approved or rejected pull request review.

dismissPullRequestReview の入力フィールド

dismissPullRequestReview の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The dismissed pull request review.

dismissRepositoryVulnerabilityAlert

Dismisses the Dependabot alert.

dismissRepositoryVulnerabilityAlert の入力フィールド

dismissRepositoryVulnerabilityAlert の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryVulnerabilityAlert (RepositoryVulnerabilityAlert)

The Dependabot alert that was dismissed.

enablePullRequestAutoMerge

Enable the default auto-merge on a pull request.

enablePullRequestAutoMerge の入力フィールド

enablePullRequestAutoMerge の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request auto-merge was enabled on.

followOrganization

Follow an organization.

followOrganization の入力フィールド

followOrganization の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was followed.

followUser

Follow a user.

followUser の入力フィールド

followUser の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was followed.

grantEnterpriseOrganizationsMigratorRole

Grant the migrator role to a user for all organizations under an enterprise account.

grantEnterpriseOrganizationsMigratorRole の入力フィールド

grantEnterpriseOrganizationsMigratorRole の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role applied to for the given user.

grantMigratorRole

Grant the migrator role to a user or a team.

grantMigratorRole の入力フィールド

grantMigratorRole の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

importProject

Creates a new project by importing columns and a list of issues/PRs.

Note

importProject is available under the Import project preview. プレビュー期間中、API は通知なしに変更されることがあります。

importProject の入力フィールド

importProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new Project!.

linkProjectV2ToRepository

Links a project to a repository.

linkProjectV2ToRepository の入力フィールド

linkProjectV2ToRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is linked to.

linkProjectV2ToTeam

Links a project to a team.

linkProjectV2ToTeam の入力フィールド

linkProjectV2ToTeam の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is linked to.

linkRepositoryToProject

Creates a repository link for a project.

linkRepositoryToProject の入力フィールド

linkRepositoryToProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

lockLockable

Lock a lockable object.

lockLockable の入力フィールド

lockLockable の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockedRecord (Lockable)

The item that was locked.

markDiscussionCommentAsAnswer

Mark a discussion comment as the chosen answer for discussions in an answerable category.

markDiscussionCommentAsAnswer の入力フィールド

markDiscussionCommentAsAnswer の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the chosen comment.

markFileAsViewed

Mark a pull request file as viewed.

markFileAsViewed の入力フィールド

markFileAsViewed の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

markPullRequestReadyForReview

Marks a pull request ready for review.

markPullRequestReadyForReview の入力フィールド

markPullRequestReadyForReview の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is ready for review.

mergeBranch

Merge a head into a branch.

mergeBranch の入力フィールド

mergeBranch の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeCommit (Commit)

The resulting merge Commit.

mergePullRequest

Merge a pull request.

mergePullRequest の入力フィールド

mergePullRequest の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was merged.

minimizeComment

Minimizes a comment on an Issue, Commit, Pull Request, or Gist.

minimizeComment の入力フィールド

minimizeComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

minimizedComment (Minimizable)

The comment that was minimized.

moveProjectCard

Moves a project card to another place.

moveProjectCard の入力フィールド

moveProjectCard の戻り値フィールド

名前説明

cardEdge (ProjectCardEdge)

The new edge of the moved card.

clientMutationId (String)

A unique identifier for the client performing the mutation.

moveProjectColumn

Moves a project column to another place.

moveProjectColumn の入力フィールド

moveProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The new edge of the moved column.

pinIssue

Pin an issue to a repository.

pinIssue の入力フィールド

pinIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was pinned.

regenerateVerifiableDomainToken

Regenerates a verifiable domain's verification token.

regenerateVerifiableDomainToken の入力フィールド

regenerateVerifiableDomainToken の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

verificationToken (String)

The verification token that was generated.

rejectDeployments

Reject all pending deployments under one or more environments.

rejectDeployments の入力フィールド

rejectDeployments の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

removeAssigneesFromAssignable

Removes assignees from an assignable object.

removeAssigneesFromAssignable の入力フィールド

removeAssigneesFromAssignable の戻り値フィールド

名前説明

assignable (Assignable)

The item that was unassigned.

clientMutationId (String)

A unique identifier for the client performing the mutation.

removeEnterpriseAdmin

Removes an administrator from the enterprise.

removeEnterpriseAdmin の入力フィールド

removeEnterpriseAdmin の戻り値フィールド

名前説明

admin (User)

The user who was removed as an administrator.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

message (String)

A message confirming the result of removing an administrator.

viewer (User)

The viewer performing the mutation.

removeLabelsFromLabelable

Removes labels from a Labelable object.

removeLabelsFromLabelable の入力フィールド

removeLabelsFromLabelable の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelable (Labelable)

The Labelable the labels were removed from.

removeOutsideCollaborator

Removes outside collaborator from all repositories in an organization.

removeOutsideCollaborator の入力フィールド

removeOutsideCollaborator の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

removedUser (User)

The user that was removed as an outside collaborator.

removeReaction

Removes a reaction from a subject.

removeReaction の入力フィールド

removeReaction の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

reaction (Reaction)

The reaction object.

reactionGroups ([ReactionGroup!])

The reaction groups for the subject.

subject (Reactable)

The reactable subject.

removeStar

Removes a star from a Starrable.

removeStar の入力フィールド

removeStar の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

removeUpvote

Remove an upvote to a discussion or discussion comment.

removeUpvote の入力フィールド

removeUpvote の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

reopenDiscussion

Reopen a discussion.

reopenDiscussion の入力フィールド

reopenDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was reopened.

reopenIssue

Reopen a issue.

reopenIssue の入力フィールド

reopenIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was opened.

reopenPullRequest

Reopen a pull request.

reopenPullRequest の入力フィールド

reopenPullRequest の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reopened.

requestReviews

Set review requests on a pull request.

requestReviews の入力フィールド

requestReviews の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that is getting requests.

requestedReviewersEdge (UserEdge)

The edge from the pull request to the requested reviewers.

rerequestCheckSuite

Rerequests an existing check suite.

rerequestCheckSuite の入力フィールド

rerequestCheckSuite の戻り値フィールド

名前説明

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

resolveReviewThread

Marks a review thread as resolved.

resolveReviewThread の入力フィールド

resolveReviewThread の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

revertPullRequest

Create a pull request that reverts the changes from a merged pull request.

revertPullRequest の入力フィールド

revertPullRequest の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was reverted.

revertPullRequest (PullRequest)

The new pull request that reverts the input pull request.

revokeEnterpriseOrganizationsMigratorRole

Revoke the migrator role to a user for all organizations under an enterprise account.

revokeEnterpriseOrganizationsMigratorRole の入力フィールド

revokeEnterpriseOrganizationsMigratorRole の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role revoked for the given user.

revokeMigratorRole

Revoke the migrator role from a user or a team.

revokeMigratorRole の入力フィールド

revokeMigratorRole の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Did the operation succeed?.

startOrganizationMigration

Starts a GitHub Enterprise Importer organization migration.

startOrganizationMigration の入力フィールド

startOrganizationMigration の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

orgMigration (OrganizationMigration)

The new organization migration.

startRepositoryMigration

Starts a GitHub Enterprise Importer (GEI) repository migration.

startRepositoryMigration の入力フィールド

startRepositoryMigration の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryMigration (RepositoryMigration)

The new repository migration.

submitPullRequestReview

Submits a pending pull request review.

submitPullRequestReview の入力フィールド

submitPullRequestReview の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The submitted pull request review.

transferIssue

Transfer an issue to a different repository.

transferIssue の入力フィールド

transferIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was transferred.

unarchiveProjectV2Item

Unarchives a ProjectV2Item.

unarchiveProjectV2Item の入力フィールド

unarchiveProjectV2Item の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item unarchived from the project.

unarchiveRepository

Unarchives a repository.

unarchiveRepository の入力フィールド

unarchiveRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was unarchived.

unfollowOrganization

Unfollow an organization.

unfollowOrganization の入力フィールド

unfollowOrganization の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization that was unfollowed.

unfollowUser

Unfollow a user.

unfollowUser の入力フィールド

unfollowUser の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

user (User)

The user that was unfollowed.

unlinkProjectV2FromRepository

Unlinks a project from a repository.

unlinkProjectV2FromRepository の入力フィールド

unlinkProjectV2FromRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is no longer linked to.

unlinkProjectV2FromTeam

Unlinks a project to a team.

unlinkProjectV2FromTeam の入力フィールド

unlinkProjectV2FromTeam の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is unlinked from.

unlinkRepositoryFromProject

Deletes a repository link from a project.

unlinkRepositoryFromProject の入力フィールド

unlinkRepositoryFromProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

unlockLockable

Unlock a lockable object.

unlockLockable の入力フィールド

unlockLockable の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

unlockedRecord (Lockable)

The item that was unlocked.

unmarkDiscussionCommentAsAnswer

Unmark a discussion comment as the chosen answer for discussions in an answerable category.

unmarkDiscussionCommentAsAnswer の入力フィールド

unmarkDiscussionCommentAsAnswer の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the comment.

unmarkFileAsViewed

Unmark a pull request file as viewed.

unmarkFileAsViewed の入力フィールド

unmarkFileAsViewed の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

unmarkIssueAsDuplicate

Unmark an issue as a duplicate of another issue.

unmarkIssueAsDuplicate の入力フィールド

unmarkIssueAsDuplicate の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicate (IssueOrPullRequest)

The issue or pull request that was marked as a duplicate.

unminimizeComment

Unminimizes a comment on an Issue, Commit, Pull Request, or Gist.

unminimizeComment の入力フィールド

unminimizeComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

unminimizedComment (Minimizable)

The comment that was unminimized.

unpinIssue

Unpin a pinned issue from a repository.

unpinIssue の入力フィールド

unpinIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue that was unpinned.

unresolveReviewThread

Marks a review thread as unresolved.

unresolveReviewThread の入力フィールド

unresolveReviewThread の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

thread (PullRequestReviewThread)

The thread to resolve.

updateBranchProtectionRule

Update a branch protection rule.

updateBranchProtectionRule の入力フィールド

updateBranchProtectionRule の戻り値フィールド

名前説明

branchProtectionRule (BranchProtectionRule)

The newly created BranchProtectionRule.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckRun

Update a check run.

updateCheckRun の入力フィールド

updateCheckRun の戻り値フィールド

名前説明

checkRun (CheckRun)

The updated check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckSuitePreferences

Modifies the settings of an existing check suite.

updateCheckSuitePreferences の入力フィールド

updateCheckSuitePreferences の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateDiscussion

Update a discussion.

updateDiscussion の入力フィールド

updateDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The modified discussion.

updateDiscussionComment

Update the contents of a comment on a Discussion.

updateDiscussionComment の入力フィールド

updateDiscussionComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The modified discussion comment.

updateEnterpriseAllowPrivateRepositoryForkingSetting

Sets whether private repository forks are enabled for an enterprise.

updateEnterpriseAllowPrivateRepositoryForkingSetting の入力フィールド

updateEnterpriseAllowPrivateRepositoryForkingSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated allow private repository forking setting.

message (String)

A message confirming the result of updating the allow private repository forking setting.

updateEnterpriseDefaultRepositoryPermissionSetting

Sets the base repository permission for organizations in an enterprise.

updateEnterpriseDefaultRepositoryPermissionSetting の入力フィールド

updateEnterpriseDefaultRepositoryPermissionSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated base repository permission setting.

message (String)

A message confirming the result of updating the base repository permission setting.

updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

Sets whether organization members with admin permissions on a repository can change repository visibility.

updateEnterpriseMembersCanChangeRepositoryVisibilitySetting の入力フィールド

updateEnterpriseMembersCanChangeRepositoryVisibilitySetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can change repository visibility setting.

message (String)

A message confirming the result of updating the members can change repository visibility setting.

updateEnterpriseMembersCanCreateRepositoriesSetting

Sets the members can create repositories setting for an enterprise.

updateEnterpriseMembersCanCreateRepositoriesSetting の入力フィールド

updateEnterpriseMembersCanCreateRepositoriesSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can create repositories setting.

message (String)

A message confirming the result of updating the members can create repositories setting.

updateEnterpriseMembersCanDeleteIssuesSetting

Sets the members can delete issues setting for an enterprise.

updateEnterpriseMembersCanDeleteIssuesSetting の入力フィールド

updateEnterpriseMembersCanDeleteIssuesSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete issues setting.

message (String)

A message confirming the result of updating the members can delete issues setting.

updateEnterpriseMembersCanDeleteRepositoriesSetting

Sets the members can delete repositories setting for an enterprise.

updateEnterpriseMembersCanDeleteRepositoriesSetting の入力フィールド

updateEnterpriseMembersCanDeleteRepositoriesSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete repositories setting.

message (String)

A message confirming the result of updating the members can delete repositories setting.

updateEnterpriseMembersCanInviteCollaboratorsSetting

Sets whether members can invite collaborators are enabled for an enterprise.

updateEnterpriseMembersCanInviteCollaboratorsSetting の入力フィールド

updateEnterpriseMembersCanInviteCollaboratorsSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can invite collaborators setting.

message (String)

A message confirming the result of updating the members can invite collaborators setting.

updateEnterpriseMembersCanMakePurchasesSetting

Sets whether or not an organization admin can make purchases.

updateEnterpriseMembersCanMakePurchasesSetting の入力フィールド

updateEnterpriseMembersCanMakePurchasesSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can make purchases setting.

message (String)

A message confirming the result of updating the members can make purchases setting.

updateEnterpriseMembersCanUpdateProtectedBranchesSetting

Sets the members can update protected branches setting for an enterprise.

updateEnterpriseMembersCanUpdateProtectedBranchesSetting の入力フィールド

updateEnterpriseMembersCanUpdateProtectedBranchesSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can update protected branches setting.

message (String)

A message confirming the result of updating the members can update protected branches setting.

updateEnterpriseMembersCanViewDependencyInsightsSetting

Sets the members can view dependency insights for an enterprise.

updateEnterpriseMembersCanViewDependencyInsightsSetting の入力フィールド

updateEnterpriseMembersCanViewDependencyInsightsSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can view dependency insights setting.

message (String)

A message confirming the result of updating the members can view dependency insights setting.

updateEnterpriseOrganizationProjectsSetting

Sets whether organization projects are enabled for an enterprise.

updateEnterpriseOrganizationProjectsSetting の入力フィールド

updateEnterpriseOrganizationProjectsSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated organization projects setting.

message (String)

A message confirming the result of updating the organization projects setting.

updateEnterpriseOwnerOrganizationRole

Updates the role of an enterprise owner with an organization.

updateEnterpriseOwnerOrganizationRole の入力フィールド

updateEnterpriseOwnerOrganizationRole の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of changing the owner's organization role.

updateEnterpriseProfile

Updates an enterprise's profile.

updateEnterpriseProfile の入力フィールド

updateEnterpriseProfile の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

updateEnterpriseRepositoryProjectsSetting

Sets whether repository projects are enabled for a enterprise.

updateEnterpriseRepositoryProjectsSetting の入力フィールド

updateEnterpriseRepositoryProjectsSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated repository projects setting.

message (String)

A message confirming the result of updating the repository projects setting.

updateEnterpriseTeamDiscussionsSetting

Sets whether team discussions are enabled for an enterprise.

updateEnterpriseTeamDiscussionsSetting の入力フィールド

updateEnterpriseTeamDiscussionsSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated team discussions setting.

message (String)

A message confirming the result of updating the team discussions setting.

updateEnterpriseTwoFactorAuthenticationRequiredSetting

Sets whether two factor authentication is required for all users in an enterprise.

updateEnterpriseTwoFactorAuthenticationRequiredSetting の入力フィールド

updateEnterpriseTwoFactorAuthenticationRequiredSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated two factor authentication required setting.

message (String)

A message confirming the result of updating the two factor authentication required setting.

updateEnvironment

Updates an environment.

updateEnvironment の入力フィールド

updateEnvironment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The updated environment.

updateIpAllowListEnabledSetting

Sets whether an IP allow list is enabled on an owner.

updateIpAllowListEnabledSetting の入力フィールド

updateIpAllowListEnabledSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (IpAllowListOwner)

The IP allow list owner on which the setting was updated.

updateIpAllowListEntry

Updates an IP allow list entry.

updateIpAllowListEntry の入力フィールド

updateIpAllowListEntry の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was updated.

updateIpAllowListForInstalledAppsEnabledSetting

Sets whether IP allow list configuration for installed GitHub Apps is enabled on an owner.

updateIpAllowListForInstalledAppsEnabledSetting の入力フィールド

updateIpAllowListForInstalledAppsEnabledSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (IpAllowListOwner)

The IP allow list owner on which the setting was updated.

updateIssue

Updates an Issue.

updateIssue の入力フィールド

updateIssue の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

issue (Issue)

The issue.

updateIssueComment

Updates an IssueComment object.

updateIssueComment の入力フィールド

updateIssueComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueComment (IssueComment)

The updated comment.

updateLabel

Updates an existing label.

Note

updateLabel is available under the Labels preview. プレビュー期間中、API は通知なしに変更されることがあります。

updateLabel の入力フィールド

updateLabel の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

label (Label)

The updated label.

updateNotificationRestrictionSetting

Update the setting to restrict notifications to only verified or approved domains available to an owner.

updateNotificationRestrictionSetting の入力フィールド

updateNotificationRestrictionSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

The owner on which the setting was updated.

updateOrganizationAllowPrivateRepositoryForkingSetting

Sets whether private repository forks are enabled for an organization.

updateOrganizationAllowPrivateRepositoryForkingSetting の入力フィールド

updateOrganizationAllowPrivateRepositoryForkingSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the allow private repository forking setting.

organization (Organization)

The organization with the updated allow private repository forking setting.

updateOrganizationWebCommitSignoffSetting

Sets whether contributors are required to sign off on web-based commits for repositories in an organization.

updateOrganizationWebCommitSignoffSetting の入力フィールド

updateOrganizationWebCommitSignoffSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the web commit signoff setting.

organization (Organization)

The organization with the updated web commit signoff setting.

updateProject

Updates an existing project.

updateProject の入力フィールド

updateProject の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.

updateProjectCard

Updates an existing project card.

updateProjectCard の入力フィールド

updateProjectCard の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

updateProjectColumn

Updates an existing project column.

updateProjectColumn の入力フィールド

updateProjectColumn の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.

updateProjectV2

Updates an existing project (beta).

updateProjectV2 の入力フィールド

updateProjectV2 の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The updated Project.

updateProjectV2DraftIssue

Updates a draft issue within a Project.

updateProjectV2DraftIssue の入力フィールド

updateProjectV2DraftIssue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssue (DraftIssue)

The draft issue updated in the project.

updateProjectV2ItemFieldValue

This mutation updates the value of a field for an item in a Project. Currently only single-select, text, number, date, and iteration fields are supported.

updateProjectV2ItemFieldValue の入力フィールド

updateProjectV2ItemFieldValue の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

updateProjectV2ItemPosition

This mutation updates the position of the item in the project, where the position represents the priority of an item.

updateProjectV2ItemPosition の入力フィールド

updateProjectV2ItemPosition の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

items (ProjectV2ItemConnection)

The items in the new order.

updatePullRequest

Update a pull request.

updatePullRequest の入力フィールド

updatePullRequest の戻り値フィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

updatePullRequestBranch

Merge or Rebase HEAD from upstream branch into pull request branch.

updatePullRequestBranch の入力フィールド

updatePullRequestBranch の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The updated pull request.

updatePullRequestReview

Updates the body of a pull request review.

updatePullRequestReview の入力フィールド

updatePullRequestReview の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReview (PullRequestReview)

The updated pull request review.

updatePullRequestReviewComment

Updates a pull request review comment.

updatePullRequestReviewComment の入力フィールド

updatePullRequestReviewComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.

updateRef

Update a Git Ref.

updateRef の入力フィールド

updateRef の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ref (Ref)

The updated Ref.

updateRefs

Creates, updates and/or deletes multiple refs in a repository.

This mutation takes a list of RefUpdates and performs these updates on the repository. All updates are performed atomically, meaning that if one of them is rejected, no other ref will be modified.

RefUpdate.beforeOid specifies that the given reference needs to point to the given value before performing any updates. A value of 0000000000000000000000000000000000000000 can be used to verify that the references should not exist.

RefUpdate.afterOid specifies the value that the given reference will point to after performing all updates. A value of 0000000000000000000000000000000000000000 can be used to delete a reference.

If RefUpdate.force is set to true, a non-fast-forward updates for the given reference will be allowed.

Note

updateRefs is available under the Update refs preview update multiple refs in a single operation preview. プレビュー期間中、API は通知なしに変更されることがあります。

updateRefs の入力フィールド

updateRefs の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateRepository

Update information about a repository.

updateRepository の入力フィールド

updateRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

updateRepositoryWebCommitSignoffSetting

Sets whether contributors are required to sign off on web-based commits for a repository.

updateRepositoryWebCommitSignoffSetting の入力フィールド

updateRepositoryWebCommitSignoffSetting の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of updating the web commit signoff setting.

repository (Repository)

The updated repository.

updateSubscription

Updates the state for subscribable subjects.

updateSubscription の入力フィールド

updateSubscription の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.

updateTeamDiscussion

Updates a team discussion.

updateTeamDiscussion の入力フィールド

updateTeamDiscussion の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussion (TeamDiscussion)

The updated discussion.

updateTeamDiscussionComment

Updates a discussion comment.

updateTeamDiscussionComment の入力フィールド

updateTeamDiscussionComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

teamDiscussionComment (TeamDiscussionComment)

The updated comment.

updateTeamReviewAssignment

Updates team review assignment.

Note

updateTeamReviewAssignment is available under the Team review assignments preview. プレビュー期間中、API は通知なしに変更されることがあります。

updateTeamReviewAssignment の入力フィールド

updateTeamReviewAssignment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team that was modified.

updateTeamsRepository

Update team repository.

updateTeamsRepository の入力フィールド

updateTeamsRepository の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository that was updated.

teams ([Team!])

The teams granted permission on the repository.

updateTopics

Replaces the repository's topics with the given topics.

updateTopics の入力フィールド

updateTopics の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invalidTopicNames ([String!])

Names of the provided topics that are not valid.

repository (Repository)

The updated repository.

verifyVerifiableDomain

Verify that a verifiable domain has the expected DNS record.

verifyVerifiableDomain の入力フィールド

verifyVerifiableDomain の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (VerifiableDomain)

The verifiable domain that was verified.