Reference documentation for GraphQL schema types in the Pull requests category.

この記事で

Mutations

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.

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.

resolveReviewThread

Mutation

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

Mutation

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.

submitPullRequestReview

Mutation

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.

unarchivePullRequest

Mutation

Unarchive a pull request. Removes the archived flag from the pull request. Does not automatically reopen or unlock the pull request. Only repository admins can unarchive pull requests.

unarchivePullRequest の入力フィールド

unarchivePullRequest の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequest (PullRequest)

The pull request that was unarchived.

unmarkFileAsViewed

Mutation

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.

unresolveReviewThread

Mutation

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.

updatePullRequest

Mutation

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

Mutation

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

Mutation

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

Mutation

Updates a pull request review comment.

updatePullRequestReviewComment の入力フィールド

updatePullRequestReviewComment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewComment (PullRequestReviewComment)

The updated comment.

updateTeamReviewAssignment

Mutation

Updates team review assignment.

updateTeamReviewAssignment の入力フィールド

updateTeamReviewAssignment の戻り値フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team that was modified.

Objects

AddedToMergeQueueEvent

Object

Represents anadded_to_merge_queueevent on a given pull request.

AddedToMergeQueueEvent 実装

AddedToMergeQueueEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enqueuer (User)

The user who added this Pull Request to the merge queue.

id (ID!)

The Node ID of the AddedToMergeQueueEvent object.

mergeQueue (MergeQueue)

The merge queue where this pull request was added to.

pullRequest (PullRequest)

PullRequest referenced by event.

AutomaticBaseChangeFailedEvent

Object

Represents aautomatic_base_change_failedevent on a given pull request.

AutomaticBaseChangeFailedEvent 実装

AutomaticBaseChangeFailedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AutomaticBaseChangeFailedEvent object.

newBase (String!)

The new base for this PR.

oldBase (String!)

The old base for this PR.

pullRequest (PullRequest!)

PullRequest referenced by event.

AutomaticBaseChangeSucceededEvent

Object

Represents aautomatic_base_change_succeededevent on a given pull request.

AutomaticBaseChangeSucceededEvent 実装

AutomaticBaseChangeSucceededEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AutomaticBaseChangeSucceededEvent object.

newBase (String!)

The new base for this PR.

oldBase (String!)

The old base for this PR.

pullRequest (PullRequest!)

PullRequest referenced by event.

AutoMergeDisabledEvent

Object

Represents aauto_merge_disabledevent on a given pull request.

AutoMergeDisabledEvent 実装

AutoMergeDisabledEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

disabler (User)

The user who disabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeDisabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

reason (String)

The reason auto-merge was disabled.

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

AutoMergeEnabledEvent

Object

Represents aauto_merge_enabledevent on a given pull request.

AutoMergeEnabledEvent 実装

AutoMergeEnabledEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutoMergeRequest

Object

Represents an auto-merge request for a pull request.

AutoMergeRequest のフィールド

名前説明

authorEmail (String)

The email address of the author of this auto-merge request.

commitBody (String)

The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

commitHeadline (String)

The commit title of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

enabledAt (DateTime)

When was this auto-merge request was enabled.

enabledBy (Actor)

The actor who created the auto-merge request.

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

AutoRebaseEnabledEvent

Object

Represents aauto_rebase_enabledevent on a given pull request.

AutoRebaseEnabledEvent 実装

AutoRebaseEnabledEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

id (ID!)

The Node ID of the AutoRebaseEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutoSquashEnabledEvent

Object

Represents aauto_squash_enabledevent on a given pull request.

AutoSquashEnabledEvent 実装

AutoSquashEnabledEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

id (ID!)

The Node ID of the AutoSquashEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

BaseRefChangedEvent

Object

Represents abase_ref_changedevent on a given issue or pull request.

BaseRefChangedEvent 実装

BaseRefChangedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the BaseRefChangedEvent object.

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

pullRequest (PullRequest!)

PullRequest referenced by event.

BaseRefDeletedEvent

Object

Represents abase_ref_deletedevent on a given pull request.

BaseRefDeletedEvent 実装

BaseRefDeletedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BaseRefDeletedEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

BaseRefForcePushedEvent

Object

Represents abase_ref_force_pushedevent on a given pull request.

BaseRefForcePushedEvent 実装

BaseRefForcePushedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the BaseRefForcePushedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

ConvertedFromDraftEvent

Object

Represents aconverted_from_draftevent on a given issue or pull request.

ConvertedFromDraftEvent 実装

ConvertedFromDraftEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ConvertedFromDraftEvent object.

project (ProjectV2)

Project referenced by event.

wasAutomated (Boolean!)

Did this event result from workflow automation?.

ConvertToDraftEvent

Object

Represents aconvert_to_draftevent on a given pull request.

ConvertToDraftEvent 実装

ConvertToDraftEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ConvertToDraftEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

resourcePath (URI!)

The HTTP path for this convert to draft event.

url (URI!)

The HTTP URL for this convert to draft event.

CopilotCodeReviewParameters

Object

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.

CopilotCodeReviewParameters のフィールド

名前説明

reviewDraftPullRequests (Boolean!)

Copilot automatically reviews draft pull requests before they are marked as ready for review.

reviewOnPush (Boolean!)

Copilot automatically reviews each new push to the pull request.

HeadRefDeletedEvent

Object

Represents ahead_ref_deletedevent on a given pull request.

HeadRefDeletedEvent 実装

HeadRefDeletedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

id (ID!)

The Node ID of the HeadRefDeletedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

HeadRefForcePushedEvent

Object

Represents ahead_ref_force_pushedevent on a given pull request.

HeadRefForcePushedEvent 実装

HeadRefForcePushedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the HeadRefForcePushedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

HeadRefRestoredEvent

Object

Represents ahead_ref_restoredevent on a given pull request.

HeadRefRestoredEvent 実装

HeadRefRestoredEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the HeadRefRestoredEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

MergedEvent

Object

Represents amergedevent on a given pull request.

MergedEvent 実装

MergedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

commit (Commit)

Identifies the commit associated with the merge event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the MergedEvent object.

mergeRef (Ref)

Identifies the Ref associated with the merge event.

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

pullRequest (PullRequest!)

PullRequest referenced by event.

resourcePath (URI!)

The HTTP path for this merged event.

url (URI!)

The HTTP URL for this merged event.

MergeQueue

Object

The queue of pull request entries to be merged into a protected branch in a repository.

MergeQueue 実装

MergeQueue のフィールド

名前説明

configuration (MergeQueueConfiguration)

The configuration for this merge queue.

entries (MergeQueueEntryConnection)

The entries in the queue.

entries の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

id (ID!)

The Node ID of the MergeQueue object.

nextEntryEstimatedTimeToMerge (Int)

The estimated time in seconds until a newly added entry would be merged.

repository (Repository)

The repository this merge queue belongs to.

resourcePath (URI!)

The HTTP path for this merge queue.

url (URI!)

The HTTP URL for this merge queue.

MergeQueueConfiguration

Object

Configuration for a MergeQueue.

MergeQueueConfiguration のフィールド

名前説明

checkResponseTimeout (Int)

The amount of time in minutes to wait for a check response before considering it a failure.

maximumEntriesToBuild (Int)

The maximum number of entries to build at once.

maximumEntriesToMerge (Int)

The maximum number of entries to merge at once.

mergeMethod (PullRequestMergeMethod)

The merge method to use for this queue.

mergingStrategy (MergeQueueMergingStrategy)

The strategy to use when merging entries.

minimumEntriesToMerge (Int)

The minimum number of entries required to merge at once.

minimumEntriesToMergeWaitTime (Int)

The amount of time in minutes to wait before ignoring the minumum number of entries in the queue requirement and merging a collection of entries.

MergeQueueEntry

Object

Entries in a MergeQueue.

MergeQueueEntry 実装

MergeQueueEntry のフィールド

名前説明

baseCommit (Commit)

The base commit for this entry.

enqueuedAt (DateTime!)

The date and time this entry was added to the merge queue.

enqueuer (Actor!)

The actor that enqueued this entry.

estimatedTimeToMerge (Int)

The estimated time in seconds until this entry will be merged.

headCommit (Commit)

The head commit for this entry.

id (ID!)

The Node ID of the MergeQueueEntry object.

jump (Boolean!)

Whether this pull request should jump the queue.

mergeQueue (MergeQueue)

The merge queue that this entry belongs to.

position (Int!)

The position of this entry in the queue.

pullRequest (PullRequest)

The pull request that will be added to a merge group.

solo (Boolean!)

Does this pull request need to be deployed on its own.

state (MergeQueueEntryState!)

The state of this entry in the queue.

MergeQueueEntryConnection

Object

The connection type for MergeQueueEntry.

MergeQueueEntryConnection のフィールド

名前説明

edges ([MergeQueueEntryEdge])

A list of edges.

nodes ([MergeQueueEntry])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

MergeQueueEntryEdge

Object

An edge in a connection.

MergeQueueEntryEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (MergeQueueEntry)

The item at the end of the edge.

MergeQueueParameters

Object

Merges must be performed via a merge queue.

MergeQueueParameters のフィールド

名前説明

checkResponseTimeoutMinutes (Int!)

Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed.

groupingStrategy (MergeQueueGroupingStrategy!)

When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.

maxEntriesToBuild (Int!)

Limit the number of queued pull requests requesting checks and workflow runs at the same time.

maxEntriesToMerge (Int!)

The maximum number of PRs that will be merged together in a group.

mergeMethod (MergeQueueMergeMethod!)

Method to use when merging changes from queued pull requests.

minEntriesToMerge (Int!)

The minimum number of PRs that will be merged together in a group.

minEntriesToMergeWaitMinutes (Int!)

The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

PullRequest

Object

A repository pull request.

PullRequest 実装

PullRequest のフィールド

名前説明

activeLockReason (LockReason)

Reason that the conversation was locked.

additions (Int!)

The number of additions in this pull request.

assignedActors (AssigneeConnection!)

A list of actors assigned to this object.

assignedActors の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

assignees (UserConnection!)

A list of Users assigned to this object.

assignees の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

baseRef (Ref)

Identifies the base Ref associated with the pull request.

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

baseRepository (Repository)

The repository associated with this pull request's base Ref.

body (String!)

The body as Markdown.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

changedFiles (Int!)

The number of changed files in this pull request.

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

closed (Boolean!)

true if the pull request is closed.

closedAt (DateTime)

Identifies the date and time when the object was closed.

closingIssuesReferences (IssueConnection)

List of issues that may be closed by this pull request.

closingIssuesReferences の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (IssueOrder)

    Ordering options for issues returned from the connection.

  • userLinkedOnly (Boolean)

    Return only manually linked Issues.

    The default value is false.

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

comments の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (IssueCommentOrder)

    Ordering options for issue comments returned from the connection.

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

commits の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2024-07-01 UTC.

deletions (Int!)

The number of deletions in this pull request.

editor (Actor)

The actor who edited this pull request's body.

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

files の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

headRef (Ref)

Identifies the head Ref associated with the pull request.

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

headRepository (Repository)

The repository associated with this pull request's head Ref.

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

hovercard (Hovercard!)

The hovercard information for this issue.

hovercard の引数

  • includeNotificationContexts (Boolean)

    Whether or not to include notification contexts.

    The default value is true.

id (ID!)

The Node ID of the PullRequest object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isCrossRepository (Boolean!)

The head and base repositories are different.

isDraft (Boolean!)

Identifies if the pull request is a draft.

isInMergeQueue (Boolean!)

Indicates whether the pull request is in a merge queue.

isMergeQueueEnabled (Boolean!)

Indicates whether the pull request's base ref has a merge queue enabled.

isReadByViewer (Boolean)

Is this pull request read by the viewer.

labels (LabelConnection)

A list of labels associated with the object.

labels の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (LabelOrder)

    Ordering options for labels returned from the connection.

lastEditedAt (DateTime)

The moment the editor made the last edit.

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

latestOpinionatedReviews の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • writersOnly (Boolean)

    Only return reviews from user who have write access to the repository.

    The default value is false.

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

latestReviews の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

locked (Boolean!)

true if the pull request is locked.

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

mergeCommit (Commit)

The commit that was created when this pull request was merged.

mergeQueue (MergeQueue)

The merge queue for the pull request's base branch.

mergeQueueEntry (MergeQueueEntry)

The merge queue entry of the pull request in the base branch's merge queue.

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

merged (Boolean!)

Whether or not the pull request was merged.

mergedAt (DateTime)

The date and time that the pull request was merged.

mergedBy (Actor)

The actor who merged the pull request.

milestone (Milestone)

Identifies the milestone associated with the pull request.

number (Int!)

Identifies the pull request number.

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

participants の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

permalink (URI!)

The permalink to the pull request.

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request.

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

警告

projectCards is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

projectCards の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

projectItems (ProjectV2ItemConnection)

List of project items associated with this pull request.

projectItems の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • includeArchived (Boolean)

    Include archived items.

    The default value is true.

  • last (Int)

    Returns the last n elements from the list.

projectV2 (ProjectV2)

Find a project by number.

projectV2 の引数

  • number (Int!)

    The project number.

projectsV2 (ProjectV2Connection!)

A list of projects under the owner.

projectsV2 の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    A project to search for under the owner.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

reactions の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path for this pull request.

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

revertUrl (URI!)

The HTTP URL for reverting this pull request.

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

reviewRequests の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

reviewThreads の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

reviews の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • author (String)

    Filter by author of the review.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

state (PullRequestState!)

Identifies the state of the pull request.

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for the PR's head ref.

suggestedActors (AssigneeConnection!)

A list of suggested actors to assign to this object.

suggestedActors の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    If provided, searches users by login or profile name.

suggestedReviewerActors (SuggestedReviewerActorConnection!)

Reviewer actor suggestions based on commit history, past review comments, and integrations.

suggestedReviewerActors の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    Search actors with query on user name and login.

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

警告

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

timeline の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • since (DateTime)

    Allows filtering timeline events by a since timestamp.

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

timelineItems の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • since (DateTime)

    Filter timeline items by a since timestamp.

  • skip (Int)

    Skips the first n elements in the list.

title (String!)

Identifies the pull request title.

titleHTML (HTML!)

Identifies the pull request title rendered to HTML.

totalCommentsCount (Int)

Returns a count of how many comments this pull request has received.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this pull request.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

userContentEdits の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

viewerCanClose (Boolean!)

Indicates if the object can be closed by the viewer.

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

viewerCanEditFiles (Boolean!)

Can the viewer edit files within this pull request.

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

viewerCanLabel (Boolean!)

Indicates if the viewer can edit labels for this object.

viewerCanMergeAsAdmin (Boolean!)

Indicates whether the viewer can bypass branch protections and merge the pull request immediately.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanReopen (Boolean!)

Indicates if the object can be reopened by the viewer.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCanUpdateBranch (Boolean!)

Whether or not the viewer can update the head ref of this PR, by merging or rebasing the base ref. If the head ref is up to date or unable to be updated by this user, this will return false.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerLatestReview (PullRequestReview)

The latest review given from the viewer.

viewerLatestReviewRequest (ReviewRequest)

The person who has requested the viewer for review on this pull request.

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

viewerMergeBodyText の引数

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

viewerMergeHeadlineText の引数

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

PullRequestChangedFile

Object

A file changed in a pull request.

PullRequestChangedFile のフィールド

名前説明

additions (Int!)

The number of additions to the file.

changeType (PatchStatus!)

How the file was changed in this PullRequest.

deletions (Int!)

The number of deletions to the file.

path (String!)

The path of the file.

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

PullRequestChangedFileConnection

Object

The connection type for PullRequestChangedFile.

PullRequestChangedFileConnection のフィールド

名前説明

edges ([PullRequestChangedFileEdge])

A list of edges.

nodes ([PullRequestChangedFile])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PullRequestChangedFileEdge

Object

An edge in a connection.

PullRequestChangedFileEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequestChangedFile)

The item at the end of the edge.

PullRequestCommit

Object

Represents a Git commit part of a pull request.

PullRequestCommit 実装

PullRequestCommit のフィールド

名前説明

commit (Commit!)

The Git commit object.

id (ID!)

The Node ID of the PullRequestCommit object.

pullRequest (PullRequest!)

The pull request this commit belongs to.

resourcePath (URI!)

The HTTP path for this pull request commit.

url (URI!)

The HTTP URL for this pull request commit.

PullRequestCommitCommentThread

Object

Represents a commit comment thread part of a pull request.

PullRequestCommitCommentThread 実装

PullRequestCommitCommentThread のフィールド

名前説明

comments (CommitCommentConnection!)

The comments that exist in this thread.

comments の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commit (Commit!)

The commit the comments were made on.

id (ID!)

The Node ID of the PullRequestCommitCommentThread object.

path (String)

The file the comments were made on.

position (Int)

The position in the diff for the commit that the comment was made on.

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

repository (Repository!)

The repository associated with this node.

PullRequestCommitConnection

Object

The connection type for PullRequestCommit.

PullRequestCommitConnection のフィールド

名前説明

edges ([PullRequestCommitEdge])

A list of edges.

nodes ([PullRequestCommit])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PullRequestCommitEdge

Object

An edge in a connection.

PullRequestCommitEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequestCommit)

The item at the end of the edge.

PullRequestConnection

Object

The connection type for PullRequest.

PullRequestConnection のフィールド

名前説明

edges ([PullRequestEdge])

A list of edges.

nodes ([PullRequest])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PullRequestContributionsByRepository

Object

This aggregates pull requests opened by a user within one repository.

PullRequestContributionsByRepository のフィールド

名前説明

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

contributions の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

repository (Repository!)

The repository in which the pull requests were opened.

PullRequestEdge

Object

An edge in a connection.

PullRequestEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequest)

The item at the end of the edge.

PullRequestParameters

Object

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

PullRequestParameters のフィールド

名前説明

allowedMergeMethods ([PullRequestAllowedMergeMethods!])

Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.

dismissStaleReviewsOnPush (Boolean!)

New, reviewable commits pushed will dismiss previous pull request review approvals.

requireCodeOwnerReview (Boolean!)

Require an approving review in pull requests that modify files that have a designated code owner.

requireLastPushApproval (Boolean!)

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int!)

The number of approving reviews that are required before a pull request can be merged.

requiredReviewThreadResolution (Boolean!)

All conversations on code must be resolved before a pull request can be merged.

requiredReviewers ([RequiredReviewerConfiguration!])

This field is in beta and subject to change. A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

PullRequestReview

Object

A review object for a given pull request.

PullRequestReview 実装

PullRequestReview のフィールド

名前説明

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

body (String!)

Identifies the pull request review body.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body of this review rendered as plain text.

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

comments の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commit (Commit)

Identifies the commit associated with this pull request review.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2024-07-01 UTC.

editor (Actor)

The actor who edited the comment.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

id (ID!)

The Node ID of the PullRequestReview object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized. One of abuse, off-topic, outdated, resolved, duplicate, spam, and low-quality. Note that the case and formatting of these values differs from the inputs to the MinimizeComment mutation.

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

onBehalfOf の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

publishedAt (DateTime)

Identifies when the comment was published at.

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

reactions の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL permalink for this PullRequestReview.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

userContentEdits の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUnminimize (Boolean!)

Check if the current viewer can unminimize this object.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

PullRequestReviewComment

Object

A review comment associated with a given repository pull request.

PullRequestReviewComment 実装

PullRequestReviewComment のフィールド

名前説明

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The comment body of this review comment.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The comment body of this review comment rendered as plain text.

commit (Commit)

Identifies the commit associated with the comment.

createdAt (DateTime!)

Identifies when the comment was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2024-07-01 UTC.

diffHunk (String!)

The diff hunk to which the comment applies.

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

editor (Actor)

The actor who edited the comment.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

id (ID!)

The Node ID of the PullRequestReviewComment object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

line (Int)

The end line number on the file to which the comment applies.

minimizedReason (String)

Returns why the comment was minimized. One of abuse, off-topic, outdated, resolved, duplicate, spam, and low-quality. Note that the case and formatting of these values differs from the inputs to the MinimizeComment mutation.

originalCommit (Commit)

Identifies the original commit associated with the comment.

originalLine (Int)

The end line number on the file to which the comment applied when it was first created.

originalPosition (Int!)

The original line index in the diff to which the comment applies.

警告

originalPosition is deprecated.

We are phasing out diff-relative positioning for PR comments Removal on 2023-10-01 UTC.

originalStartLine (Int)

The start line number on the file to which the comment applied when it was first created.

outdated (Boolean!)

Identifies when the comment body is outdated.

path (String!)

The path to which the comment applies.

position (Int)

The line index in the diff to which the comment applies.

警告

position is deprecated.

We are phasing out diff-relative positioning for PR comments Use the line and startLine fields instead, which are file line numbers instead of diff line numbers Removal on 2023-10-01 UTC.

publishedAt (DateTime)

Identifies when the comment was published at.

pullRequest (PullRequest!)

The pull request associated with this review comment.

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

reactions の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

replyTo (PullRequestReviewComment)

The comment this is a reply to.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path permalink for this review comment.

startLine (Int)

The start line number on the file to which the comment applies.

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

subjectType (PullRequestReviewThreadSubjectType!)

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

updatedAt (DateTime!)

Identifies when the comment was last updated.

url (URI!)

The HTTP URL permalink for this review comment.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

userContentEdits の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUnminimize (Boolean!)

Check if the current viewer can unminimize this object.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

PullRequestReviewCommentConnection

Object

The connection type for PullRequestReviewComment.

PullRequestReviewCommentConnection のフィールド

名前説明

edges ([PullRequestReviewCommentEdge])

A list of edges.

nodes ([PullRequestReviewComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PullRequestReviewCommentEdge

Object

An edge in a connection.

PullRequestReviewCommentEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequestReviewComment)

The item at the end of the edge.

PullRequestReviewConnection

Object

The connection type for PullRequestReview.

PullRequestReviewConnection のフィールド

名前説明

edges ([PullRequestReviewEdge])

A list of edges.

nodes ([PullRequestReview])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PullRequestReviewContributionsByRepository

Object

This aggregates pull request reviews made by a user within one repository.

PullRequestReviewContributionsByRepository のフィールド

名前説明

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

contributions の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ContributionOrder)

    Ordering options for contributions returned from the connection.

repository (Repository!)

The repository in which the pull request reviews were made.

PullRequestReviewEdge

Object

An edge in a connection.

PullRequestReviewEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequestReview)

The item at the end of the edge.

PullRequestReviewThread

Object

A threaded list of comments for a given pull request.

PullRequestReviewThread 実装

PullRequestReviewThread のフィールド

名前説明

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

comments の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • skip (Int)

    Skips the first n elements in the list.

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

id (ID!)

The Node ID of the PullRequestReviewThread object.

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (resolved).

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

isResolved (Boolean!)

Whether this thread has been resolved.

line (Int)

The line in the file to which this thread refers.

originalLine (Int)

The original line in the file to which this thread refers.

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

path (String!)

Identifies the file path of this thread.

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

repository (Repository!)

Identifies the repository associated with this thread.

resolvedBy (User)

The user who resolved this thread.

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

subjectType (PullRequestReviewThreadSubjectType!)

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

PullRequestReviewThreadConnection

Object

Review comment threads for a pull request review.

PullRequestReviewThreadConnection のフィールド

名前説明

edges ([PullRequestReviewThreadEdge])

A list of edges.

nodes ([PullRequestReviewThread])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PullRequestReviewThreadEdge

Object

An edge in a connection.

PullRequestReviewThreadEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequestReviewThread)

The item at the end of the edge.

PullRequestRevisionMarker

Object

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

PullRequestRevisionMarker のフィールド

名前説明

createdAt (DateTime!)

Identifies the date and time when the object was created.

lastSeenCommit (Commit!)

The last commit the viewer has seen.

pullRequest (PullRequest!)

The pull request to which the marker belongs.

PullRequestTemplate

Object

A repository pull request template.

PullRequestTemplate のフィールド

名前説明

body (String)

The body of the template.

filename (String)

The filename of the template.

repository (Repository!)

The repository the template belongs to.

PullRequestThread

Object

A threaded list of comments for a given pull request.

PullRequestThread 実装

PullRequestThread のフィールド

名前説明

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

comments の引数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • skip (Int)

    Skips the first n elements in the list.

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

id (ID!)

The Node ID of the PullRequestThread object.

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (resolved).

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

isResolved (Boolean!)

Whether this thread has been resolved.

line (Int)

The line in the file to which this thread refers.

path (String!)

Identifies the file path of this thread.

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

repository (Repository!)

Identifies the repository associated with this thread.

resolvedBy (User)

The user who resolved this thread.

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

startLine (Int)

The line of the first file diff in the thread.

subjectType (PullRequestReviewThreadSubjectType!)

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

PullRequestTimelineConnection

Object

The connection type for PullRequestTimelineItem.

PullRequestTimelineConnection のフィールド

名前説明

edges ([PullRequestTimelineItemEdge])

A list of edges.

nodes ([PullRequestTimelineItem])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PullRequestTimelineItemEdge

Object

An edge in a connection.

PullRequestTimelineItemEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequestTimelineItem)

The item at the end of the edge.

PullRequestTimelineItemsConnection

Object

The connection type for PullRequestTimelineItems.

PullRequestTimelineItemsConnection のフィールド

名前説明

edges ([PullRequestTimelineItemsEdge])

A list of edges.

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

nodes ([PullRequestTimelineItems])

A list of nodes.

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

PullRequestTimelineItemsEdge

Object

An edge in a connection.

PullRequestTimelineItemsEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (PullRequestTimelineItems)

The item at the end of the edge.

ReadyForReviewEvent

Object

Represents aready_for_reviewevent on a given pull request.

ReadyForReviewEvent 実装

ReadyForReviewEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ReadyForReviewEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

resourcePath (URI!)

The HTTP path for this ready for review event.

url (URI!)

The HTTP URL for this ready for review event.

RemovedFromMergeQueueEvent

Object

Represents aremoved_from_merge_queueevent on a given pull request.

RemovedFromMergeQueueEvent 実装

RemovedFromMergeQueueEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

beforeCommit (Commit)

Identifies the before commit SHA for theremoved_from_merge_queueevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enqueuer (User)

The user who removed this Pull Request from the merge queue.

id (ID!)

The Node ID of the RemovedFromMergeQueueEvent object.

mergeQueue (MergeQueue)

The merge queue where this pull request was removed from.

pullRequest (PullRequest)

PullRequest referenced by event.

reason (String)

The reason this pull request was removed from the queue.

RequestedReviewerConnection

Object

The connection type for RequestedReviewer.

RequestedReviewerConnection のフィールド

名前説明

edges ([RequestedReviewerEdge])

A list of edges.

nodes ([RequestedReviewer])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

RequestedReviewerEdge

Object

An edge in a connection.

RequestedReviewerEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (RequestedReviewer)

The item at the end of the edge.

RequiredReviewerConfiguration

Object

A reviewing team, and file patterns describing which files they must approve changes to.

RequiredReviewerConfiguration のフィールド

名前説明

filePatterns ([String!]!)

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

minimumApprovals (Int!)

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

reviewerId (ID!)

Node ID of the team which must review changes to matching files.

ReviewDismissedEvent

Object

Represents areview_dismissedevent on a given issue or pull request.

ReviewDismissedEvent 実装

ReviewDismissedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

id (ID!)

The Node ID of the ReviewDismissedEvent object.

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

pullRequest (PullRequest!)

PullRequest referenced by event.

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

resourcePath (URI!)

The HTTP path for this review dismissed event.

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

url (URI!)

The HTTP URL for this review dismissed event.

ReviewRequest

Object

A request for a user to review a pull request.

ReviewRequest 実装

ReviewRequest のフィールド

名前説明

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ReviewRequest object.

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

ReviewRequestConnection

Object

The connection type for ReviewRequest.

ReviewRequestConnection のフィールド

名前説明

edges ([ReviewRequestEdge])

A list of edges.

nodes ([ReviewRequest])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ReviewRequestedEvent

Object

Represents anreview_requestedevent on a given pull request.

ReviewRequestedEvent 実装

ReviewRequestedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ReviewRequestedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

ReviewRequestEdge

Object

An edge in a connection.

ReviewRequestEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (ReviewRequest)

The item at the end of the edge.

ReviewRequestRemovedEvent

Object

Represents anreview_request_removedevent on a given pull request.

ReviewRequestRemovedEvent 実装

ReviewRequestRemovedEvent のフィールド

名前説明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ReviewRequestRemovedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

ReviewStatusHovercardContext

Object

A hovercard context with a message describing the current code review state of the pull request.

ReviewStatusHovercardContext 実装

ReviewStatusHovercardContext のフィールド

名前説明

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

SuggestedReviewer

Object

A suggestion to review a pull request based on a user's commit history and review comments.

SuggestedReviewer のフィールド

名前説明

isAuthor (Boolean!)

Is this suggestion based on past commits?.

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

reviewer (User!)

Identifies the user suggested to review the pull request.

SuggestedReviewerActor

Object

A suggestion to review a pull request based on an actor's commit history, review comments, and integrations.

SuggestedReviewerActor のフィールド

名前説明

isAuthor (Boolean!)

Is this suggestion based on past commits?.

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

reviewer (Actor!)

Identifies the actor suggested to review the pull request.

SuggestedReviewerActorConnection

Object

A suggestion to review a pull request based on an actor's commit history, review comments, and integrations.

SuggestedReviewerActorConnection のフィールド

名前説明

edges ([SuggestedReviewerActorEdge])

A list of edges.

nodes ([SuggestedReviewerActor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

SuggestedReviewerActorEdge

Object

An edge in a connection.

SuggestedReviewerActorEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (SuggestedReviewerActor)

The item at the end of the edge.

Interfaces

RequirableByPullRequest

Interface

Represents a type that can be required by a pull request for merging.

RequirableByPullRequest は次で実装されています

RequirableByPullRequest のフィールド

名前説明

isRequired (Boolean!)

Whether this is required to pass before merging for a specific pull request.

isRequired の引数

  • pullRequestId (ID)

    The id of the pull request this is required for.

  • pullRequestNumber (Int)

    The number of the pull request this is required for.

Enums

DiffSide

Enum

The possible sides of a diff.

DiffSide の値です。

名前説明
LEFT

The left side of the diff.

RIGHT

The right side of the diff.

FileViewedState

Enum

The possible viewed states of a file .

FileViewedState の値です。

名前説明
DISMISSED

The file has new changes since last viewed.

UNVIEWED

The file has not been marked as viewed.

VIEWED

The file has been marked as viewed.

MergeableState

Enum

Whether or not a PullRequest can be merged.

MergeableState の値です。

名前説明
CONFLICTING

The pull request cannot be merged due to merge conflicts.

MERGEABLE

The pull request can be merged.

UNKNOWN

The mergeability of the pull request is still being calculated.

MergeQueueEntryState

Enum

The possible states for a merge queue entry.

MergeQueueEntryState の値です。

名前説明
AWAITING_CHECKS

The entry is currently waiting for checks to pass.

LOCKED

The entry is currently locked.

MERGEABLE

The entry is currently mergeable.

QUEUED

The entry is currently queued.

UNMERGEABLE

The entry is currently unmergeable.

MergeQueueGroupingStrategy

Enum

When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.

MergeQueueGroupingStrategy の値です。

名前説明
ALLGREEN

The merge commit created by merge queue for each PR in the group must pass all required checks to merge.

HEADGREEN

Only the commit at the head of the merge group must pass its required checks to merge.

MergeQueueMergeMethod

Enum

Method to use when merging changes from queued pull requests.

MergeQueueMergeMethod の値です。

名前説明
MERGE

Merge commit.

REBASE

Rebase and merge.

SQUASH

Squash and merge.

MergeQueueMergingStrategy

Enum

The possible merging strategies for a merge queue.

MergeQueueMergingStrategy の値です。

名前説明
ALLGREEN

Entries only allowed to merge if they are passing.

HEADGREEN

Failing Entires are allowed to merge if they are with a passing entry.

MergeStateStatus

Enum

Detailed status information about a pull request merge.

MergeStateStatus の値です。

名前説明
BEHIND

The head ref is out of date.

BLOCKED

The merge is blocked.

CLEAN

Mergeable and passing commit status.

DIRTY

The merge commit cannot be cleanly created.

DRAFT

The merge is blocked due to the pull request being a draft.

HAS_HOOKS

Mergeable with passing commit status and pre-receive hooks.

UNKNOWN

The state cannot currently be determined.

UNSTABLE

Mergeable with non-passing commit status.

PatchStatus

Enum

The possible types of patch statuses.

PatchStatus の値です。

名前説明
ADDED

The file was added. Git status 'A'.

CHANGED

The file's type was changed. Git status 'T'.

COPIED

The file was copied. Git status 'C'.

DELETED

The file was deleted. Git status 'D'.

MODIFIED

The file's contents were changed. Git status 'M'.

RENAMED

The file was renamed. Git status 'R'.

PullRequestAllowedMergeMethods

Enum

Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.

PullRequestAllowedMergeMethods の値です。

名前説明
MERGE

Add all commits from the head branch to the base branch with a merge commit.

REBASE

Add all commits from the head branch onto the base branch individually.

SQUASH

Combine all commits from the head branch into a single commit in the base branch.

PullRequestBranchUpdateMethod

Enum

The possible methods for updating a pull request's head branch with the base branch.

PullRequestBranchUpdateMethod の値です。

名前説明
MERGE

Update branch via merge.

REBASE

Update branch via rebase.

PullRequestCreationPolicy

Enum

The policy controlling who can create pull requests in a repository.

PullRequestCreationPolicy の値です。

名前説明
ALL

Anyone can create pull requests.

COLLABORATORS_ONLY

Only collaborators can create pull requests.

PullRequestMergeMethod

Enum

Represents available types of methods to use when merging a pull request.

PullRequestMergeMethod の値です。

名前説明
MERGE

Add all commits from the head branch to the base branch with a merge commit.

REBASE

Add all commits from the head branch onto the base branch individually.

SQUASH

Combine all commits from the head branch into a single commit in the base branch.

PullRequestOrderField

Enum

Properties by which pull_requests connections can be ordered.

PullRequestOrderField の値です。

名前説明
CREATED_AT

Order pull_requests by creation time.

UPDATED_AT

Order pull_requests by update time.

PullRequestReviewCommentState

Enum

The possible states of a pull request review comment.

PullRequestReviewCommentState の値です。

名前説明
PENDING

A comment that is part of a pending review.

SUBMITTED

A comment that is part of a submitted review.

PullRequestReviewDecision

Enum

The review status of a pull request.

PullRequestReviewDecision の値です。

名前説明
APPROVED

The pull request has received an approving review.

CHANGES_REQUESTED

Changes have been requested on the pull request.

REVIEW_REQUIRED

A review is required before the pull request can be merged.

PullRequestReviewEvent

Enum

The possible events to perform on a pull request review.

PullRequestReviewEvent の値です。

名前説明
APPROVE

Submit feedback and approve merging these changes.

COMMENT

Submit general feedback without explicit approval.

DISMISS

Dismiss review so it now longer effects merging.

REQUEST_CHANGES

Submit feedback that must be addressed before merging.

PullRequestReviewState

Enum

The possible states of a pull request review.

PullRequestReviewState の値です。

名前説明
APPROVED

A review allowing the pull request to merge.

CHANGES_REQUESTED

A review blocking the pull request from merging.

COMMENTED

An informational review.

DISMISSED

A review that has been dismissed.

PENDING

A review that has not yet been submitted.

PullRequestReviewThreadSubjectType

Enum

The possible subject types of a pull request review comment.

PullRequestReviewThreadSubjectType の値です。

名前説明
FILE

A comment that has been made against the file of a pull request.

LINE

A comment that has been made against the line of a pull request.

PullRequestState

Enum

The possible states of a pull request.

PullRequestState の値です。

名前説明
CLOSED

A pull request that has been closed without being merged.

MERGED

A pull request that has been closed by being merged.

OPEN

A pull request that is still open.

PullRequestUpdateState

Enum

The possible target states when updating a pull request.

PullRequestUpdateState の値です。

名前説明
CLOSED

A pull request that has been closed without being merged.

OPEN

A pull request that is still open.

Unions

PullRequestTimelineItem

Union

An item in a pull request timeline.

PullRequestTimelineItem の可能な型

PullRequestTimelineItems

Union

An item in a pull request timeline.

PullRequestTimelineItems の可能な型

RequestedReviewer

Union

Types that can be requested reviewers.

RequestedReviewer の可能な型

Input objects

AddPullRequestReviewCommentInput

Input object

Autogenerated input type of AddPullRequestReviewComment.

AddPullRequestReviewCommentInput の入力フィールド

名前説明

body (String)

The text of the comment. This field is required

Upcoming Change on 2023-10-01 UTC Description: body will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitOID (GitObjectID)

The SHA of the commit to comment on.

Upcoming Change on 2023-10-01 UTC Description: commitOID will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

inReplyTo (ID)

The comment id to reply to.

Upcoming Change on 2023-10-01 UTC Description: inReplyTo will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

path (String)

The relative path of the file to comment on.

Upcoming Change on 2023-10-01 UTC Description: path will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

position (Int)

The line index in the diff to comment on.

Upcoming Change on 2023-10-01 UTC Description: position will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestId (ID)

The node ID of the pull request reviewing

Upcoming Change on 2023-10-01 UTC Description: pullRequestId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestReviewId (ID)

The Node ID of the review to modify.

Upcoming Change on 2023-10-01 UTC Description: pullRequestReviewId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

AddPullRequestReviewInput

Input object

Autogenerated input type of AddPullRequestReview.

AddPullRequestReviewInput の入力フィールド

名前説明

body (String)

The contents of the review body comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

comments ([DraftPullRequestReviewComment])

The review line comments.

Upcoming Change on 2023-10-01 UTC Description: comments will be removed. use the threads argument instead Reason: We are deprecating comment fields that use diff-relative positioning.

commitOID (GitObjectID)

The commit OID the review pertains to.

event (PullRequestReviewEvent)

The event to perform on the pull request review.

pullRequestId (ID!)

The Node ID of the pull request to modify.

threads ([DraftPullRequestReviewThread])

The review line comment threads.

AddPullRequestReviewThreadInput

Input object

Autogenerated input type of AddPullRequestReviewThread.

AddPullRequestReviewThreadInput の入力フィールド

名前説明

body (String!)

Body of the thread's first comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

line (Int)

The line of the blob to which the thread refers, required for line-level threads. The end of the line range for multi-line comments.

path (String)

Path to the file being commented on.

pullRequestId (ID)

The node ID of the pull request reviewing.

pullRequestReviewId (ID)

The Node ID of the review to modify.

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

startLine (Int)

The first line of the range to which the comment refers.

startSide (DiffSide)

The side of the diff on which the start line resides.

subjectType (PullRequestReviewThreadSubjectType)

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

AddPullRequestReviewThreadReplyInput

Input object

Autogenerated input type of AddPullRequestReviewThreadReply.

AddPullRequestReviewThreadReplyInput の入力フィールド

名前説明

body (String!)

The text of the reply.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID)

The Node ID of the pending review to which the reply will belong.

pullRequestReviewThreadId (ID!)

The Node ID of the thread to which this reply is being written.

ArchivePullRequestInput

Input object

Autogenerated input type of ArchivePullRequest.

ArchivePullRequestInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

The Node ID of the pull request to archive.

ClosePullRequestInput

Input object

Autogenerated input type of ClosePullRequest.

ClosePullRequestInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be closed.

ConvertPullRequestToDraftInput

Input object

Autogenerated input type of ConvertPullRequestToDraft.

ConvertPullRequestToDraftInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to convert to draft.

CopilotCodeReviewParametersInput

Input object

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.

CopilotCodeReviewParametersInput の入力フィールド

名前説明

reviewDraftPullRequests (Boolean)

Copilot automatically reviews draft pull requests before they are marked as ready for review.

reviewOnPush (Boolean)

Copilot automatically reviews each new push to the pull request.

CreatePullRequestInput

Input object

Autogenerated input type of CreatePullRequest.

CreatePullRequestInput の入力フィールド

名前説明

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

body (String)

The contents of the pull request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draft (Boolean)

Indicates whether this pull request should be a draft.

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head_ref_name with a user like this: username:branch.

headRepositoryId (ID)

The Node ID of the head repository.

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

repositoryId (ID!)

The Node ID of the repository.

title (String!)

The title of the pull request.

DeletePullRequestReviewCommentInput

Input object

Autogenerated input type of DeletePullRequestReviewComment.

DeletePullRequestReviewCommentInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to delete.

DeletePullRequestReviewInput

Input object

Autogenerated input type of DeletePullRequestReview.

DeletePullRequestReviewInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

DequeuePullRequestInput

Input object

Autogenerated input type of DequeuePullRequest.

DequeuePullRequestInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the pull request to be dequeued.

DisablePullRequestAutoMergeInput

Input object

Autogenerated input type of DisablePullRequestAutoMerge.

DisablePullRequestAutoMergeInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

DismissPullRequestReviewInput

Input object

Autogenerated input type of DismissPullRequestReview.

DismissPullRequestReviewInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String!)

The contents of the pull request review dismissal message.

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

DraftPullRequestReviewComment

Input object

Specifies a review comment to be left with a Pull Request Review.

DraftPullRequestReviewComment の入力フィールド

名前説明

body (String!)

Body of the comment to leave.

path (String!)

Path to the file being commented on.

position (Int!)

Position in the file to leave a comment on.

DraftPullRequestReviewThread

Input object

Specifies a review comment thread to be left with a Pull Request Review.

DraftPullRequestReviewThread の入力フィールド

名前説明

body (String!)

Body of the comment to leave.

line (Int)

The line of the blob to which the thread refers. The end of the line range for multi-line comments. Required if not using positioning.

path (String)

Path to the file being commented on. Required if not using positioning.

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

startLine (Int)

The first line of the range to which the comment refers.

startSide (DiffSide)

The side of the diff on which the start line resides.

EnablePullRequestAutoMergeInput

Input object

Autogenerated input type of EnablePullRequestAutoMerge.

EnablePullRequestAutoMergeInput の入力フィールド

名前説明

authorEmail (String)

The email address to associate with this merge.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit message is ignored.

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit headline is ignored.

expectedHeadOid (GitObjectID)

The expected head OID of the pull request.

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to MERGE. NOTE: when merging with a merge queue any input value for merge method is ignored.

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

EnqueuePullRequestInput

Input object

Autogenerated input type of EnqueuePullRequest.

EnqueuePullRequestInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

expectedHeadOid (GitObjectID)

The expected head OID of the pull request.

jump (Boolean)

Add the pull request to the front of the queue.

pullRequestId (ID!)

The ID of the pull request to enqueue.

MarkFileAsViewedInput

Input object

Autogenerated input type of MarkFileAsViewed.

MarkFileAsViewedInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

path (String!)

The path of the file to mark as viewed.

pullRequestId (ID!)

The Node ID of the pull request.

MarkPullRequestReadyForReviewInput

Input object

Autogenerated input type of MarkPullRequestReadyForReview.

MarkPullRequestReadyForReviewInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

MergePullRequestInput

Input object

Autogenerated input type of MergePullRequest.

MergePullRequestInput の入力フィールド

名前説明

authorEmail (String)

The email address to associate with this merge.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

pullRequestId (ID!)

ID of the pull request to be merged.

MergeQueueParametersInput

Input object

Merges must be performed via a merge queue.

MergeQueueParametersInput の入力フィールド

名前説明

checkResponseTimeoutMinutes (Int!)

Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed.

groupingStrategy (MergeQueueGroupingStrategy!)

When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.

maxEntriesToBuild (Int!)

Limit the number of queued pull requests requesting checks and workflow runs at the same time.

maxEntriesToMerge (Int!)

The maximum number of PRs that will be merged together in a group.

mergeMethod (MergeQueueMergeMethod!)

Method to use when merging changes from queued pull requests.

minEntriesToMerge (Int!)

The minimum number of PRs that will be merged together in a group.

minEntriesToMergeWaitMinutes (Int!)

The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

PullRequestOrder

Input object

Ways in which lists of issues can be ordered upon return.

PullRequestOrder の入力フィールド

名前説明

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

field (PullRequestOrderField!)

The field in which to order pull requests by.

PullRequestParametersInput

Input object

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

PullRequestParametersInput の入力フィールド

名前説明

allowedMergeMethods ([PullRequestAllowedMergeMethods!])

Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.

dismissStaleReviewsOnPush (Boolean!)

New, reviewable commits pushed will dismiss previous pull request review approvals.

requireCodeOwnerReview (Boolean!)

Require an approving review in pull requests that modify files that have a designated code owner.

requireLastPushApproval (Boolean!)

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int!)

The number of approving reviews that are required before a pull request can be merged.

requiredReviewThreadResolution (Boolean!)

All conversations on code must be resolved before a pull request can be merged.

requiredReviewers ([RequiredReviewerConfigurationInput!])

This argument is in beta and subject to change. A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.

ReopenPullRequestInput

Input object

Autogenerated input type of ReopenPullRequest.

ReopenPullRequestInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be reopened.

RequestReviewsByLoginInput

Input object

Autogenerated input type of RequestReviewsByLogin.

RequestReviewsByLoginInput の入力フィールド

名前説明

botLogins ([String!])

The logins of the bots to request reviews from, including the [bot] suffix (e.g., 'copilot-pull-request-reviewer[bot]').

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

The Node ID of the pull request to modify.

teamSlugs ([String!])

The slugs of the teams to request reviews from (format: 'org/team-slug').

union (Boolean)

Add users to the set rather than replace.

userLogins ([String!])

The login strings of the users to request reviews from.

RequestReviewsInput

Input object

Autogenerated input type of RequestReviews.

RequestReviewsInput の入力フィールド

名前説明

botIds ([ID!])

The Node IDs of the bot to request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

The Node ID of the pull request to modify.

teamIds ([ID!])

The Node IDs of the team to request.

union (Boolean)

Add users to the set rather than replace.

userIds ([ID!])

The Node IDs of the user to request.

RequiredReviewerConfigurationInput

Input object

A reviewing team, and file patterns describing which files they must approve changes to.

RequiredReviewerConfigurationInput の入力フィールド

名前説明

filePatterns ([String!]!)

Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.

minimumApprovals (Int!)

Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.

reviewerId (ID!)

Node ID of the team which must review changes to matching files.

ResolveReviewThreadInput

Input object

Autogenerated input type of ResolveReviewThread.

ResolveReviewThreadInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to resolve.

RevertPullRequestInput

Input object

Autogenerated input type of RevertPullRequest.

RevertPullRequestInput の入力フィールド

名前説明

body (String)

The description of the revert pull request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draft (Boolean)

Indicates whether the revert pull request should be a draft.

pullRequestId (ID!)

The ID of the pull request to revert.

title (String)

The title of the revert pull request.

SubmitPullRequestReviewInput

Input object

Autogenerated input type of SubmitPullRequestReview.

SubmitPullRequestReviewInput の入力フィールド

名前説明

body (String)

The text field to set on the Pull Request Review.

clientMutationId (String)

A unique identifier for the client performing the mutation.

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

UnarchivePullRequestInput

Input object

Autogenerated input type of UnarchivePullRequest.

UnarchivePullRequestInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

The Node ID of the pull request to unarchive.

UnmarkFileAsViewedInput

Input object

Autogenerated input type of UnmarkFileAsViewed.

UnmarkFileAsViewedInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

path (String!)

The path of the file to mark as unviewed.

pullRequestId (ID!)

The Node ID of the pull request.

UnresolveReviewThreadInput

Input object

Autogenerated input type of UnresolveReviewThread.

UnresolveReviewThreadInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to unresolve.

UpdatePullRequestBranchInput

Input object

Autogenerated input type of UpdatePullRequestBranch.

UpdatePullRequestBranchInput の入力フィールド

名前説明

clientMutationId (String)

A unique identifier for the client performing the mutation.

expectedHeadOid (GitObjectID)

The head ref oid for the upstream branch.

pullRequestId (ID!)

The Node ID of the pull request.

updateMethod (PullRequestBranchUpdateMethod)

The update branch method to use. If omitted, defaults to 'MERGE'.

UpdatePullRequestInput

Input object

Autogenerated input type of UpdatePullRequest.

UpdatePullRequestInput の入力フィールド

名前説明

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.

body (String)

The contents of the pull request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

milestoneId (ID)

The Node ID of the milestone for this pull request.

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

pullRequestId (ID!)

The Node ID of the pull request.

state (PullRequestUpdateState)

The target state of the pull request.

title (String)

The title of the pull request.

UpdatePullRequestReviewCommentInput

Input object

Autogenerated input type of UpdatePullRequestReviewComment.

UpdatePullRequestReviewCommentInput の入力フィールド

名前説明

body (String!)

The text of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

UpdatePullRequestReviewInput

Input object

Autogenerated input type of UpdatePullRequestReview.

UpdatePullRequestReviewInput の入力フィールド

名前説明

body (String!)

The contents of the pull request review body.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

UpdateTeamReviewAssignmentInput

Input object

Autogenerated input type of UpdateTeamReviewAssignment.

UpdateTeamReviewAssignmentInput の入力フィールド

名前説明

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

countMembersAlreadyRequested (Boolean)

Count any members whose review has already been requested against the required number of members assigned to review.

enabled (Boolean!)

Turn on or off review assignment.

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

id (ID!)

The Node ID of the team to update review assignments of.

includeChildTeamMembers (Boolean)

Include the members of any child teams when assigning.

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

removeTeamRequest (Boolean)

Remove the team review request when assigning.

teamMemberCount (Int)

The number of team members to assign.