拉取请求

“拉取请求”分类中的 GraphQL 架构类型参考文档。

在本文中

Mutations

addPullRequestCreationCapBypassUsers

Mutation

Add users to the pull request creation cap bypass list. Bypassed users can create pull requests regardless of the configured cap. Only users with maintainer permissions can manage the bypass list. You can add a maximum of 100 users per request. The bypass list can only hold a maximum of 100 users.

输入 addPullRequestCreationCapBypassUsers 字段

返回 addPullRequestCreationCapBypassUsers 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository with the updated bypass list.

addPullRequestReview

Mutation

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

Mutation

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

Mutation

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.

addPullRequestReviewThreadReply

Mutation

Adds a reply to an existing Pull Request Review Thread.

输入 addPullRequestReviewThreadReply 字段

返回 addPullRequestReviewThreadReply 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (PullRequestReviewComment)

The newly created reply.

archivePullRequest

Mutation

Archive a pull request. Closes, locks, and marks the pull request as archived. Only repository admins can archive pull requests.

输入 archivePullRequest 字段

返回 archivePullRequest 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was archived.

closePullRequest

Mutation

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.

convertPullRequestToDraft

Mutation

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.

createPullRequest

Mutation

Create a new pull request.

输入 createPullRequest 字段

返回 createPullRequest 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The new pull request.

deletePullRequestReview

Mutation

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

Mutation

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.

dequeuePullRequest

Mutation

Remove a pull request from the merge queue.

输入 dequeuePullRequest 字段

返回 dequeuePullRequest 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeQueueEntry (MergeQueueEntry)

The merge queue entry of the dequeued pull request.

disablePullRequestAutoMerge

Mutation

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

Mutation

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.

enablePullRequestAutoMerge

Mutation

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.

enqueuePullRequest

Mutation

Add a pull request to the merge queue.

输入 enqueuePullRequest 字段

返回 enqueuePullRequest 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

mergeQueueEntry (MergeQueueEntry)

The merge queue entry for the enqueued pull request.

markFileAsViewed

Mutation

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

Mutation

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.

mergePullRequest

Mutation

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.

removePullRequestCreationCapBypassUsers

Mutation

Remove users from the pull request creation cap bypass list. Only users with maintainer permissions can manage the bypass list.

输入 removePullRequestCreationCapBypassUsers 字段

返回 removePullRequestCreationCapBypassUsers 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository with the updated bypass list.

reopenPullRequest

Mutation

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

Mutation

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.

requestReviewsByLogin

Mutation

Set review requests on a pull request using login strings instead of IDs.

输入 requestReviewsByLogin 字段

返回 requestReviewsByLogin 字段

名称说明

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.