Mutations
addPullRequestReview
Adds a review to a Pull Request.
Eingabefelder für addPullRequestReview
input(AddPullRequestReviewInput!)
Rückgabefelder für addPullRequestReview
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created pull request review. |
| The edge from the pull request's review connection. |
addPullRequestReviewComment
Adds a comment to a review.
Eingabefelder für addPullRequestReviewComment
Rückgabefelder für addPullRequestReviewComment
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created comment. |
| The edge from the review's comment connection. |
addPullRequestReviewThread
Adds a new thread to a pending Pull Request Review.
Eingabefelder für addPullRequestReviewThread
input(AddPullRequestReviewThreadInput!)
Rückgabefelder für addPullRequestReviewThread
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created thread. |
addPullRequestReviewThreadReply
Adds a reply to an existing Pull Request Review Thread.
Eingabefelder für addPullRequestReviewThreadReply
Rückgabefelder für addPullRequestReviewThreadReply
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The newly created reply. |
closePullRequest
Close a pull request.
Eingabefelder für closePullRequest
input(ClosePullRequestInput!)
Rückgabefelder für closePullRequest
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was closed. |
convertPullRequestToDraft
Converts a pull request to draft.
Eingabefelder für convertPullRequestToDraft
input(ConvertPullRequestToDraftInput!)
Rückgabefelder für convertPullRequestToDraft
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is now a draft. |
createPullRequest
Create a new pull request.
Eingabefelder für createPullRequest
input(CreatePullRequestInput!)
Rückgabefelder für createPullRequest
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new pull request. |
deletePullRequestReview
Deletes a pull request review.
Eingabefelder für deletePullRequestReview
input(DeletePullRequestReviewInput!)
Rückgabefelder für deletePullRequestReview
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The deleted pull request review. |
deletePullRequestReviewComment
Deletes a pull request review comment.
Eingabefelder für deletePullRequestReviewComment
Rückgabefelder für deletePullRequestReviewComment
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request review the deleted comment belonged to. |
| The deleted pull request review comment. |
dequeuePullRequest
Remove a pull request from the merge queue.
Eingabefelder für dequeuePullRequest
input(DequeuePullRequestInput!)
Rückgabefelder für dequeuePullRequest
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The merge queue entry of the dequeued pull request. |
disablePullRequestAutoMerge
Disable auto merge on the given pull request.
Eingabefelder für disablePullRequestAutoMerge
Rückgabefelder für disablePullRequestAutoMerge
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request auto merge was disabled on. |
dismissPullRequestReview
Dismisses an approved or rejected pull request review.
Eingabefelder für dismissPullRequestReview
input(DismissPullRequestReviewInput!)
Rückgabefelder für dismissPullRequestReview
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The dismissed pull request review. |
enablePullRequestAutoMerge
Enable the default auto-merge on a pull request.
Eingabefelder für enablePullRequestAutoMerge
input(EnablePullRequestAutoMergeInput!)
Rückgabefelder für enablePullRequestAutoMerge
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request auto-merge was enabled on. |
enqueuePullRequest
Add a pull request to the merge queue.
Eingabefelder für enqueuePullRequest
input(EnqueuePullRequestInput!)
Rückgabefelder für enqueuePullRequest
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The merge queue entry for the enqueued pull request. |
markFileAsViewed
Mark a pull request file as viewed.
Eingabefelder für markFileAsViewed
input(MarkFileAsViewedInput!)
Rückgabefelder für markFileAsViewed
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
markPullRequestReadyForReview
Marks a pull request ready for review.
Eingabefelder für markPullRequestReadyForReview
Rückgabefelder für markPullRequestReadyForReview
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that is ready for review. |
mergePullRequest
Merge a pull request.
Eingabefelder für mergePullRequest
input(MergePullRequestInput!)
Rückgabefelder für mergePullRequest
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request that was merged. |
reopenPullRequest
Reopen a pull request.
Eingabefelder für reopenPullRequest
input(ReopenPullRequestInput!)
Rückgabefelder für reopenPullRequest
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reopened. |
requestReviews
Set review requests on a pull request.
Eingabefelder für requestReviews
input(RequestReviewsInput!)
Rückgabefelder für requestReviews
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The pull request that is getting requests. |
| The edge from the pull request to the requested reviewers. |
resolveReviewThread
Marks a review thread as resolved.
Eingabefelder für resolveReviewThread
input(ResolveReviewThreadInput!)
Rückgabefelder für resolveReviewThread
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
revertPullRequest
Create a pull request that reverts the changes from a merged pull request.
Eingabefelder für revertPullRequest
input(RevertPullRequestInput!)
Rückgabefelder für revertPullRequest
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The pull request that was reverted. |
| The new pull request that reverts the input pull request. |
submitPullRequestReview
Submits a pending pull request review.
Eingabefelder für submitPullRequestReview
input(SubmitPullRequestReviewInput!)
Rückgabefelder für submitPullRequestReview
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The submitted pull request review. |
unmarkFileAsViewed
Unmark a pull request file as viewed.
Eingabefelder für unmarkFileAsViewed
input(UnmarkFileAsViewedInput!)
Rückgabefelder für unmarkFileAsViewed
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
unresolveReviewThread
Marks a review thread as unresolved.
Eingabefelder für unresolveReviewThread
input(UnresolveReviewThreadInput!)
Rückgabefelder für unresolveReviewThread
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The thread to resolve. |
updatePullRequest
Update a pull request.
Eingabefelder für updatePullRequest
input(UpdatePullRequestInput!)
Rückgabefelder für updatePullRequest
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
updatePullRequestBranch
Merge or Rebase HEAD from upstream branch into pull request branch.
Eingabefelder für updatePullRequestBranch
input(UpdatePullRequestBranchInput!)
Rückgabefelder für updatePullRequestBranch
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request. |
updatePullRequestReview
Updates the body of a pull request review.
Eingabefelder für updatePullRequestReview
input(UpdatePullRequestReviewInput!)
Rückgabefelder für updatePullRequestReview
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated pull request review. |
updatePullRequestReviewComment
Updates a pull request review comment.
Eingabefelder für updatePullRequestReviewComment
Rückgabefelder für updatePullRequestReviewComment
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated comment. |
updateTeamReviewAssignment
Updates team review assignment.
Eingabefelder für updateTeamReviewAssignment
input(UpdateTeamReviewAssignmentInput!)
Rückgabefelder für updateTeamReviewAssignment
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The team that was modified. |
Objects
AddedToMergeQueueEvent
Represents anadded_to_merge_queueevent on a given pull request.
AddedToMergeQueueEvent Wird implementiert
Felder für AddedToMergeQueueEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who added this Pull Request to the merge queue. |
| The Node ID of the AddedToMergeQueueEvent object. |
| The merge queue where this pull request was added to. |
| PullRequest referenced by event. |
AutomaticBaseChangeFailedEvent
Represents aautomatic_base_change_failedevent on a given pull request.
AutomaticBaseChangeFailedEvent Wird implementiert
Felder für AutomaticBaseChangeFailedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the AutomaticBaseChangeFailedEvent object. |
| The new base for this PR. |
| The old base for this PR. |
| PullRequest referenced by event. |
AutomaticBaseChangeSucceededEvent
Represents aautomatic_base_change_succeededevent on a given pull request.
AutomaticBaseChangeSucceededEvent Wird implementiert
Felder für AutomaticBaseChangeSucceededEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the AutomaticBaseChangeSucceededEvent object. |
| The new base for this PR. |
| The old base for this PR. |
| PullRequest referenced by event. |
AutoMergeDisabledEvent
Represents aauto_merge_disabledevent on a given pull request.
AutoMergeDisabledEvent Wird implementiert
Felder für AutoMergeDisabledEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who disabled auto-merge for this Pull Request. |
| The Node ID of the AutoMergeDisabledEvent object. |
| PullRequest referenced by event. |
| The reason auto-merge was disabled. |
| The reason_code relating to why auto-merge was disabled. |
AutoMergeEnabledEvent
Represents aauto_merge_enabledevent on a given pull request.
AutoMergeEnabledEvent Wird implementiert
Felder für AutoMergeEnabledEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge for this Pull Request. |
| The Node ID of the AutoMergeEnabledEvent object. |
| PullRequest referenced by event. |
AutoMergeRequest
Represents an auto-merge request for a pull request.
Felder für AutoMergeRequest
| Name | BESCHREIBUNG |
|---|---|
| The email address of the author of this auto-merge request. |
| 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. |
| 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. |
| When was this auto-merge request was enabled. |
| The actor who created the auto-merge request. |
| 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. |
| The pull request that this auto-merge request is set against. |
AutoRebaseEnabledEvent
Represents aauto_rebase_enabledevent on a given pull request.
AutoRebaseEnabledEvent Wird implementiert
Felder für AutoRebaseEnabledEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge (rebase) for this Pull Request. |
| The Node ID of the AutoRebaseEnabledEvent object. |
| PullRequest referenced by event. |
AutoSquashEnabledEvent
Represents aauto_squash_enabledevent on a given pull request.
AutoSquashEnabledEvent Wird implementiert
Felder für AutoSquashEnabledEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The user who enabled auto-merge (squash) for this Pull Request. |
| The Node ID of the AutoSquashEnabledEvent object. |
| PullRequest referenced by event. |
BaseRefChangedEvent
Represents abase_ref_changedevent on a given issue or pull request.
BaseRefChangedEvent Wird implementiert
Felder für BaseRefChangedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the name of the base ref for the pull request after it was changed. |
| Identifies the primary key from the database. |
| The Node ID of the BaseRefChangedEvent object. |
| Identifies the name of the base ref for the pull request before it was changed. |
| PullRequest referenced by event. |
BaseRefDeletedEvent
Represents abase_ref_deletedevent on a given pull request.
BaseRefDeletedEvent Wird implementiert
Felder für BaseRefDeletedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the name of the Ref associated with the |
| Identifies the date and time when the object was created. |
| The Node ID of the BaseRefDeletedEvent object. |
| PullRequest referenced by event. |
BaseRefForcePushedEvent
Represents abase_ref_force_pushedevent on a given pull request.
BaseRefForcePushedEvent Wird implementiert
Felder für BaseRefForcePushedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the after commit SHA for the |
| Identifies the before commit SHA for the |
| Identifies the date and time when the object was created. |
| The Node ID of the BaseRefForcePushedEvent object. |
| PullRequest referenced by event. |
| Identifies the fully qualified ref name for the |
ConvertToDraftEvent
Represents aconvert_to_draftevent on a given pull request.
ConvertToDraftEvent Wird implementiert
Felder für ConvertToDraftEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the ConvertToDraftEvent object. |
| PullRequest referenced by event. |
| The HTTP path for this convert to draft event. |
| The HTTP URL for this convert to draft event. |
HeadRefDeletedEvent
Represents ahead_ref_deletedevent on a given pull request.
HeadRefDeletedEvent Wird implementiert
Felder für HeadRefDeletedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the Ref associated with the |
| Identifies the name of the Ref associated with the |
| The Node ID of the HeadRefDeletedEvent object. |
| PullRequest referenced by event. |
HeadRefForcePushedEvent
Represents ahead_ref_force_pushedevent on a given pull request.
HeadRefForcePushedEvent Wird implementiert
Felder für HeadRefForcePushedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the after commit SHA for the |
| Identifies the before commit SHA for the |
| Identifies the date and time when the object was created. |
| The Node ID of the HeadRefForcePushedEvent object. |
| PullRequest referenced by event. |
| Identifies the fully qualified ref name for the |
HeadRefRestoredEvent
Represents ahead_ref_restoredevent on a given pull request.
HeadRefRestoredEvent Wird implementiert
Felder für HeadRefRestoredEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the HeadRefRestoredEvent object. |
| PullRequest referenced by event. |
MergedEvent
Represents amergedevent on a given pull request.
MergedEvent Wird implementiert
Felder für MergedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the commit associated with the |
| Identifies the date and time when the object was created. |
| The Node ID of the MergedEvent object. |
| Identifies the Ref associated with the |
| Identifies the name of the Ref associated with the |
| PullRequest referenced by event. |
| The HTTP path for this merged event. |
| The HTTP URL for this merged event. |
MergeQueue
The queue of pull request entries to be merged into a protected branch in a repository.
MergeQueue Wird implementiert
Felder für MergeQueue
| Name | BESCHREIBUNG |
|---|---|
| The configuration for this merge queue. |
| The entries in the queue. |
| The Node ID of the MergeQueue object. |
| The estimated time in seconds until a newly added entry would be merged. |
| The repository this merge queue belongs to. |
| The HTTP path for this merge queue. |
| The HTTP URL for this merge queue. |
MergeQueueConfiguration
Configuration for a MergeQueue.
Felder für MergeQueueConfiguration
| Name | BESCHREIBUNG |
|---|---|
| The amount of time in minutes to wait for a check response before considering it a failure. |
| The maximum number of entries to build at once. |
| The maximum number of entries to merge at once. |
| The merge method to use for this queue. |
| The strategy to use when merging entries. |
| The minimum number of entries required to merge at once. |
| 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
Entries in a MergeQueue.
MergeQueueEntry Wird implementiert
Felder für MergeQueueEntry
| Name | BESCHREIBUNG |
|---|---|
| The base commit for this entry. |
| The date and time this entry was added to the merge queue. |
| The actor that enqueued this entry. |
| The estimated time in seconds until this entry will be merged. |
| The head commit for this entry. |
| The Node ID of the MergeQueueEntry object. |
| Whether this pull request should jump the queue. |
| The merge queue that this entry belongs to. |
| The position of this entry in the queue. |
| The pull request that will be added to a merge group. |
| Does this pull request need to be deployed on its own. |
| The state of this entry in the queue. |
MergeQueueEntryConnection
The connection type for MergeQueueEntry.
Felder für MergeQueueEntryConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
MergeQueueEntryEdge
An edge in a connection.
Felder für MergeQueueEntryEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
MergeQueueParameters
Merges must be performed via a merge queue.
Felder für MergeQueueParameters
| Name | BESCHREIBUNG |
|---|---|
| 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. |
| 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. |
| Limit the number of queued pull requests requesting checks and workflow runs at the same time. |
| The maximum number of PRs that will be merged together in a group. |
| Method to use when merging changes from queued pull requests. |
| The minimum number of PRs that will be merged together in a group. |
| 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
A repository pull request.
PullRequest Wird implementiert
AssignableClosableCommentLabelableLockableNodeProjectV2OwnerReactableRepositoryNodeSubscribableUniformResourceLocatableUpdatableUpdatableComment
Felder für PullRequest
| Name | BESCHREIBUNG |
|---|---|
| Reason that the conversation was locked. |
| The number of additions in this pull request. |
| A list of actors assigned to this object. Argumente für
|
| A list of Users assigned to this object. |
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| Returns the auto-merge request object if one exists for this pull request. |
| Identifies the base Ref associated with the pull request. |
| Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. |
| Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted. |
| The repository associated with this pull request's base Ref. |
| The body as Markdown. |
| The body rendered to HTML. |
| The body rendered to text. |
| Whether or not the pull request is rebaseable. |
| The number of changed files in this pull request. |
| The HTTP path for the checks of this pull request. |
| The HTTP URL for the checks of this pull request. |
|
|
| Identifies the date and time when the object was closed. |
| List of issues that may be closed by this pull request. Argumente für
|
| A list of comments associated with the pull request. Argumente für
|
| A list of commits present in this pull request's head branch not present in the base branch. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. Warnung
|
| The number of deletions in this pull request. |
| The actor who edited this pull request's body. |
| Lists the files changed within this pull request. |
| Identifies the primary key from the database as a BigInt. |
| Identifies the head Ref associated with the pull request. |
| Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. |
| Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted. |
| The repository associated with this pull request's head Ref. |
| The owner of the repository associated with this pull request's head Ref. |
| The hovercard information for this issue. Argumente für
|
| The Node ID of the PullRequest object. |
| Check if this comment was edited and includes an edit with the creation data. |
| The head and base repositories are different. |
| Identifies if the pull request is a draft. |
| Indicates whether the pull request is in a merge queue. |
| Indicates whether the pull request's base ref has a merge queue enabled. |
| Is this pull request read by the viewer. |
| A list of labels associated with the object. Argumente für
|
| The moment the editor made the last edit. |
| A list of latest reviews per user associated with the pull request. Argumente für
|
| A list of latest reviews per user associated with the pull request that are not also pending review. Argumente für
|
|
|
| Indicates whether maintainers can modify the pull request. |
| The commit that was created when this pull request was merged. |
| The merge queue for the pull request's base branch. |
| The merge queue entry of the pull request in the base branch's merge queue. |
| Detailed information about the current pull request merge state status. |
| Whether or not the pull request can be merged based on the existence of merge conflicts. |
| Whether or not the pull request was merged. |
| The date and time that the pull request was merged. |
| The actor who merged the pull request. |
| Identifies the milestone associated with the pull request. |
| Identifies the pull request number. |
| A list of Users that are participating in the Pull Request conversation. Argumente für
|
| The permalink to the pull request. |
| 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
|
| List of project cards associated with this pull request. Warnung
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. Argumente für
|
| List of project items associated with this pull request. Argumente für
|
| Find a project by number. Argumente für
|
| A list of projects under the owner. Argumente für
|
| Identifies when the comment was published at. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Argumente für
|
| The repository associated with this node. |
| The HTTP path for this pull request. |
| The HTTP path for reverting this pull request. |
| The HTTP URL for reverting this pull request. |
| The current status of this pull request with respect to code review. |
| A list of review requests associated with the pull request. Argumente für
|
| The list of all review threads for this pull request. Argumente für
|
| A list of reviews associated with the pull request. Argumente für
|
| Identifies the state of the pull request. |
| Check and Status rollup information for the PR's head ref. |
| A list of suggested actors to assign to this object. Argumente für
|
| A list of reviewer suggestions based on commit history and past review comments. |
| A list of events, comments, commits, etc. associated with the pull request. Warnung
Argumente für
|
| A list of events, comments, commits, etc. associated with the pull request. Argumente für
|
| Identifies the pull request title. |
| Identifies the pull request title rendered to HTML. |
| Returns a count of how many comments this pull request has received. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL for this pull request. |
| A list of edits to this content. Argumente für
|
| Whether or not the viewer can apply suggestion. |
| Indicates if the object can be closed by the viewer. |
| Check if the viewer can restore the deleted head ref. |
| Whether or not the viewer can disable auto-merge. |
| Can the viewer edit files within this pull request. |
| Whether or not the viewer can enable auto-merge. |
| Indicates if the viewer can edit labels for this object. |
| Indicates whether the viewer can bypass branch protections and merge the pull request immediately. |
| Can user react to this subject. |
| Indicates if the object can be reopened by the viewer. |
| Check if the viewer is able to change their subscription status for the repository. |
| Check if the current viewer can update this object. |
| 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. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
| The latest review given from the viewer. |
| The person who has requested the viewer for review on this pull request. |
| The merge body text for the viewer and method. Argumente für
|
| The merge headline text for the viewer and method. Argumente für
|
| Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
PullRequestChangedFile
A file changed in a pull request.
Felder für PullRequestChangedFile
| Name | BESCHREIBUNG |
|---|---|
| The number of additions to the file. |
| How the file was changed in this PullRequest. |
| The number of deletions to the file. |
| The path of the file. |
| The state of the file for the viewer. |
PullRequestChangedFileConnection
The connection type for PullRequestChangedFile.
Felder für PullRequestChangedFileConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestChangedFileEdge
An edge in a connection.
Felder für PullRequestChangedFileEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestCommit
Represents a Git commit part of a pull request.
PullRequestCommit Wird implementiert
Felder für PullRequestCommit
| Name | BESCHREIBUNG |
|---|---|
| The Git commit object. |
| The Node ID of the PullRequestCommit object. |
| The pull request this commit belongs to. |
| The HTTP path for this pull request commit. |
| The HTTP URL for this pull request commit. |
PullRequestCommitCommentThread
Represents a commit comment thread part of a pull request.
PullRequestCommitCommentThread Wird implementiert
Felder für PullRequestCommitCommentThread
| Name | BESCHREIBUNG |
|---|---|
| The comments that exist in this thread. |
| The commit the comments were made on. |
| The Node ID of the PullRequestCommitCommentThread object. |
| The file the comments were made on. |
| The position in the diff for the commit that the comment was made on. |
| The pull request this commit comment thread belongs to. |
| The repository associated with this node. |
PullRequestCommitConnection
The connection type for PullRequestCommit.
Felder für PullRequestCommitConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestCommitEdge
An edge in a connection.
Felder für PullRequestCommitEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestConnection
The connection type for PullRequest.
Felder für PullRequestConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestContributionsByRepository
This aggregates pull requests opened by a user within one repository.
Felder für PullRequestContributionsByRepository
| Name | BESCHREIBUNG |
|---|---|
| The pull request contributions. Argumente für
|
| The repository in which the pull requests were opened. |
PullRequestEdge
An edge in a connection.
Felder für PullRequestEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestParameters
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Felder für PullRequestParameters
| Name | BESCHREIBUNG |
|---|---|
| Array of allowed merge methods. Allowed values include |
| Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review. |
| New, reviewable commits pushed will dismiss previous pull request review approvals. |
| Require an approving review in pull requests that modify files that have a designated code owner. |
| Whether the most recent reviewable push must be approved by someone other than the person who pushed it. |
| The number of approving reviews that are required before a pull request can be merged. |
| All conversations on code must be resolved before a pull request can be merged. |
PullRequestReview
A review object for a given pull request.
PullRequestReview Wird implementiert
Felder für PullRequestReview
| Name | BESCHREIBUNG |
|---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| Indicates whether the author of this review has push access to the repository. |
| Identifies the pull request review body. |
| The body rendered to HTML. |
| The body of this review rendered as plain text. |
| A list of review comments for the current pull request review. |
| Identifies the commit associated with this pull request review. |
| Identifies the date and time when the object was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. Warnung
|
| The actor who edited the comment. |
| Identifies the primary key from the database as a BigInt. |
| The Node ID of the PullRequestReview object. |
| Check if this comment was edited and includes an edit with the creation data. |
| Returns whether or not a comment has been minimized. |
| The moment the editor made the last edit. |
| Returns why the comment was minimized. One of |
| A list of teams that this review was made on behalf of. Argumente für
|
| Identifies when the comment was published at. |
| Identifies the pull request associated with this pull request review. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Argumente für
|
| The repository associated with this node. |
| The HTTP path permalink for this PullRequestReview. |
| Identifies the current state of the pull request review. |
| Identifies when the Pull Request Review was submitted. |
| Identifies the date and time when the object was last updated. |
| The HTTP URL permalink for this PullRequestReview. |
| A list of edits to this content. Argumente für
|
| Check if the current viewer can delete this object. |
| Check if the current viewer can minimize this object. |
| Can user react to this subject. |
| Check if the current viewer can update this object. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
PullRequestReviewComment
A review comment associated with a given repository pull request.
PullRequestReviewComment Wird implementiert
Felder für PullRequestReviewComment
| Name | BESCHREIBUNG |
|---|---|
| The actor who authored the comment. |
| Author's association with the subject of the comment. |
| The comment body of this review comment. |
| The body rendered to HTML. |
| The comment body of this review comment rendered as plain text. |
| Identifies the commit associated with the comment. |
| Identifies when the comment was created. |
| Check if this comment was created via an email reply. |
| Identifies the primary key from the database. Warnung
|
| The diff hunk to which the comment applies. |
| Identifies when the comment was created in a draft state. |
| The actor who edited the comment. |
| Identifies the primary key from the database as a BigInt. |
| The Node ID of the PullRequestReviewComment object. |
| Check if this comment was edited and includes an edit with the creation data. |
| Returns whether or not a comment has been minimized. |
| The moment the editor made the last edit. |
| The end line number on the file to which the comment applies. |
| Returns why the comment was minimized. One of |
| Identifies the original commit associated with the comment. |
| The end line number on the file to which the comment applied when it was first created. |
| The original line index in the diff to which the comment applies. Warnung
We are phasing out diff-relative positioning for PR comments Removal on 2023-10-01 UTC. |
| The start line number on the file to which the comment applied when it was first created. |
| Identifies when the comment body is outdated. |
| The path to which the comment applies. |
| The line index in the diff to which the comment applies. Warnung
We are phasing out diff-relative positioning for PR comments Use the |
| Identifies when the comment was published at. |
| The pull request associated with this review comment. |
| The pull request review associated with this review comment. |
| A list of reactions grouped by content left on the subject. |
| A list of Reactions left on the Issue. Argumente für
|
| The comment this is a reply to. |
| The repository associated with this node. |
| The HTTP path permalink for this review comment. |
| The start line number on the file to which the comment applies. |
| Identifies the state of the comment. |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
| Identifies when the comment was last updated. |
| The HTTP URL permalink for this review comment. |
| A list of edits to this content. Argumente für
|
| Check if the current viewer can delete this object. |
| Check if the current viewer can minimize this object. |
| Can user react to this subject. |
| Check if the current viewer can update this object. |
| Reasons why the current viewer can not update this comment. |
| Did the viewer author this comment. |
PullRequestReviewCommentConnection
The connection type for PullRequestReviewComment.
Felder für PullRequestReviewCommentConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestReviewCommentEdge
An edge in a connection.
Felder für PullRequestReviewCommentEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestReviewConnection
The connection type for PullRequestReview.
Felder für PullRequestReviewConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestReviewContributionsByRepository
This aggregates pull request reviews made by a user within one repository.
Felder für PullRequestReviewContributionsByRepository
| Name | BESCHREIBUNG |
|---|---|
| The pull request review contributions. Argumente für
|
| The repository in which the pull request reviews were made. |
PullRequestReviewEdge
An edge in a connection.
Felder für PullRequestReviewEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestReviewThread
A threaded list of comments for a given pull request.
PullRequestReviewThread Wird implementiert
Felder für PullRequestReviewThread
| Name | BESCHREIBUNG |
|---|---|
| A list of pull request comments associated with the thread. Argumente für
|
| The side of the diff on which this thread was placed. |
| The Node ID of the PullRequestReviewThread object. |
| Whether or not the thread has been collapsed (resolved). |
| Indicates whether this thread was outdated by newer changes. |
| Whether this thread has been resolved. |
| The line in the file to which this thread refers. |
| The original line in the file to which this thread refers. |
| The original start line in the file to which this thread refers (multi-line only). |
| Identifies the file path of this thread. |
| Identifies the pull request associated with this thread. |
| Identifies the repository associated with this thread. |
| The user who resolved this thread. |
| The side of the diff that the first line of the thread starts on (multi-line only). |
| The start line in the file to which this thread refers (multi-line only). |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
| Indicates whether the current viewer can reply to this thread. |
| Whether or not the viewer can resolve this thread. |
| Whether or not the viewer can unresolve this thread. |
PullRequestReviewThreadConnection
Review comment threads for a pull request review.
Felder für PullRequestReviewThreadConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestReviewThreadEdge
An edge in a connection.
Felder für PullRequestReviewThreadEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestRevisionMarker
Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
Felder für PullRequestRevisionMarker
| Name | BESCHREIBUNG |
|---|---|
| Identifies the date and time when the object was created. |
| The last commit the viewer has seen. |
| The pull request to which the marker belongs. |
PullRequestTemplate
A repository pull request template.
Felder für PullRequestTemplate
| Name | BESCHREIBUNG |
|---|---|
| The body of the template. |
| The filename of the template. |
| The repository the template belongs to. |
PullRequestThread
A threaded list of comments for a given pull request.
PullRequestThread Wird implementiert
Felder für PullRequestThread
| Name | BESCHREIBUNG |
|---|---|
| A list of pull request comments associated with the thread. Argumente für
|
| The side of the diff on which this thread was placed. |
| The Node ID of the PullRequestThread object. |
| Whether or not the thread has been collapsed (resolved). |
| Indicates whether this thread was outdated by newer changes. |
| Whether this thread has been resolved. |
| The line in the file to which this thread refers. |
| Identifies the file path of this thread. |
| Identifies the pull request associated with this thread. |
| Identifies the repository associated with this thread. |
| The user who resolved this thread. |
| The side of the diff that the first line of the thread starts on (multi-line only). |
| The line of the first file diff in the thread. |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
| Indicates whether the current viewer can reply to this thread. |
| Whether or not the viewer can resolve this thread. |
| Whether or not the viewer can unresolve this thread. |
PullRequestTimelineConnection
The connection type for PullRequestTimelineItem.
Felder für PullRequestTimelineConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PullRequestTimelineItemEdge
An edge in a connection.
Felder für PullRequestTimelineItemEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PullRequestTimelineItemsConnection
The connection type for PullRequestTimelineItems.
Felder für PullRequestTimelineItemsConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| Identifies the count of items after applying |
| A list of nodes. |
| Identifies the count of items after applying |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| Identifies the date and time when the timeline was last updated. |
PullRequestTimelineItemsEdge
An edge in a connection.
Felder für PullRequestTimelineItemsEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ReadyForReviewEvent
Represents aready_for_reviewevent on a given pull request.
ReadyForReviewEvent Wird implementiert
Felder für ReadyForReviewEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the ReadyForReviewEvent object. |
| PullRequest referenced by event. |
| The HTTP path for this ready for review event. |
| The HTTP URL for this ready for review event. |
RemovedFromMergeQueueEvent
Represents aremoved_from_merge_queueevent on a given pull request.
RemovedFromMergeQueueEvent Wird implementiert
Felder für RemovedFromMergeQueueEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the before commit SHA for the |
| Identifies the date and time when the object was created. |
| The user who removed this Pull Request from the merge queue. |
| The Node ID of the RemovedFromMergeQueueEvent object. |
| The merge queue where this pull request was removed from. |
| PullRequest referenced by event. |
| The reason this pull request was removed from the queue. |
RequestedReviewerConnection
The connection type for RequestedReviewer.
Felder für RequestedReviewerConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
RequestedReviewerEdge
An edge in a connection.
Felder für RequestedReviewerEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ReviewDismissedEvent
Represents areview_dismissedevent on a given issue or pull request.
ReviewDismissedEvent Wird implementiert
Felder für ReviewDismissedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| Identifies the optional message associated with the |
| Identifies the optional message associated with the event, rendered to HTML. |
| The Node ID of the ReviewDismissedEvent object. |
| Identifies the previous state of the review with the |
| PullRequest referenced by event. |
| Identifies the commit which caused the review to become stale. |
| The HTTP path for this review dismissed event. |
| Identifies the review associated with the |
| The HTTP URL for this review dismissed event. |
ReviewRequest
A request for a user to review a pull request.
ReviewRequest Wird implementiert
Felder für ReviewRequest
| Name | BESCHREIBUNG |
|---|---|
| Whether this request was created for a code owner. |
| Identifies the primary key from the database. |
| The Node ID of the ReviewRequest object. |
| Identifies the pull request associated with this review request. |
| The reviewer that is requested. |
ReviewRequestConnection
The connection type for ReviewRequest.
Felder für ReviewRequestConnection
| Name | BESCHREIBUNG |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
ReviewRequestedEvent
Represents anreview_requestedevent on a given pull request.
ReviewRequestedEvent Wird implementiert
Felder für ReviewRequestedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the ReviewRequestedEvent object. |
| PullRequest referenced by event. |
| Identifies the reviewer whose review was requested. |
ReviewRequestEdge
An edge in a connection.
Felder für ReviewRequestEdge
| Name | BESCHREIBUNG |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
ReviewRequestRemovedEvent
Represents anreview_request_removedevent on a given pull request.
ReviewRequestRemovedEvent Wird implementiert
Felder für ReviewRequestRemovedEvent
| Name | BESCHREIBUNG |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The Node ID of the ReviewRequestRemovedEvent object. |
| PullRequest referenced by event. |
| Identifies the reviewer whose review request was removed. |
ReviewStatusHovercardContext
A hovercard context with a message describing the current code review state of the pull request.
ReviewStatusHovercardContext Wird implementiert
Felder für ReviewStatusHovercardContext
| Name | BESCHREIBUNG |
|---|---|
| A string describing this context. |
| An octicon to accompany this context. |
| The current status of the pull request with respect to code review. |
SuggestedReviewer
A suggestion to review a pull request based on a user's commit history and review comments.
Felder für SuggestedReviewer
| Name | BESCHREIBUNG |
|---|---|
| Is this suggestion based on past commits?. |
| Is this suggestion based on past review comments?. |
| Identifies the user suggested to review the pull request. |
Interfaces
RequirableByPullRequest
Represents a type that can be required by a pull request for merging.
RequirableByPullRequest wird implementiert von
Felder für RequirableByPullRequest
| Name | BESCHREIBUNG |
|---|---|
| Whether this is required to pass before merging for a specific pull request. |
Enums
DiffSide
The possible sides of a diff.
Werte für DiffSide
| Name | BESCHREIBUNG |
|---|---|
LEFT | The left side of the diff. |
RIGHT | The right side of the diff. |
FileViewedState
The possible viewed states of a file .
Werte für FileViewedState
| Name | BESCHREIBUNG |
|---|---|
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
Whether or not a PullRequest can be merged.
Werte für MergeableState
| Name | BESCHREIBUNG |
|---|---|
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
The possible states for a merge queue entry.
Werte für MergeQueueEntryState
| Name | BESCHREIBUNG |
|---|---|
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
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.
Werte für MergeQueueGroupingStrategy
| Name | BESCHREIBUNG |
|---|---|
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
Method to use when merging changes from queued pull requests.
Werte für MergeQueueMergeMethod
| Name | BESCHREIBUNG |
|---|---|
MERGE | Merge commit. |
REBASE | Rebase and merge. |
SQUASH | Squash and merge. |
MergeQueueMergingStrategy
The possible merging strategies for a merge queue.
Werte für MergeQueueMergingStrategy
| Name | BESCHREIBUNG |
|---|---|
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
Detailed status information about a pull request merge.
Werte für MergeStateStatus
| Name | BESCHREIBUNG |
|---|---|
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
The possible types of patch statuses.
Werte für PatchStatus
| Name | BESCHREIBUNG |
|---|---|
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
Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.
Werte für PullRequestAllowedMergeMethods
| Name | BESCHREIBUNG |
|---|---|
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
The possible methods for updating a pull request's head branch with the base branch.
Werte für PullRequestBranchUpdateMethod
| Name | BESCHREIBUNG |
|---|---|
MERGE | Update branch via merge. |
REBASE | Update branch via rebase. |
PullRequestMergeMethod
Represents available types of methods to use when merging a pull request.
Werte für PullRequestMergeMethod
| Name | BESCHREIBUNG |
|---|---|
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
Properties by which pull_requests connections can be ordered.
Werte für PullRequestOrderField
| Name | BESCHREIBUNG |
|---|---|
CREATED_AT | Order pull_requests by creation time. |
UPDATED_AT | Order pull_requests by update time. |
PullRequestReviewCommentState
The possible states of a pull request review comment.
Werte für PullRequestReviewCommentState
| Name | BESCHREIBUNG |
|---|---|
PENDING | A comment that is part of a pending review. |
SUBMITTED | A comment that is part of a submitted review. |
PullRequestReviewDecision
The review status of a pull request.
Werte für PullRequestReviewDecision
| Name | BESCHREIBUNG |
|---|---|
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
The possible events to perform on a pull request review.
Werte für PullRequestReviewEvent
| Name | BESCHREIBUNG |
|---|---|
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
The possible states of a pull request review.
Werte für PullRequestReviewState
| Name | BESCHREIBUNG |
|---|---|
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
The possible subject types of a pull request review comment.
Werte für PullRequestReviewThreadSubjectType
| Name | BESCHREIBUNG |
|---|---|
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
The possible states of a pull request.
Werte für PullRequestState
| Name | BESCHREIBUNG |
|---|---|
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
The possible target states when updating a pull request.
Werte für PullRequestUpdateState
| Name | BESCHREIBUNG |
|---|---|
CLOSED | A pull request that has been closed without being merged. |
OPEN | A pull request that is still open. |
Unions
PullRequestTimelineItem
An item in a pull request timeline.
Mögliche Typen für PullRequestTimelineItem
AssignedEventBaseRefDeletedEventBaseRefForcePushedEventClosedEventCommitCommitCommentThreadCrossReferencedEventDemilestonedEventDeployedEventDeploymentEnvironmentChangedEventHeadRefDeletedEventHeadRefForcePushedEventHeadRefRestoredEventIssueCommentLabeledEventLockedEventMergedEventMilestonedEventPullRequestReviewPullRequestReviewCommentPullRequestReviewThreadReferencedEventRenamedTitleEventReopenedEventReviewDismissedEventReviewRequestRemovedEventReviewRequestedEventSubscribedEventUnassignedEventUnlabeledEventUnlockedEventUnsubscribedEventUserBlockedEvent
PullRequestTimelineItems
An item in a pull request timeline.
Mögliche Typen für PullRequestTimelineItems
AddedToMergeQueueEventAddedToProjectEventAssignedEventAutoMergeDisabledEventAutoMergeEnabledEventAutoRebaseEnabledEventAutoSquashEnabledEventAutomaticBaseChangeFailedEventAutomaticBaseChangeSucceededEventBaseRefChangedEventBaseRefDeletedEventBaseRefForcePushedEventClosedEventCommentDeletedEventConnectedEventConvertToDraftEventConvertedNoteToIssueEventConvertedToDiscussionEventCrossReferencedEventDemilestonedEventDeployedEventDeploymentEnvironmentChangedEventDisconnectedEventHeadRefDeletedEventHeadRefForcePushedEventHeadRefRestoredEventIssueCommentIssueTypeAddedEventIssueTypeChangedEventIssueTypeRemovedEventLabeledEventLockedEventMarkedAsDuplicateEventMentionedEventMergedEventMilestonedEventMovedColumnsInProjectEventParentIssueAddedEventParentIssueRemovedEventPinnedEventPullRequestCommitPullRequestCommitCommentThreadPullRequestReviewPullRequestReviewThreadPullRequestRevisionMarkerReadyForReviewEventReferencedEventRemovedFromMergeQueueEventRemovedFromProjectEventRenamedTitleEventReopenedEventReviewDismissedEventReviewRequestRemovedEventReviewRequestedEventSubIssueAddedEventSubIssueRemovedEventSubscribedEventTransferredEventUnassignedEventUnlabeledEventUnlockedEventUnmarkedAsDuplicateEventUnpinnedEventUnsubscribedEventUserBlockedEvent
RequestedReviewer
Types that can be requested reviewers.
Mögliche Typen für RequestedReviewer
Input objects
AddPullRequestReviewCommentInput
Autogenerated input type of AddPullRequestReviewComment.
Eingabefelder für AddPullRequestReviewCommentInput
| Name | BESCHREIBUNG |
|---|---|
| The text of the comment. This field is required Upcoming Change on 2023-10-01 UTC
Description: |
| A unique identifier for the client performing the mutation. |
| The SHA of the commit to comment on. Upcoming Change on 2023-10-01 UTC
Description: |
| The comment id to reply to. Upcoming Change on 2023-10-01 UTC
Description: |
| The relative path of the file to comment on. Upcoming Change on 2023-10-01 UTC
Description: |
| The line index in the diff to comment on. Upcoming Change on 2023-10-01 UTC
Description: |
| The node ID of the pull request reviewing Upcoming Change on 2023-10-01 UTC
Description: |
| The Node ID of the review to modify. Upcoming Change on 2023-10-01 UTC
Description: |
AddPullRequestReviewInput
Autogenerated input type of AddPullRequestReview.
Eingabefelder für AddPullRequestReviewInput
| Name | BESCHREIBUNG |
|---|---|
| The contents of the review body comment. |
| A unique identifier for the client performing the mutation. |
| The review line comments. Upcoming Change on 2023-10-01 UTC
Description: |
| The commit OID the review pertains to. |
| The event to perform on the pull request review. |
| The Node ID of the pull request to modify. |
| The review line comment threads. |
AddPullRequestReviewThreadInput
Autogenerated input type of AddPullRequestReviewThread.
Eingabefelder für AddPullRequestReviewThreadInput
| Name | BESCHREIBUNG |
|---|---|
| Body of the thread's first comment. |
| A unique identifier for the client performing the mutation. |
| 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 to the file being commented on. |
| The node ID of the pull request reviewing. |
| The Node ID of the review to modify. |
| 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. |
| The first line of the range to which the comment refers. |
| The side of the diff on which the start line resides. |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
AddPullRequestReviewThreadReplyInput
Autogenerated input type of AddPullRequestReviewThreadReply.
Eingabefelder für AddPullRequestReviewThreadReplyInput
| Name | BESCHREIBUNG |
|---|---|
| The text of the reply. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the pending review to which the reply will belong. |
| The Node ID of the thread to which this reply is being written. |
ClosePullRequestInput
Autogenerated input type of ClosePullRequest.
Eingabefelder für ClosePullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to be closed. |
ConvertPullRequestToDraftInput
Autogenerated input type of ConvertPullRequestToDraft.
Eingabefelder für ConvertPullRequestToDraftInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to convert to draft. |
CreatePullRequestInput
Autogenerated input type of CreatePullRequest.
Eingabefelder für CreatePullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| 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. |
| The contents of the pull request. |
| A unique identifier for the client performing the mutation. |
| Indicates whether this pull request should be a draft. |
| The name of the branch where your changes are implemented. For cross-repository pull requests
in the same network, namespace |
| The Node ID of the head repository. |
| Indicates whether maintainers can modify the pull request. |
| The Node ID of the repository. |
| The title of the pull request. |
DeletePullRequestReviewCommentInput
Autogenerated input type of DeletePullRequestReviewComment.
Eingabefelder für DeletePullRequestReviewCommentInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the comment to delete. |
DeletePullRequestReviewInput
Autogenerated input type of DeletePullRequestReview.
Eingabefelder für DeletePullRequestReviewInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the pull request review to delete. |
DequeuePullRequestInput
Autogenerated input type of DequeuePullRequest.
Eingabefelder für DequeuePullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the pull request to be dequeued. |
DisablePullRequestAutoMergeInput
Autogenerated input type of DisablePullRequestAutoMerge.
Eingabefelder für DisablePullRequestAutoMergeInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to disable auto merge on. |
DismissPullRequestReviewInput
Autogenerated input type of DismissPullRequestReview.
Eingabefelder für DismissPullRequestReviewInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The contents of the pull request review dismissal message. |
| The Node ID of the pull request review to modify. |
DraftPullRequestReviewComment
Specifies a review comment to be left with a Pull Request Review.
Eingabefelder für DraftPullRequestReviewComment
| Name | BESCHREIBUNG |
|---|---|
| Body of the comment to leave. |
| Path to the file being commented on. |
| Position in the file to leave a comment on. |
DraftPullRequestReviewThread
Specifies a review comment thread to be left with a Pull Request Review.
Eingabefelder für DraftPullRequestReviewThread
| Name | BESCHREIBUNG |
|---|---|
| Body of the comment to leave. |
| 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 to the file being commented on. Required if not using positioning. |
| 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. |
| The first line of the range to which the comment refers. |
| The side of the diff on which the start line resides. |
EnablePullRequestAutoMergeInput
Autogenerated input type of EnablePullRequestAutoMerge.
Eingabefelder für EnablePullRequestAutoMergeInput
| Name | BESCHREIBUNG |
|---|---|
| The email address to associate with this merge. |
| A unique identifier for the client performing the mutation. |
| 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. |
| 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. |
| The expected head OID of the pull request. |
| The merge method to use. If omitted, defaults to |
| ID of the pull request to enable auto-merge on. |
EnqueuePullRequestInput
Autogenerated input type of EnqueuePullRequest.
Eingabefelder für EnqueuePullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The expected head OID of the pull request. |
| Add the pull request to the front of the queue. |
| The ID of the pull request to enqueue. |
MarkFileAsViewedInput
Autogenerated input type of MarkFileAsViewed.
Eingabefelder für MarkFileAsViewedInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The path of the file to mark as viewed. |
| The Node ID of the pull request. |
MarkPullRequestReadyForReviewInput
Autogenerated input type of MarkPullRequestReadyForReview.
Eingabefelder für MarkPullRequestReadyForReviewInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to be marked as ready for review. |
MergePullRequestInput
Autogenerated input type of MergePullRequest.
Eingabefelder für MergePullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| The email address to associate with this merge. |
| A unique identifier for the client performing the mutation. |
| Commit body to use for the merge commit; if omitted, a default message will be used. |
| Commit headline to use for the merge commit; if omitted, a default message will be used. |
| OID that the pull request head ref must match to allow merge; if omitted, no check is performed. |
| The merge method to use. If omitted, defaults to 'MERGE'. |
| ID of the pull request to be merged. |
MergeQueueParametersInput
Merges must be performed via a merge queue.
Eingabefelder für MergeQueueParametersInput
| Name | BESCHREIBUNG |
|---|---|
| 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. |
| 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. |
| Limit the number of queued pull requests requesting checks and workflow runs at the same time. |
| The maximum number of PRs that will be merged together in a group. |
| Method to use when merging changes from queued pull requests. |
| The minimum number of PRs that will be merged together in a group. |
| 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
Ways in which lists of issues can be ordered upon return.
Eingabefelder für PullRequestOrder
| Name | BESCHREIBUNG |
|---|---|
| The direction in which to order pull requests by the specified field. |
| The field in which to order pull requests by. |
PullRequestParametersInput
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Eingabefelder für PullRequestParametersInput
| Name | BESCHREIBUNG |
|---|---|
| Array of allowed merge methods. Allowed values include |
| Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review. |
| New, reviewable commits pushed will dismiss previous pull request review approvals. |
| Require an approving review in pull requests that modify files that have a designated code owner. |
| Whether the most recent reviewable push must be approved by someone other than the person who pushed it. |
| The number of approving reviews that are required before a pull request can be merged. |
| All conversations on code must be resolved before a pull request can be merged. |
ReopenPullRequestInput
Autogenerated input type of ReopenPullRequest.
Eingabefelder für ReopenPullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to be reopened. |
RequestReviewsInput
Autogenerated input type of RequestReviews.
Eingabefelder für RequestReviewsInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the pull request to modify. |
| The Node IDs of the team to request. |
| Add users to the set rather than replace. |
| The Node IDs of the user to request. |
ResolveReviewThreadInput
Autogenerated input type of ResolveReviewThread.
Eingabefelder für ResolveReviewThreadInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the thread to resolve. |
RevertPullRequestInput
Autogenerated input type of RevertPullRequest.
Eingabefelder für RevertPullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| The description of the revert pull request. |
| A unique identifier for the client performing the mutation. |
| Indicates whether the revert pull request should be a draft. |
| The ID of the pull request to revert. |
| The title of the revert pull request. |
SubmitPullRequestReviewInput
Autogenerated input type of SubmitPullRequestReview.
Eingabefelder für SubmitPullRequestReviewInput
| Name | BESCHREIBUNG |
|---|---|
| The text field to set on the Pull Request Review. |
| A unique identifier for the client performing the mutation. |
| The event to send to the Pull Request Review. |
| The Pull Request ID to submit any pending reviews. |
| The Pull Request Review ID to submit. |
UnmarkFileAsViewedInput
Autogenerated input type of UnmarkFileAsViewed.
Eingabefelder für UnmarkFileAsViewedInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The path of the file to mark as unviewed. |
| The Node ID of the pull request. |
UnresolveReviewThreadInput
Autogenerated input type of UnresolveReviewThread.
Eingabefelder für UnresolveReviewThreadInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the thread to unresolve. |
UpdatePullRequestBranchInput
Autogenerated input type of UpdatePullRequestBranch.
Eingabefelder für UpdatePullRequestBranchInput
| Name | BESCHREIBUNG |
|---|---|
| A unique identifier for the client performing the mutation. |
| The head ref oid for the upstream branch. |
| The Node ID of the pull request. |
| The update branch method to use. If omitted, defaults to 'MERGE'. |
UpdatePullRequestInput
Autogenerated input type of UpdatePullRequest.
Eingabefelder für UpdatePullRequestInput
| Name | BESCHREIBUNG |
|---|---|
| An array of Node IDs of users for this pull request. |
| The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. |
| The contents of the pull request. |
| A unique identifier for the client performing the mutation. |
| An array of Node IDs of labels for this pull request. |
| Indicates whether maintainers can modify the pull request. |
| The Node ID of the milestone for this pull request. |
| An array of Node IDs for projects associated with this pull request. |
| The Node ID of the pull request. |
| The target state of the pull request. |
| The title of the pull request. |
UpdatePullRequestReviewCommentInput
Autogenerated input type of UpdatePullRequestReviewComment.
Eingabefelder für UpdatePullRequestReviewCommentInput
| Name | BESCHREIBUNG |
|---|---|
| The text of the comment. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the comment to modify. |
UpdatePullRequestReviewInput
Autogenerated input type of UpdatePullRequestReview.
Eingabefelder für UpdatePullRequestReviewInput
| Name | BESCHREIBUNG |
|---|---|
| The contents of the pull request review body. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the pull request review to modify. |
UpdateTeamReviewAssignmentInput
Autogenerated input type of UpdateTeamReviewAssignment.
Eingabefelder für UpdateTeamReviewAssignmentInput
| Name | BESCHREIBUNG |
|---|---|
| The algorithm to use for review assignment. |
| A unique identifier for the client performing the mutation. |
| Count any members whose review has already been requested against the required number of members assigned to review. |
| Turn on or off review assignment. |
| An array of team member IDs to exclude. |
| The Node ID of the team to update review assignments of. |
| Include the members of any child teams when assigning. |
| Notify the entire team of the PR if it is delegated. |
| Remove the team review request when assigning. |
| The number of team members to assign. |