Input objects can be described as "composable objects" because they include a set of input fields that define the object.
For example, CommitAuthor
takes a field called emails
. Providing a value for emails
transforms CommitAuthor
into a list of User
objects containing that email address. Note that objects may have input objects, whereas mutations require input objects.
For more information, see Forming calls with GraphQL.
AbortQueuedMigrationsInputAutogenerated input type of AbortQueuedMigrations.
Input fields forAbortQueuedMigrationsInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
ownerId
(ID!
)
The ID of the organization that is running the migrations.
AbortRepositoryMigrationInputAutogenerated input type of AbortRepositoryMigration.
Input fields forAbortRepositoryMigrationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
migrationId
(ID!
)
The ID of the migration to be aborted.
AcceptEnterpriseAdministratorInvitationInputAutogenerated input type of AcceptEnterpriseAdministratorInvitation.
Input fields forAcceptEnterpriseAdministratorInvitationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
invitationId
(ID!
)
The id of the invitation being accepted.
AcceptEnterpriseMemberInvitationInputAutogenerated input type of AcceptEnterpriseMemberInvitation.
Input fields forAcceptEnterpriseMemberInvitationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
invitationId
(ID!
)
The id of the invitation being accepted.
AcceptTopicSuggestionInputAutogenerated input type of AcceptTopicSuggestion.
Input fields forAcceptTopicSuggestionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String
)
The name of the suggested topic.
Upcoming Change on 2024-04-01 UTC Description: name
will be removed. Reason: Suggested topics are no longer supported.
repositoryId
(ID
)
The Node ID of the repository.
Upcoming Change on 2024-04-01 UTC Description: repositoryId
will be removed. Reason: Suggested topics are no longer supported.
Autogenerated input type of AccessUserNamespaceRepository.
Input fields forAccessUserNamespaceRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise owning the user namespace repository.
repositoryId
(ID!
)
The ID of the user namespace repository to access.
AddAssigneesToAssignableInputAutogenerated input type of AddAssigneesToAssignable.
Input fields forAddAssigneesToAssignableInput
Name Description
assignableId
(ID!
)
The id of the assignable object to add assignees to.
assigneeIds
([ID!]!
)
The id of users to add as assignees.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
Autogenerated input type of AddComment.
Input fields forAddCommentInput
Name Description
body
(String!
)
The contents of the comment.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
subjectId
(ID!
)
The Node ID of the subject to modify.
Autogenerated input type of AddDiscussionComment.
Input fields forAddDiscussionCommentInput
Name Description
body
(String!
)
The contents of the comment.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
discussionId
(ID!
)
The Node ID of the discussion to comment on.
replyToId
(ID
)
The Node ID of the discussion comment within this discussion to reply to.
AddDiscussionPollVoteInputAutogenerated input type of AddDiscussionPollVote.
Input fields forAddDiscussionPollVoteInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
pollOptionId
(ID!
)
The Node ID of the discussion poll option to vote for.
AddEnterpriseOrganizationMemberInputAutogenerated input type of AddEnterpriseOrganizationMember.
Input fields forAddEnterpriseOrganizationMemberInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise which owns the organization.
organizationId
(ID!
)
The ID of the organization the users will be added to.
role
(OrganizationMemberRole
)
The role to assign the users in the organization.
userIds
([ID!]!
)
The IDs of the enterprise members to add.
AddEnterpriseSupportEntitlementInputAutogenerated input type of AddEnterpriseSupportEntitlement.
Input fields forAddEnterpriseSupportEntitlementInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the Enterprise which the admin belongs to.
login
(String!
)
The login of a member who will receive the support entitlement.
AddLabelsToLabelableInputAutogenerated input type of AddLabelsToLabelable.
Input fields forAddLabelsToLabelableInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
labelIds
([ID!]!
)
The ids of the labels to add.
labelableId
(ID!
)
The id of the labelable object to add labels to.
AddProjectCardInputAutogenerated input type of AddProjectCard.
Input fields forAddProjectCardInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
contentId
(ID
)
The content of the card. Must be a member of the ProjectCardItem union.
note
(String
)
The note on the card.
projectColumnId
(ID!
)
The Node ID of the ProjectColumn.
AddProjectColumnInputAutogenerated input type of AddProjectColumn.
Input fields forAddProjectColumnInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String!
)
The name of the column.
projectId
(ID!
)
The Node ID of the project.
AddProjectV2DraftIssueInputAutogenerated input type of AddProjectV2DraftIssue.
Input fields forAddProjectV2DraftIssueInput
Name Description
assigneeIds
([ID!]
)
The IDs of the assignees of the draft issue.
body
(String
)
The body of the draft issue.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the Project to add the draft issue to.
title
(String!
)
The title of the draft issue. A project item can also be created by providing the URL of an Issue or Pull Request if you have access.
AddProjectV2ItemByIdInputAutogenerated input type of AddProjectV2ItemById.
Input fields forAddProjectV2ItemByIdInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
contentId
(ID!
)
The id of the Issue or Pull Request to add.
projectId
(ID!
)
The ID of the Project to add the item to.
Autogenerated input type of AddPullRequestReviewComment.
Input fields forAddPullRequestReviewCommentInput
Name Description
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.
Autogenerated input type of AddPullRequestReview.
Input fields forAddPullRequestReviewInput
Name Description
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.
AddPullRequestReviewThreadInputAutogenerated input type of AddPullRequestReviewThread.
Input fields forAddPullRequestReviewThreadInput
Name Description
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.
AddPullRequestReviewThreadReplyInputAutogenerated input type of AddPullRequestReviewThreadReply.
Input fields forAddPullRequestReviewThreadReplyInput
Name Description
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.
AddReactionInputAutogenerated input type of AddReaction.
Input fields forAddReactionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
content
(ReactionContent!
)
The name of the emoji to react with.
subjectId
(ID!
)
The Node ID of the subject to modify.
AddStarInputAutogenerated input type of AddStar.
Input fields forAddStarInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
starrableId
(ID!
)
The Starrable ID to star.
AddSubIssueInputAutogenerated input type of AddSubIssue.
Input fields forAddSubIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
The id of the issue.
replaceParent
(Boolean
)
Option to replace parent issue if one already exists.
subIssueId
(ID
)
The id of the sub-issue.
subIssueUrl
(String
)
The url of the sub-issue.
AddUpvoteInputAutogenerated input type of AddUpvote.
Input fields forAddUpvoteInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
subjectId
(ID!
)
The Node ID of the discussion or comment to upvote.
AddVerifiableDomainInputAutogenerated input type of AddVerifiableDomain.
Input fields forAddVerifiableDomainInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
domain
(URI!
)
The URL of the domain.
ownerId
(ID!
)
The ID of the owner to add the domain to.
ApproveDeploymentsInputAutogenerated input type of ApproveDeployments.
Input fields forApproveDeploymentsInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
comment
(String
)
Optional comment for approving deployments.
environmentIds
([ID!]!
)
The ids of environments to reject deployments.
workflowRunId
(ID!
)
The node ID of the workflow run containing the pending deployments.
ApproveVerifiableDomainInputAutogenerated input type of ApproveVerifiableDomain.
Input fields forApproveVerifiableDomainInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the verifiable domain to approve.
ArchiveProjectV2ItemInputAutogenerated input type of ArchiveProjectV2Item.
Input fields forArchiveProjectV2ItemInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
itemId
(ID!
)
The ID of the ProjectV2Item to archive.
projectId
(ID!
)
The ID of the Project to archive the item from.
ArchiveRepositoryInputAutogenerated input type of ArchiveRepository.
Input fields forArchiveRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryId
(ID!
)
The ID of the repository to mark as archived.
AuditLogOrderOrdering options for Audit Log connections.
Input fields forAuditLogOrder
BranchNamePatternParametersInput
Parameters to be used for the branch_name_pattern rule.
Input fields forBranchNamePatternParametersInput
Name Description
name
(String
)
How this rule will appear to users.
negate
(Boolean
)
If true, the rule will fail if the pattern matches.
operator
(String!
)
The operator to use for matching.
pattern
(String!
)
The pattern to match with.
Information about a sponsorship to make for a user or organization with a GitHub Sponsors profile, as part of sponsoring many users or organizations at once.
Input fields forBulkSponsorship
Name Description
amount
(Int!
)
The amount to pay to the sponsorable in US dollars. Valid values: 1-12000.
sponsorableId
(ID
)
The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
sponsorableLogin
(String
)
The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.
CancelEnterpriseAdminInvitationInputAutogenerated input type of CancelEnterpriseAdminInvitation.
Input fields forCancelEnterpriseAdminInvitationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
invitationId
(ID!
)
The Node ID of the pending enterprise administrator invitation.
CancelEnterpriseMemberInvitationInputAutogenerated input type of CancelEnterpriseMemberInvitation.
Input fields forCancelEnterpriseMemberInvitationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
invitationId
(ID!
)
The Node ID of the pending enterprise member invitation.
Autogenerated input type of CancelSponsorship.
Input fields forCancelSponsorshipInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
sponsorId
(ID
)
The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given.
sponsorLogin
(String
)
The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given.
sponsorableId
(ID
)
The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
sponsorableLogin
(String
)
The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.
ChangeUserStatusInputAutogenerated input type of ChangeUserStatus.
Input fields forChangeUserStatusInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
emoji
(String
)
The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.
expiresAt
(DateTime
)
If set, the user status will not be shown after this date.
limitedAvailability
(Boolean
)
Whether this status should indicate you are not fully available on GitHub, e.g., you are away.
message
(String
)
A short description of your current status.
organizationId
(ID
)
The ID of the organization whose members will be allowed to see the status. If omitted, the status will be publicly visible.
CheckAnnotationDataInformation from a check run analysis to specific lines of code.
Input fields forCheckAnnotationData
Name Description
annotationLevel
(CheckAnnotationLevel!
)
Represents an annotation's information level.
location
(CheckAnnotationRange!
)
The location of the annotation.
message
(String!
)
A short description of the feedback for these lines of code.
path
(String!
)
The path of the file to add an annotation to.
rawDetails
(String
)
Details about this annotation.
title
(String
)
The title that represents the annotation.
CheckAnnotationRangeInformation from a check run analysis to specific lines of code.
Input fields forCheckAnnotationRange
Name Description
endColumn
(Int
)
The ending column of the range.
endLine
(Int!
)
The ending line of the range.
startColumn
(Int
)
The starting column of the range.
startLine
(Int!
)
The starting line of the range.
CheckRunActionPossible further actions the integrator can perform.
Input fields forCheckRunAction
Name Description
description
(String!
)
A short explanation of what this action would do.
identifier
(String!
)
A reference for the action on the integrator's system.
label
(String!
)
The text to be displayed on a button in the web UI.
CheckRunFilterThe filters that are available when fetching check runs.
Input fields forCheckRunFilter
Name Description
appId
(Int
)
Filters the check runs created by this application ID.
checkName
(String
)
Filters the check runs by this name.
checkType
(CheckRunType
)
Filters the check runs by this type.
conclusions
([CheckConclusionState!]
)
Filters the check runs by these conclusions.
status
(CheckStatusState
)
Filters the check runs by this status. Superceded by statuses.
statuses
([CheckStatusState!]
)
Filters the check runs by this status. Overrides status.
CheckRunOutputDescriptive details about the check run.
Input fields forCheckRunOutput
Name Description
annotations
([CheckAnnotationData!]
)
The annotations that are made as part of the check run.
images
([CheckRunOutputImage!]
)
Images attached to the check run output displayed in the GitHub pull request UI.
summary
(String!
)
The summary of the check run (supports Commonmark).
text
(String
)
The details of the check run (supports Commonmark).
title
(String!
)
A title to provide for this check run.
CheckRunOutputImageImages attached to the check run output displayed in the GitHub pull request UI.
Input fields forCheckRunOutputImage
Name Description
alt
(String!
)
The alternative text for the image.
caption
(String
)
A short image description.
imageUrl
(URI!
)
The full URL of the image.
CheckSuiteAutoTriggerPreferenceThe auto-trigger preferences that are available for check suites.
Input fields forCheckSuiteAutoTriggerPreference
Name Description
appId
(ID!
)
The node ID of the application that owns the check suite.
setting
(Boolean!
)
Set to true
to enable automatic creation of CheckSuite events upon pushes to the repository.
The filters that are available when fetching check suites.
Input fields forCheckSuiteFilter
Name Description
appId
(Int
)
Filters the check suites created by this application ID.
checkName
(String
)
Filters the check suites by this name.
ClearLabelsFromLabelableInputAutogenerated input type of ClearLabelsFromLabelable.
Input fields forClearLabelsFromLabelableInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
labelableId
(ID!
)
The id of the labelable object to clear the labels from.
ClearProjectV2ItemFieldValueInputAutogenerated input type of ClearProjectV2ItemFieldValue.
Input fields forClearProjectV2ItemFieldValueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
fieldId
(ID!
)
The ID of the field to be cleared.
itemId
(ID!
)
The ID of the item to be cleared.
projectId
(ID!
)
The ID of the Project.
CloneProjectInputAutogenerated input type of CloneProject.
Input fields forCloneProjectInput
Name Description
body
(String
)
The description of the project.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
includeWorkflows
(Boolean!
)
Whether or not to clone the source project's workflows.
name
(String!
)
The name of the project.
public
(Boolean
)
The visibility of the project, defaults to false (private).
sourceId
(ID!
)
The source project to clone.
targetOwnerId
(ID!
)
The owner ID to create the project under.
CloneTemplateRepositoryInputAutogenerated input type of CloneTemplateRepository.
Input fields forCloneTemplateRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String
)
A short description of the new repository.
includeAllBranches
(Boolean
)
Whether to copy all branches from the template to the new repository. Defaults to copying only the default branch of the template.
name
(String!
)
The name of the new repository.
ownerId
(ID!
)
The ID of the owner for the new repository.
repositoryId
(ID!
)
The Node ID of the template repository.
visibility
(RepositoryVisibility!
)
Indicates the repository's visibility level.
CloseDiscussionInputAutogenerated input type of CloseDiscussion.
Input fields forCloseDiscussionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
discussionId
(ID!
)
ID of the discussion to be closed.
reason
(DiscussionCloseReason
)
The reason why the discussion is being closed.
CloseIssueInputAutogenerated input type of CloseIssue.
Input fields forCloseIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
duplicateIssueId
(ID
)
ID of the issue that this is a duplicate of.
issueId
(ID!
)
ID of the issue to be closed.
stateReason
(IssueClosedStateReason
)
The reason the issue is to be closed.
ClosePullRequestInputAutogenerated input type of ClosePullRequest.
Input fields forClosePullRequestInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
pullRequestId
(ID!
)
ID of the pull request to be closed.
CodeScanningParametersInputChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
Input fields forCodeScanningParametersInput
Name Description
codeScanningTools
([CodeScanningToolInput!]!
)
Tools that must provide code scanning results for this rule to pass.
A tool that must provide code scanning results for this rule to pass.
Input fields forCodeScanningToolInput
Name Description
alertsThreshold
(String!
)
The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts.".
securityAlertsThreshold
(String!
)
The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts.".
tool
(String!
)
The name of a code scanning tool.
Specifies an author for filtering Git commits.
Input fields forCommitAuthor
Name Description
emails
([String!]
)
Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.
id
(ID
)
ID of a User to filter by. If non-null, only commits authored by this user will be returned. This field takes precedence over emails.
CommitAuthorEmailPatternParametersInputParameters to be used for the commit_author_email_pattern rule.
Input fields forCommitAuthorEmailPatternParametersInput
Name Description
name
(String
)
How this rule will appear to users.
negate
(Boolean
)
If true, the rule will fail if the pattern matches.
operator
(String!
)
The operator to use for matching.
pattern
(String!
)
The pattern to match with.
CommitContributionOrderOrdering options for commit contribution connections.
Input fields forCommitContributionOrder
CommitMessage
A message to include with a new commit.
Input fields forCommitMessage
Name Description
body
(String
)
The body of the message.
headline
(String!
)
The headline of the message.
CommitMessagePatternParametersInputParameters to be used for the commit_message_pattern rule.
Input fields forCommitMessagePatternParametersInput
Name Description
name
(String
)
How this rule will appear to users.
negate
(Boolean
)
If true, the rule will fail if the pattern matches.
operator
(String!
)
The operator to use for matching.
pattern
(String!
)
The pattern to match with.
CommittableBranchA git ref for a commit to be appended to.
The ref must be a branch, i.e. its fully qualified name must start with refs/heads/
(although the input is not required to be fully qualified).
The Ref may be specified by its global node ID or by the repositoryNameWithOwner
and branchName
.
Specify a branch using a global node ID:
{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }
Specify a branch using repositoryNameWithOwner
and branchName
:
{
"repositoryNameWithOwner": "github/graphql-client",
"branchName": "main"
}.
Input fields for CommittableBranch
Name Description
branchName
(String
)
The unqualified name of the branch to append the commit to.
id
(ID
)
The Node ID of the Ref to be updated.
repositoryNameWithOwner
(String
)
The nameWithOwner of the repository to commit to.
CommitterEmailPatternParametersInputParameters to be used for the committer_email_pattern rule.
Input fields forCommitterEmailPatternParametersInput
Name Description
name
(String
)
How this rule will appear to users.
negate
(Boolean
)
If true, the rule will fail if the pattern matches.
operator
(String!
)
The operator to use for matching.
pattern
(String!
)
The pattern to match with.
ContributionOrderOrdering options for contribution connections.
Input fields forContributionOrder
ConvertProjectCardNoteToIssueInput
Autogenerated input type of ConvertProjectCardNoteToIssue.
Input fields forConvertProjectCardNoteToIssueInput
Name Description
body
(String
)
The body of the newly created issue.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectCardId
(ID!
)
The ProjectCard ID to convert.
repositoryId
(ID!
)
The ID of the repository to create the issue in.
title
(String
)
The title of the newly created issue. Defaults to the card's note text.
ConvertProjectV2DraftIssueItemToIssueInputAutogenerated input type of ConvertProjectV2DraftIssueItemToIssue.
Input fields forConvertProjectV2DraftIssueItemToIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
itemId
(ID!
)
The ID of the draft issue ProjectV2Item to convert.
repositoryId
(ID!
)
The ID of the repository to create the issue in.
ConvertPullRequestToDraftInputAutogenerated input type of ConvertPullRequestToDraft.
Input fields forConvertPullRequestToDraftInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
pullRequestId
(ID!
)
ID of the pull request to convert to draft.
CopyProjectV2InputAutogenerated input type of CopyProjectV2.
Input fields forCopyProjectV2Input
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
includeDraftIssues
(Boolean
)
Include draft issues in the new project.
ownerId
(ID!
)
The owner ID of the new project.
projectId
(ID!
)
The ID of the source Project to copy.
title
(String!
)
The title of the project.
CreateAttributionInvitationInputAutogenerated input type of CreateAttributionInvitation.
Input fields forCreateAttributionInvitationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
ownerId
(ID!
)
The Node ID of the owner scoping the reattributable data.
sourceId
(ID!
)
The Node ID of the account owning the data to reattribute.
targetId
(ID!
)
The Node ID of the account which may claim the data.
CreateBranchProtectionRuleInputAutogenerated input type of CreateBranchProtectionRule.
Input fields forCreateBranchProtectionRuleInput
Name Description
allowsDeletions
(Boolean
)
Can this branch be deleted.
allowsForcePushes
(Boolean
)
Are force pushes allowed on this branch.
blocksCreations
(Boolean
)
Is branch creation a protected operation.
bypassForcePushActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.
bypassPullRequestActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
dismissesStaleReviews
(Boolean
)
Will new commits pushed to matching branches dismiss pull request review approvals.
isAdminEnforced
(Boolean
)
Can admins override branch protection.
lockAllowsFetchAndMerge
(Boolean
)
Whether users can pull changes from upstream when the branch is locked. Set to true
to allow fork syncing. Set to false
to prevent fork syncing.
lockBranch
(Boolean
)
Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
pattern
(String!
)
The glob-like pattern used to determine matching branches.
pushActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to push to matching branches.
repositoryId
(ID!
)
The global relay id of the repository in which a new branch protection rule should be created in.
requireLastPushApproval
(Boolean
)
Whether the most recent push must be approved by someone other than the person who pushed it.
requiredApprovingReviewCount
(Int
)
Number of approving reviews required to update matching branches.
requiredDeploymentEnvironments
([String!]
)
The list of required deployment environments.
requiredStatusCheckContexts
([String!]
)
List of required status check contexts that must pass for commits to be accepted to matching branches.
requiredStatusChecks
([RequiredStatusCheckInput!]
)
The list of required status checks.
requiresApprovingReviews
(Boolean
)
Are approving reviews required to update matching branches.
requiresCodeOwnerReviews
(Boolean
)
Are reviews from code owners required to update matching branches.
requiresCommitSignatures
(Boolean
)
Are commits required to be signed.
requiresConversationResolution
(Boolean
)
Are conversations required to be resolved before merging.
requiresDeployments
(Boolean
)
Are successful deployments required before merging.
requiresLinearHistory
(Boolean
)
Are merge commits prohibited from being pushed to this branch.
requiresStatusChecks
(Boolean
)
Are status checks required to update matching branches.
requiresStrictStatusChecks
(Boolean
)
Are branches required to be up to date before merging.
restrictsPushes
(Boolean
)
Is pushing to matching branches restricted.
restrictsReviewDismissals
(Boolean
)
Is dismissal of pull request reviews restricted.
reviewDismissalActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.
CreateCheckRunInputAutogenerated input type of CreateCheckRun.
Input fields forCreateCheckRunInput
Name Description
actions
([CheckRunAction!]
)
Possible further actions the integrator can perform, which a user may trigger.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
completedAt
(DateTime
)
The time that the check run finished.
conclusion
(CheckConclusionState
)
The final conclusion of the check.
detailsUrl
(URI
)
The URL of the integrator's site that has the full details of the check.
externalId
(String
)
A reference for the run on the integrator's system.
headSha
(GitObjectID!
)
The SHA of the head commit.
name
(String!
)
The name of the check.
output
(CheckRunOutput
)
Descriptive details about the run.
repositoryId
(ID!
)
The node ID of the repository.
startedAt
(DateTime
)
The time that the check run began.
status
(RequestableCheckStatusState
)
The current status.
CreateCheckSuiteInputAutogenerated input type of CreateCheckSuite.
Input fields forCreateCheckSuiteInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
headSha
(GitObjectID!
)
The SHA of the head commit.
repositoryId
(ID!
)
The Node ID of the repository.
CreateCommitOnBranchInputAutogenerated input type of CreateCommitOnBranch.
Input fields forCreateCommitOnBranchInput
Name Description
branch
(CommittableBranch!
)
The Ref to be updated. Must be a branch.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
expectedHeadOid
(GitObjectID!
)
The git commit oid expected at the head of the branch prior to the commit.
fileChanges
(FileChanges
)
A description of changes to files in this commit.
message
(CommitMessage!
)
The commit message the be included with the commit.
CreateDeploymentInputAutogenerated input type of CreateDeployment.
Input fields forCreateDeploymentInput
Name Description
autoMerge
(Boolean
)
Attempt to automatically merge the default branch into the requested ref, defaults to true.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String
)
Short description of the deployment.
environment
(String
)
Name for the target deployment environment.
payload
(String
)
JSON payload with extra information about the deployment.
refId
(ID!
)
The node ID of the ref to be deployed.
repositoryId
(ID!
)
The node ID of the repository.
requiredContexts
([String!]
)
The status contexts to verify against commit status checks. To bypass required contexts, pass an empty array. Defaults to all unique contexts.
task
(String
)
Specifies a task to execute.
CreateDeploymentStatusInputAutogenerated input type of CreateDeploymentStatus.
Input fields forCreateDeploymentStatusInput
Name Description
autoInactive
(Boolean
)
Adds a new inactive status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
deploymentId
(ID!
)
The node ID of the deployment.
description
(String
)
A short description of the status. Maximum length of 140 characters.
environment
(String
)
If provided, updates the environment of the deploy. Otherwise, does not modify the environment.
environmentUrl
(String
)
Sets the URL for accessing your environment.
logUrl
(String
)
The log URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
state
(DeploymentStatusState!
)
The state of the deployment.
CreateDiscussionInputAutogenerated input type of CreateDiscussion.
Input fields forCreateDiscussionInput
Name Description
body
(String!
)
The body of the discussion.
categoryId
(ID!
)
The id of the discussion category to associate with this discussion.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryId
(ID!
)
The id of the repository on which to create the discussion.
title
(String!
)
The title of the discussion.
CreateEnterpriseOrganizationInputAutogenerated input type of CreateEnterpriseOrganization.
Input fields forCreateEnterpriseOrganizationInput
Name Description
adminLogins
([String!]!
)
The logins for the administrators of the new organization.
billingEmail
(String!
)
The email used for sending billing receipts.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise owning the new organization.
login
(String!
)
The login of the new organization.
profileName
(String!
)
The profile name of the new organization.
CreateEnvironmentInputAutogenerated input type of CreateEnvironment.
Input fields forCreateEnvironmentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String!
)
The name of the environment.
repositoryId
(ID!
)
The node ID of the repository.
CreateIpAllowListEntryInputAutogenerated input type of CreateIpAllowListEntry.
Input fields forCreateIpAllowListEntryInput
Name Description
allowListValue
(String!
)
An IP address or range of addresses in CIDR notation.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
isActive
(Boolean!
)
Whether the IP allow list entry is active when an IP allow list is enabled.
name
(String
)
An optional name for the IP allow list entry.
ownerId
(ID!
)
The ID of the owner for which to create the new IP allow list entry.
CreateIssueInputAutogenerated input type of CreateIssue.
Input fields forCreateIssueInput
Name Description
assigneeIds
([ID!]
)
The Node ID of assignees for this issue.
body
(String
)
The body for the issue description.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueTemplate
(String
)
The name of an issue template in the repository, assigns labels and assignees from the template to the issue.
issueTypeId
(ID
)
The Node ID of the issue type for this issue.
labelIds
([ID!]
)
An array of Node IDs of labels for this issue.
milestoneId
(ID
)
The Node ID of the milestone for this issue.
parentIssueId
(ID
)
The Node ID of the parent issue to add this new issue to.
projectIds
([ID!]
)
An array of Node IDs for projects associated with this issue.
repositoryId
(ID!
)
The Node ID of the repository.
title
(String!
)
The title for the issue.
CreateIssueTypeInputAutogenerated input type of CreateIssueType.
Input fields forCreateIssueTypeInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
color
(IssueTypeColor
)
Color for the issue type.
description
(String
)
Description of the new issue type.
isEnabled
(Boolean!
)
Whether or not the issue type is enabled on the org level.
name
(String!
)
Name of the new issue type.
ownerId
(ID!
)
The ID for the organization on which the issue type is created.
CreateLabelInputAutogenerated input type of CreateLabel.
Input fields forCreateLabelInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
color
(String!
)
A 6 character hex code, without the leading #, identifying the color of the label.
description
(String
)
A brief description of the label, such as its purpose.
name
(String!
)
The name of the label.
repositoryId
(ID!
)
The Node ID of the repository.
CreateLinkedBranchInputAutogenerated input type of CreateLinkedBranch.
Input fields forCreateLinkedBranchInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
ID of the issue to link to.
name
(String
)
The name of the new branch. Defaults to issue number and title.
oid
(GitObjectID!
)
The commit SHA to base the new branch on.
repositoryId
(ID
)
ID of the repository to create the branch in. Defaults to the issue repository.
CreateMigrationSourceInputAutogenerated input type of CreateMigrationSource.
Input fields forCreateMigrationSourceInput
Name Description
accessToken
(String
)
The migration source access token.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
githubPat
(String
)
The GitHub personal access token of the user importing to the target repository.
name
(String!
)
The migration source name.
ownerId
(ID!
)
The ID of the organization that will own the migration source.
type
(MigrationSourceType!
)
The migration source type.
url
(String
)
The migration source URL, for example https://github.com
or https://monalisa.ghe.com
.
Autogenerated input type of CreateProject.
Input fields forCreateProjectInput
Name Description
body
(String
)
The description of project.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String!
)
The name of project.
ownerId
(ID!
)
The owner ID to create the project under.
repositoryIds
([ID!]
)
A list of repository IDs to create as linked repositories for the project.
template
(ProjectTemplate
)
The name of the GitHub-provided template.
CreateProjectV2InputAutogenerated input type of CreateProjectV2.
Input fields forCreateProjectV2Input
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
ownerId
(ID!
)
The owner ID to create the project under.
repositoryId
(ID
)
The repository to link the project to.
teamId
(ID
)
The team to link the project to. The team will be granted read permissions.
title
(String!
)
The title of the project.
CreateProjectV2StatusUpdateInputAutogenerated input type of CreateProjectV2StatusUpdate.
Input fields forCreateProjectV2StatusUpdateInput
Name Description
body
(String
)
The body of the status update.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the Project to create the status update in.
startDate
(Date
)
The start date of the status update.
status
(ProjectV2StatusUpdateStatus
)
The status of the status update.
targetDate
(Date
)
The target date of the status update.
CreatePullRequestInputAutogenerated input type of CreatePullRequest.
Input fields forCreatePullRequestInput
Name Description
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.
CreateRefInputAutogenerated input type of CreateRef.
Input fields forCreateRefInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String!
)
The fully qualified name of the new Ref (ie: refs/heads/my_new_branch
).
oid
(GitObjectID!
)
The GitObjectID that the new Ref shall target. Must point to a commit.
repositoryId
(ID!
)
The Node ID of the Repository to create the Ref in.
CreateRepositoryInputAutogenerated input type of CreateRepository.
Input fields forCreateRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String
)
A short description of the new repository.
hasIssuesEnabled
(Boolean
)
Indicates if the repository should have the issues feature enabled.
hasWikiEnabled
(Boolean
)
Indicates if the repository should have the wiki feature enabled.
homepageUrl
(URI
)
The URL for a web page about this repository.
name
(String!
)
The name of the new repository.
ownerId
(ID
)
The ID of the owner for the new repository.
teamId
(ID
)
When an organization is specified as the owner, this ID identifies the team that should be granted access to the new repository.
template
(Boolean
)
Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure.
visibility
(RepositoryVisibility!
)
Indicates the repository's visibility level.
Autogenerated input type of CreateSponsorsListing.
Input fields forCreateSponsorsListingInput
Name Description
billingCountryOrRegionCode
(SponsorsCountryOrRegionCode
)
The country or region where the sponsorable's bank account is located. Required if fiscalHostLogin is not specified, ignored when fiscalHostLogin is specified.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
contactEmail
(String
)
The email address we should use to contact you about the GitHub Sponsors profile being created. This will not be shared publicly. Must be a verified email address already on your GitHub account. Only relevant when the sponsorable is yourself. Defaults to your primary email address on file if omitted.
fiscalHostLogin
(String
)
The username of the supported fiscal host's GitHub organization, if you want to receive sponsorship payouts through a fiscal host rather than directly to a bank account. For example,Open-Source-Collective
for Open Source Collective or 'numfocus' for numFOCUS. Case insensitive. See https://docs.github.com/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts for more information.
fiscallyHostedProjectProfileUrl
(String
)
The URL for your profile page on the fiscal host's website, e.g., https://opencollective.com/babel or https://numfocus.org/project/bokeh. Required if fiscalHostLogin is specified.
fullDescription
(String
)
Provide an introduction to serve as the main focus that appears on your GitHub Sponsors profile. It's a great opportunity to help potential sponsors learn more about you, your work, and why their sponsorship is important to you. GitHub-flavored Markdown is supported.
residenceCountryOrRegionCode
(SponsorsCountryOrRegionCode
)
The country or region where the sponsorable resides. This is for tax purposes. Required if the sponsorable is yourself, ignored when sponsorableLogin specifies an organization.
sponsorableLogin
(String
)
The username of the organization to create a GitHub Sponsors profile for, if desired. Defaults to creating a GitHub Sponsors profile for the authenticated user if omitted.
Autogenerated input type of CreateSponsorsTier.
Input fields forCreateSponsorsTierInput
Name Description
amount
(Int!
)
The value of the new tier in US dollars. Valid values: 1-12000.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String!
)
A description of what this tier is, what perks sponsors might receive, what a sponsorship at this tier means for you, etc.
isRecurring
(Boolean
)
Whether sponsorships using this tier should happen monthly/yearly or just once.
publish
(Boolean
)
Whether to make the tier available immediately for sponsors to choose. Defaults to creating a draft tier that will not be publicly visible.
repositoryId
(ID
)
Optional ID of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization.
repositoryName
(String
)
Optional name of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. Necessary if repositoryOwnerLogin is given. Will be ignored if repositoryId is given.
repositoryOwnerLogin
(String
)
Optional login of the organization owner of the private repository that sponsors at this tier should gain read-only access to. Necessary if repositoryName is given. Will be ignored if repositoryId is given.
sponsorableId
(ID
)
The ID of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableLogin is not given.
sponsorableLogin
(String
)
The username of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableId is not given.
welcomeMessage
(String
)
Optional message new sponsors at this tier will receive.
Autogenerated input type of CreateSponsorship.
Input fields forCreateSponsorshipInput
Name Description
amount
(Int
)
The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
isRecurring
(Boolean
)
Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.
privacyLevel
(SponsorshipPrivacy
)
Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used.
receiveEmails
(Boolean
)
Whether the sponsor should receive email updates from the sponsorable.
sponsorId
(ID
)
The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given.
sponsorLogin
(String
)
The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given.
sponsorableId
(ID
)
The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
sponsorableLogin
(String
)
The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.
tierId
(ID
)
The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.
Autogenerated input type of CreateSponsorships.
Input fields forCreateSponsorshipsInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
privacyLevel
(SponsorshipPrivacy
)
Specify whether others should be able to see that the sponsor is sponsoring the sponsorables. Public visibility still does not reveal the dollar value of the sponsorship.
receiveEmails
(Boolean
)
Whether the sponsor should receive email updates from the sponsorables.
recurring
(Boolean
)
Whether the sponsorships created should continue each billing cycle for the sponsor (monthly or annually), versus lasting only a single month. Defaults to one-time sponsorships.
sponsorLogin
(String!
)
The username of the user or organization who is acting as the sponsor, paying for the sponsorships.
sponsorships
([BulkSponsorship!]!
)
The list of maintainers to sponsor and for how much apiece.
Autogenerated input type of CreateTeamDiscussionComment.
Input fields forCreateTeamDiscussionCommentInput
Name Description
body
(String
)
The content of the comment. This field is required.
Upcoming Change on 2024-07-01 UTC Description: body
will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
discussionId
(ID
)
The ID of the discussion to which the comment belongs. This field is required.
Upcoming Change on 2024-07-01 UTC Description: discussionId
will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
Autogenerated input type of CreateTeamDiscussion.
Input fields forCreateTeamDiscussionInput
Name Description
body
(String
)
The content of the discussion. This field is required.
Upcoming Change on 2024-07-01 UTC Description: body
will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
private
(Boolean
)
If true, restricts the visibility of this discussion to team members and organization owners. If false or not specified, allows any organization member to view this discussion.
Upcoming Change on 2024-07-01 UTC Description: private
will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
teamId
(ID
)
The ID of the team to which the discussion belongs. This field is required.
Upcoming Change on 2024-07-01 UTC Description: teamId
will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
title
(String
)
The title of the discussion. This field is required.
Upcoming Change on 2024-07-01 UTC Description: title
will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
Autogenerated input type of CreateUserList.
Input fields forCreateUserListInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String
)
A description of the list.
isPrivate
(Boolean
)
Whether or not the list is private.
name
(String!
)
The name of the new list.
DeclineTopicSuggestionInputAutogenerated input type of DeclineTopicSuggestion.
Input fields forDeclineTopicSuggestionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String
)
The name of the suggested topic.
Upcoming Change on 2024-04-01 UTC Description: name
will be removed. Reason: Suggested topics are no longer supported.
reason
(TopicSuggestionDeclineReason
)
The reason why the suggested topic is declined.
Upcoming Change on 2024-04-01 UTC Description: reason
will be removed. Reason: Suggested topics are no longer supported.
repositoryId
(ID
)
The Node ID of the repository.
Upcoming Change on 2024-04-01 UTC Description: repositoryId
will be removed. Reason: Suggested topics are no longer supported.
Autogenerated input type of DeleteBranchProtectionRule.
Input fields forDeleteBranchProtectionRuleInput
Name Description
branchProtectionRuleId
(ID!
)
The global relay id of the branch protection rule to be deleted.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
DeleteDeploymentInputAutogenerated input type of DeleteDeployment.
Input fields forDeleteDeploymentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The Node ID of the deployment to be deleted.
Autogenerated input type of DeleteDiscussionComment.
Input fields forDeleteDiscussionCommentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The Node id of the discussion comment to delete.
DeleteDiscussionInputAutogenerated input type of DeleteDiscussion.
Input fields forDeleteDiscussionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The id of the discussion to delete.
DeleteEnvironmentInputAutogenerated input type of DeleteEnvironment.
Input fields forDeleteEnvironmentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The Node ID of the environment to be deleted.
DeleteIpAllowListEntryInputAutogenerated input type of DeleteIpAllowListEntry.
Input fields forDeleteIpAllowListEntryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
ipAllowListEntryId
(ID!
)
The ID of the IP allow list entry to delete.
Autogenerated input type of DeleteIssueComment.
Input fields forDeleteIssueCommentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the comment to delete.
DeleteIssueInputAutogenerated input type of DeleteIssue.
Input fields forDeleteIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
The ID of the issue to delete.
DeleteIssueTypeInputAutogenerated input type of DeleteIssueType.
Input fields forDeleteIssueTypeInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueTypeId
(ID!
)
The ID of the issue type to delete.
DeleteLabelInputAutogenerated input type of DeleteLabel.
Input fields forDeleteLabelInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The Node ID of the label to be deleted.
DeleteLinkedBranchInputAutogenerated input type of DeleteLinkedBranch.
Input fields forDeleteLinkedBranchInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
linkedBranchId
(ID!
)
The ID of the linked branch.
DeletePackageVersionInputAutogenerated input type of DeletePackageVersion.
Input fields forDeletePackageVersionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
packageVersionId
(ID!
)
The ID of the package version to be deleted.
DeleteProjectCardInputAutogenerated input type of DeleteProjectCard.
Input fields forDeleteProjectCardInput
Name Description
cardId
(ID!
)
The id of the card to delete.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
DeleteProjectColumnInputAutogenerated input type of DeleteProjectColumn.
Input fields forDeleteProjectColumnInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
columnId
(ID!
)
The id of the column to delete.
DeleteProjectInputAutogenerated input type of DeleteProject.
Input fields forDeleteProjectInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The Project ID to update.
DeleteProjectV2FieldInputAutogenerated input type of DeleteProjectV2Field.
Input fields forDeleteProjectV2FieldInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
fieldId
(ID!
)
The ID of the field to delete.
DeleteProjectV2InputAutogenerated input type of DeleteProjectV2.
Input fields forDeleteProjectV2Input
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the Project to delete.
DeleteProjectV2ItemInputAutogenerated input type of DeleteProjectV2Item.
Input fields forDeleteProjectV2ItemInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
itemId
(ID!
)
The ID of the item to be removed.
projectId
(ID!
)
The ID of the Project from which the item should be removed.
DeleteProjectV2StatusUpdateInputAutogenerated input type of DeleteProjectV2StatusUpdate.
Input fields forDeleteProjectV2StatusUpdateInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
statusUpdateId
(ID!
)
The ID of the status update to be removed.
DeleteProjectV2WorkflowInputAutogenerated input type of DeleteProjectV2Workflow.
Input fields forDeleteProjectV2WorkflowInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
workflowId
(ID!
)
The ID of the workflow to be removed.
Autogenerated input type of DeletePullRequestReviewComment.
Input fields forDeletePullRequestReviewCommentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the comment to delete.
DeletePullRequestReviewInputAutogenerated input type of DeletePullRequestReview.
Input fields forDeletePullRequestReviewInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
pullRequestReviewId
(ID!
)
The Node ID of the pull request review to delete.
DeleteRefInputAutogenerated input type of DeleteRef.
Input fields forDeleteRefInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
refId
(ID!
)
The Node ID of the Ref to be deleted.
DeleteRepositoryRulesetInputAutogenerated input type of DeleteRepositoryRuleset.
Input fields forDeleteRepositoryRulesetInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryRulesetId
(ID!
)
The global relay id of the repository ruleset to be deleted.
Autogenerated input type of DeleteTeamDiscussionComment.
Input fields forDeleteTeamDiscussionCommentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the comment to delete.
DeleteTeamDiscussionInputAutogenerated input type of DeleteTeamDiscussion.
Input fields forDeleteTeamDiscussionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The discussion ID to delete.
DeleteUserListInputAutogenerated input type of DeleteUserList.
Input fields forDeleteUserListInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
listId
(ID!
)
The ID of the list to delete.
DeleteVerifiableDomainInputAutogenerated input type of DeleteVerifiableDomain.
Input fields forDeleteVerifiableDomainInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the verifiable domain to delete.
DeploymentOrderOrdering options for deployment connections.
Input fields forDeploymentOrder
DequeuePullRequestInput
Autogenerated input type of DequeuePullRequest.
Input fields forDequeuePullRequestInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the pull request to be dequeued.
DisablePullRequestAutoMergeInputAutogenerated input type of DisablePullRequestAutoMerge.
Input fields forDisablePullRequestAutoMergeInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
pullRequestId
(ID!
)
ID of the pull request to disable auto merge on.
DiscussionOrderWays in which lists of discussions can be ordered upon return.
Input fields forDiscussionOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order discussions by the specified field.
field
(DiscussionOrderField!
)
The field by which to order discussions.
DiscussionPollOptionOrderOrdering options for discussion poll option connections.
Input fields forDiscussionPollOptionOrder
DismissPullRequestReviewInput
Autogenerated input type of DismissPullRequestReview.
Input fields forDismissPullRequestReviewInput
Name Description
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.
DismissRepositoryVulnerabilityAlertInputAutogenerated input type of DismissRepositoryVulnerabilityAlert.
Input fields forDismissRepositoryVulnerabilityAlertInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
dismissReason
(DismissReason!
)
The reason the Dependabot alert is being dismissed.
repositoryVulnerabilityAlertId
(ID!
)
The Dependabot alert ID to dismiss.
Specifies a review comment to be left with a Pull Request Review.
Input fields forDraftPullRequestReviewComment
Name Description
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.
DraftPullRequestReviewThreadSpecifies a review comment thread to be left with a Pull Request Review.
Input fields forDraftPullRequestReviewThread
Name Description
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.
EnablePullRequestAutoMergeInputAutogenerated input type of EnablePullRequestAutoMerge.
Input fields forEnablePullRequestAutoMergeInput
Name Description
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.
EnqueuePullRequestInputAutogenerated input type of EnqueuePullRequest.
Input fields forEnqueuePullRequestInput
Name Description
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.
EnterpriseMemberOrderOrdering options for enterprise member connections.
Input fields forEnterpriseMemberOrder
EnterpriseOrder
Ordering options for enterprises.
Input fields forEnterpriseOrder
Environments
Ordering options for environments.
Input fields forEnvironments
FileAddition
A command to add a file at the given path with the given contents as part of a commit. Any existing file at that that path will be replaced.
Input fields forFileAddition
Name Description
contents
(Base64String!
)
The base64 encoded contents of the file.
path
(String!
)
The path in the repository where the file will be located.
FileChangesA description of a set of changes to a file tree to be made as part of a git commit, modeled as zero or more file additions
and zero or more file deletions
.
Both fields are optional; omitting both will produce a commit with no file changes.
deletions
and additions
describe changes to files identified by their path in the git tree using unix-style path separators, i.e. /
. The root of a git tree is an empty string, so paths are not slash-prefixed.
path
values must be unique across all additions
and deletions
provided. Any duplication will result in a validation error.
File contents must be provided in full for each FileAddition
.
The contents
of a FileAddition
must be encoded using RFC 4648 compliant base64, i.e. correct padding is required and no characters outside the standard alphabet may be used. Invalid base64 encoding will be rejected with a validation error.
The encoded contents may be binary.
For text files, no assumptions are made about the character encoding of the file contents (after base64 decoding). No charset transcoding or line-ending normalization will be performed; it is the client's responsibility to manage the character encoding of files they provide. However, for maximum compatibility we recommend using UTF-8 encoding and ensuring that all files in a repository use a consistent line-ending convention (\n
or \r\n
), and that all files end with a newline.
Each of the the five types of conceptual changes that can be made in a git commit can be described using the FileChanges
type as follows:
New file addition: create file hello world\n
at path docs/README.txt
:
{
"additions" [
{
"path": "docs/README.txt",
"contents": base64encode("hello world\n")
}
]
}
Existing file modification: change existing docs/README.txt
to have new content new content here\n
:
{
"additions" [
{
"path": "docs/README.txt",
"contents": base64encode("new content here\n")
}
]
}
Existing file deletion: remove existing file docs/README.txt
. Note that the path is required to exist -- specifying a path that does not exist on the given branch will abort the commit and return an error.
{
"deletions" [
{
"path": "docs/README.txt"
}
]
}
File rename with no changes: rename docs/README.txt
with previous content hello world\n
to the same content at newdocs/README.txt
:
{
"deletions" [
{
"path": "docs/README.txt",
}
],
"additions" [
{
"path": "newdocs/README.txt",
"contents": base64encode("hello world\n")
}
]
}
File rename with changes: rename docs/README.txt
with previous content hello world\n
to a file at path newdocs/README.txt
with content new contents\n
:
{
"deletions" [
{
"path": "docs/README.txt",
}
],
"additions" [
{
"path": "newdocs/README.txt",
"contents": base64encode("new contents\n")
}
]
}.
FileChanges
FileDeletion
A command to delete the file at the given path as part of a commit.
Input fields forFileDeletion
Name Description
path
(String!
)
The path to delete.
FileExtensionRestrictionParametersInputPrevent commits that include files with specified file extensions from being pushed to the commit graph.
Input fields forFileExtensionRestrictionParametersInput
Name Description
restrictedFileExtensions
([String!]!
)
The file extensions that are restricted from being pushed to the commit graph.
FilePathRestrictionParametersInputPrevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
Input fields forFilePathRestrictionParametersInput
Name Description
restrictedFilePaths
([String!]!
)
The file paths that are restricted from being pushed to the commit graph.
FollowOrganizationInputAutogenerated input type of FollowOrganization.
Input fields forFollowOrganizationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
organizationId
(ID!
)
ID of the organization to follow.
FollowUserInputAutogenerated input type of FollowUser.
Input fields forFollowUserInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
userId
(ID!
)
ID of the user to follow.
GistOrderOrdering options for gist connections.
Input fields forGistOrder
GrantEnterpriseOrganizationsMigratorRoleInput
Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.
Input fields forGrantEnterpriseOrganizationsMigratorRoleInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise to which all organizations managed by it will be granted the migrator role.
login
(String!
)
The login of the user to grant the migrator role.
GrantMigratorRoleInputAutogenerated input type of GrantMigratorRole.
Input fields forGrantMigratorRoleInput
Name Description
actor
(String!
)
The user login or Team slug to grant the migrator role.
actorType
(ActorType!
)
Specifies the type of the actor, can be either USER or TEAM.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
organizationId
(ID!
)
The ID of the organization that the user/team belongs to.
ImportProjectInputAutogenerated input type of ImportProject.
Input fields forImportProjectInput
Name Description
body
(String
)
The description of Project.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
columnImports
([ProjectColumnImport!]!
)
A list of columns containing issues and pull requests.
name
(String!
)
The name of Project.
ownerName
(String!
)
The name of the Organization or User to create the Project under.
public
(Boolean
)
Whether the Project is public or not.
InviteEnterpriseAdminInputAutogenerated input type of InviteEnterpriseAdmin.
Input fields forInviteEnterpriseAdminInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
email
(String
)
The email of the person to invite as an administrator.
enterpriseId
(ID!
)
The ID of the enterprise to which you want to invite an administrator.
invitee
(String
)
The login of a user to invite as an administrator.
role
(EnterpriseAdministratorRole
)
The role of the administrator.
InviteEnterpriseMemberInputAutogenerated input type of InviteEnterpriseMember.
Input fields forInviteEnterpriseMemberInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
email
(String
)
The email of the person to invite as an unaffiliated member.
enterpriseId
(ID!
)
The ID of the enterprise to which you want to invite an unaffiliated member.
invitee
(String
)
The login of a user to invite as an unaffiliated member.
IpAllowListEntryOrderOrdering options for IP allow list entry connections.
Input fields forIpAllowListEntryOrder
Ways in which lists of issue comments can be ordered upon return.
Input fields forIssueCommentOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order issue comments by the specified field.
field
(IssueCommentOrderField!
)
The field in which to order issue comments by.
IssueFiltersWays in which to filter lists of issues.
Input fields forIssueFilters
Name Description
assignee
(String
)
List issues assigned to given name. Pass in null
for issues with no assigned user, and *
for issues assigned to any user.
createdBy
(String
)
List issues created by given name.
labels
([String!]
)
List issues where the list of label names exist on the issue.
mentioned
(String
)
List issues where the given name is mentioned in the issue.
milestone
(String
)
List issues by given milestone argument. If an string representation of an integer is passed, it should refer to a milestone by its database ID. Pass in null
for issues with no milestone, and *
for issues that are assigned to any milestone.
milestoneNumber
(String
)
List issues by given milestone argument. If an string representation of an integer is passed, it should refer to a milestone by its number field. Pass in null
for issues with no milestone, and *
for issues that are assigned to any milestone.
since
(DateTime
)
List issues that have been updated at or after the given date.
states
([IssueState!]
)
List issues filtered by the list of states given.
type
(String
)
List issues filtered by the type given, only supported by searches on repositories.
viewerSubscribed
(Boolean
)
List issues subscribed to by viewer.
IssueOrderWays in which lists of issues can be ordered upon return.
Input fields forIssueOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order issues by the specified field.
field
(IssueOrderField!
)
The field in which to order issues by.
IssueTypeOrderOrdering options for issue types connections.
Input fields forIssueTypeOrder
LabelOrder
Ways in which lists of labels can be ordered upon return.
Input fields forLabelOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order labels by the specified field.
field
(LabelOrderField!
)
The field in which to order labels by.
LanguageOrderOrdering options for language connections.
Input fields forLanguageOrder
LinkProjectV2ToRepositoryInput
Autogenerated input type of LinkProjectV2ToRepository.
Input fields forLinkProjectV2ToRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the project to link to the repository.
repositoryId
(ID!
)
The ID of the repository to link to the project.
LinkProjectV2ToTeamInputAutogenerated input type of LinkProjectV2ToTeam.
Input fields forLinkProjectV2ToTeamInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the project to link to the team.
teamId
(ID!
)
The ID of the team to link to the project.
LinkRepositoryToProjectInputAutogenerated input type of LinkRepositoryToProject.
Input fields forLinkRepositoryToProjectInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the Project to link to a Repository.
repositoryId
(ID!
)
The ID of the Repository to link to a Project.
LockLockableInputAutogenerated input type of LockLockable.
Input fields forLockLockableInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
lockReason
(LockReason
)
A reason for why the item will be locked.
lockableId
(ID!
)
ID of the item to be locked.
MannequinOrderOrdering options for mannequins.
Input fields forMannequinOrder
Autogenerated input type of MarkDiscussionCommentAsAnswer.
Input fields forMarkDiscussionCommentAsAnswerInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The Node ID of the discussion comment to mark as an answer.
MarkFileAsViewedInputAutogenerated input type of MarkFileAsViewed.
Input fields forMarkFileAsViewedInput
Name Description
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.
MarkProjectV2AsTemplateInputAutogenerated input type of MarkProjectV2AsTemplate.
Input fields forMarkProjectV2AsTemplateInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the Project to mark as a template.
MarkPullRequestReadyForReviewInputAutogenerated input type of MarkPullRequestReadyForReview.
Input fields forMarkPullRequestReadyForReviewInput
Name Description
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.
MaxFilePathLengthParametersInputPrevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
Input fields forMaxFilePathLengthParametersInput
Name Description
maxFilePathLength
(Int!
)
The maximum amount of characters allowed in file paths.
MaxFileSizeParametersInputPrevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
Input fields forMaxFileSizeParametersInput
Name Description
maxFileSize
(Int!
)
The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
MergeBranchInputAutogenerated input type of MergeBranch.
Input fields forMergeBranchInput
Name Description
authorEmail
(String
)
The email address to associate with this commit.
base
(String!
)
The name of the base branch that the provided head will be merged into.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
commitMessage
(String
)
Message to use for the merge commit. If omitted, a default will be used.
head
(String!
)
The head to merge into the base branch. This can be a branch name or a commit GitObjectID.
repositoryId
(ID!
)
The Node ID of the Repository containing the base branch that will be modified.
MergePullRequestInputAutogenerated input type of MergePullRequest.
Input fields forMergePullRequestInput
Name Description
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.
MergeQueueParametersInputMerges must be performed via a merge queue.
Input fields forMergeQueueParametersInput
Name Description
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.
MilestoneOrderOrdering options for milestone connections.
Input fields forMilestoneOrder
Autogenerated input type of MinimizeComment.
Input fields forMinimizeCommentInput
Name Description
classifier
(ReportedContentClassifiers!
)
The classification of comment.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
subjectId
(ID!
)
The Node ID of the subject to modify.
MoveProjectCardInputAutogenerated input type of MoveProjectCard.
Input fields forMoveProjectCardInput
Name Description
afterCardId
(ID
)
Place the new card after the card with this id. Pass null to place it at the top.
cardId
(ID!
)
The id of the card to move.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
columnId
(ID!
)
The id of the column to move it into.
MoveProjectColumnInputAutogenerated input type of MoveProjectColumn.
Input fields forMoveProjectColumnInput
Name Description
afterColumnId
(ID
)
Place the new column after the column with this id. Pass null to place it at the front.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
columnId
(ID!
)
The id of the column to move.
OrgEnterpriseOwnerOrderOrdering options for an organization's enterprise owner connections.
Input fields forOrgEnterpriseOwnerOrder
OrganizationOrder
Ordering options for organization connections.
Input fields forOrganizationOrder
PackageFileOrder
Ways in which lists of package files can be ordered upon return.
Input fields forPackageFileOrder
Name Description
direction
(OrderDirection
)
The direction in which to order package files by the specified field.
field
(PackageFileOrderField
)
The field in which to order package files by.
PackageOrderWays in which lists of packages can be ordered upon return.
Input fields forPackageOrder
Name Description
direction
(OrderDirection
)
The direction in which to order packages by the specified field.
field
(PackageOrderField
)
The field in which to order packages by.
PackageVersionOrderWays in which lists of package versions can be ordered upon return.
Input fields forPackageVersionOrder
Name Description
direction
(OrderDirection
)
The direction in which to order package versions by the specified field.
field
(PackageVersionOrderField
)
The field in which to order package versions by.
PinEnvironmentInputAutogenerated input type of PinEnvironment.
Input fields forPinEnvironmentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
environmentId
(ID!
)
The ID of the environment to modify.
pinned
(Boolean!
)
The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.
PinIssueInputAutogenerated input type of PinIssue.
Input fields forPinIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
The ID of the issue to be pinned.
ProjectCardImportAn issue or PR and its owning repository to be used in a project card.
Input fields forProjectCardImport
Name Description
number
(Int!
)
The issue or pull request number.
repository
(String!
)
Repository name with owner (owner/repository).
ProjectColumnImportA project column and a list of its issues and PRs.
Input fields forProjectColumnImport
Name Description
columnName
(String!
)
The name of the column.
issues
([ProjectCardImport!]
)
A list of issues and pull requests in the column.
position
(Int!
)
The position of the column, starting from 0.
ProjectOrderWays in which lists of projects can be ordered upon return.
Input fields forProjectOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order projects by the specified field.
field
(ProjectOrderField!
)
The field in which to order projects by.
ProjectV2CollaboratorA collaborator to update on a project. Only one of the userId or teamId should be provided.
Input fields forProjectV2Collaborator
Name Description
role
(ProjectV2Roles!
)
The role to grant the collaborator.
teamId
(ID
)
The ID of the team as a collaborator.
userId
(ID
)
The ID of the user as a collaborator.
ProjectV2FieldOrderOrdering options for project v2 field connections.
Input fields forProjectV2FieldOrder
ProjectV2FieldValue
The values that can be used to update a field of an item inside a Project. Only 1 value can be updated at a time.
Input fields forProjectV2FieldValue
Name Description
date
(Date
)
The ISO 8601 date to set on the field.
iterationId
(String
)
The id of the iteration to set on the field.
number
(Float
)
The number to set on the field.
singleSelectOptionId
(String
)
The id of the single select option to set on the field.
text
(String
)
The text to set on the field.
ProjectV2FiltersWays in which to filter lists of projects.
Input fields forProjectV2Filters
Name Description
state
(ProjectV2State
)
List project v2 filtered by the state given.
ProjectV2ItemOrderOrdering options for project v2 item connections.
Input fields forProjectV2ItemOrder
ProjectV2Iteration
Represents an iteration.
Input fields forProjectV2Iteration
Name Description
duration
(Int!
)
The duration of the iteration, in days.
startDate
(Date!
)
The start date for the iteration.
title
(String!
)
The title for the iteration.
ProjectV2OrderWays in which lists of projects can be ordered upon return.
Input fields forProjectV2Order
Name Description
direction
(OrderDirection!
)
The direction in which to order projects by the specified field.
field
(ProjectV2OrderField!
)
The field in which to order projects by.
ProjectV2StatusOrderWays in which project v2 status updates can be ordered.
Input fields forProjectV2StatusOrder
ProjectV2ViewOrder
Ordering options for project v2 view connections.
Input fields forProjectV2ViewOrder
ProjectV2WorkflowOrder
Ordering options for project v2 workflows connections.
Input fields forProjectV2WorkflowOrder
PropertyTargetDefinitionInput
A property that must match.
Input fields forPropertyTargetDefinitionInput
Name Description
name
(String!
)
The name of the property.
propertyValues
([String!]!
)
The values to match for.
source
(String
)
The source of the property. Choosecustom
or 'system'. Defaults to 'custom' if not specified.
Autogenerated input type of PublishSponsorsTier.
Input fields forPublishSponsorsTierInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
tierId
(ID!
)
The ID of the draft tier to publish.
PullRequestOrderWays in which lists of issues can be ordered upon return.
Input fields forPullRequestOrder
Name Description
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.
PullRequestParametersInputRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Input fields forPullRequestParametersInput
Name Description
allowedMergeMethods
([PullRequestAllowedMergeMethods!]
)
Array of allowed merge methods. Allowed values include merge
, squash
, and rebase
. At least one option must be enabled.
automaticCopilotCodeReviewEnabled
(Boolean
)
Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.
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.
ReactionOrderWays in which lists of reactions can be ordered upon return.
Input fields forReactionOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order reactions by the specified field.
field
(ReactionOrderField!
)
The field in which to order reactions by.
RefNameConditionTargetInputParameters to be used for the ref_name condition.
Input fields forRefNameConditionTargetInput
Name Description
exclude
([String!]!
)
Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
include
([String!]!
)
Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH
to include the default branch or ~ALL
to include all branches.
Ways in which lists of git refs can be ordered upon return.
Input fields forRefOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order refs by the specified field.
field
(RefOrderField!
)
The field in which to order refs by.
RefUpdateA ref update.
Input fields forRefUpdate
Name Description
afterOid
(GitObjectID!
)
The value this ref should be updated to.
beforeOid
(GitObjectID
)
The value this ref needs to point to before the update.
force
(Boolean
)
Force a non fast-forward update.
name
(GitRefname!
)
The fully qualified name of the ref to be update. For example refs/heads/branch-name
.
Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.
Input fields forRegenerateEnterpriseIdentityProviderRecoveryCodesInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set an identity provider.
RegenerateVerifiableDomainTokenInputAutogenerated input type of RegenerateVerifiableDomainToken.
Input fields forRegenerateVerifiableDomainTokenInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the verifiable domain to regenerate the verification token of.
RejectDeploymentsInputAutogenerated input type of RejectDeployments.
Input fields forRejectDeploymentsInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
comment
(String
)
Optional comment for rejecting deployments.
environmentIds
([ID!]!
)
The ids of environments to reject deployments.
workflowRunId
(ID!
)
The node ID of the workflow run containing the pending deployments.
ReleaseOrderWays in which lists of releases can be ordered upon return.
Input fields forReleaseOrder
Name Description
direction
(OrderDirection!
)
The direction in which to order releases by the specified field.
field
(ReleaseOrderField!
)
The field in which to order releases by.
RemoveAssigneesFromAssignableInputAutogenerated input type of RemoveAssigneesFromAssignable.
Input fields forRemoveAssigneesFromAssignableInput
Name Description
assignableId
(ID!
)
The id of the assignable object to remove assignees from.
assigneeIds
([ID!]!
)
The id of users to remove as assignees.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
RemoveEnterpriseAdminInputAutogenerated input type of RemoveEnterpriseAdmin.
Input fields forRemoveEnterpriseAdminInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The Enterprise ID from which to remove the administrator.
login
(String!
)
The login of the user to remove as an administrator.
RemoveEnterpriseIdentityProviderInputAutogenerated input type of RemoveEnterpriseIdentityProvider.
Input fields forRemoveEnterpriseIdentityProviderInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise from which to remove the identity provider.
RemoveEnterpriseMemberInputAutogenerated input type of RemoveEnterpriseMember.
Input fields forRemoveEnterpriseMemberInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise from which the user should be removed.
userId
(ID!
)
The ID of the user to remove from the enterprise.
RemoveEnterpriseOrganizationInputAutogenerated input type of RemoveEnterpriseOrganization.
Input fields forRemoveEnterpriseOrganizationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise from which the organization should be removed.
organizationId
(ID!
)
The ID of the organization to remove from the enterprise.
RemoveEnterpriseSupportEntitlementInputAutogenerated input type of RemoveEnterpriseSupportEntitlement.
Input fields forRemoveEnterpriseSupportEntitlementInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the Enterprise which the admin belongs to.
login
(String!
)
The login of a member who will lose the support entitlement.
RemoveLabelsFromLabelableInputAutogenerated input type of RemoveLabelsFromLabelable.
Input fields forRemoveLabelsFromLabelableInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
labelIds
([ID!]!
)
The ids of labels to remove.
labelableId
(ID!
)
The id of the Labelable to remove labels from.
RemoveOutsideCollaboratorInputAutogenerated input type of RemoveOutsideCollaborator.
Input fields forRemoveOutsideCollaboratorInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
organizationId
(ID!
)
The ID of the organization to remove the outside collaborator from.
userId
(ID!
)
The ID of the outside collaborator to remove.
RemoveReactionInputAutogenerated input type of RemoveReaction.
Input fields forRemoveReactionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
content
(ReactionContent!
)
The name of the emoji reaction to remove.
subjectId
(ID!
)
The Node ID of the subject to modify.
RemoveStarInputAutogenerated input type of RemoveStar.
Input fields forRemoveStarInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
starrableId
(ID!
)
The Starrable ID to unstar.
RemoveSubIssueInputAutogenerated input type of RemoveSubIssue.
Input fields forRemoveSubIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
The id of the issue.
subIssueId
(ID!
)
The id of the sub-issue.
RemoveUpvoteInputAutogenerated input type of RemoveUpvote.
Input fields forRemoveUpvoteInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
subjectId
(ID!
)
The Node ID of the discussion or comment to remove upvote.
ReopenDiscussionInputAutogenerated input type of ReopenDiscussion.
Input fields forReopenDiscussionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
discussionId
(ID!
)
ID of the discussion to be reopened.
ReopenIssueInputAutogenerated input type of ReopenIssue.
Input fields forReopenIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
ID of the issue to be opened.
ReopenPullRequestInputAutogenerated input type of ReopenPullRequest.
Input fields forReopenPullRequestInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
pullRequestId
(ID!
)
ID of the pull request to be reopened.
ReorderEnvironmentInputAutogenerated input type of ReorderEnvironment.
Input fields forReorderEnvironmentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
environmentId
(ID!
)
The ID of the environment to modify.
position
(Int!
)
The desired position of the environment.
ReplaceActorsForAssignableInputAutogenerated input type of ReplaceActorsForAssignable.
Input fields forReplaceActorsForAssignableInput
Name Description
actorIds
([ID!]!
)
The ids of the actors to replace the existing assignees.
assignableId
(ID!
)
The id of the assignable object to replace the assignees for.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
RepositoryIdConditionTargetInputParameters to be used for the repository_id condition.
Input fields forRepositoryIdConditionTargetInput
Name Description
repositoryIds
([ID!]!
)
One of these repo IDs must match the repo.
RepositoryNameConditionTargetInputParameters to be used for the repository_name condition.
Input fields forRepositoryNameConditionTargetInput
Name Description
exclude
([String!]!
)
Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
include
([String!]!
)
Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL
to include all repositories.
protected
(Boolean
)
Target changes that match these patterns will be prevented except by those with bypass permissions.
RepositoryOrderOrdering options for repository connections.
Input fields forRepositoryOrder
RepositoryRuleInput
Specifies the attributes for a new or updated rule.
Input fields forRepositoryRuleInput
RepositoryRuleOrder
Ordering options for repository rules.
Input fields forRepositoryRuleOrder
RepositoryRulesetBypassActorInput
Specifies the attributes for a new or updated ruleset bypass actor. Only one of actor_id
, repository_role_database_id
, organization_admin
, or deploy_key
should be specified.
RepositoryRulesetBypassActorInput
Name Description
actorId
(ID
)
For Team and Integration bypasses, the Team or Integration ID.
bypassMode
(RepositoryRulesetBypassActorBypassMode!
)
The bypass mode for this actor.
deployKey
(Boolean
)
For deploy key bypasses, true. Can only use ALWAYS as the bypass mode.
enterpriseOwner
(Boolean
)
For enterprise owner bypasses, true.
organizationAdmin
(Boolean
)
For organization owner bypasses, true.
repositoryRoleDatabaseId
(Int
)
For role bypasses, the role database ID.
ReprioritizeSubIssueInputAutogenerated input type of ReprioritizeSubIssue.
Input fields forReprioritizeSubIssueInput
Name Description
afterId
(ID
)
The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified).
beforeId
(ID
)
The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified).
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
The id of the parent issue.
subIssueId
(ID!
)
The id of the sub-issue to reprioritize.
RequestReviewsInputAutogenerated input type of RequestReviews.
Input fields forRequestReviewsInput
Name Description
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.
RequiredDeploymentsParametersInputChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Input fields forRequiredDeploymentsParametersInput
Name Description
requiredDeploymentEnvironments
([String!]!
)
The environments that must be successfully deployed to before branches can be merged.
RequiredStatusCheckInputSpecifies the attributes for a new or updated required status check.
Input fields forRequiredStatusCheckInput
Name Description
appId
(ID
)
The ID of the App that must set the status in order for it to be accepted. Omit this value to use whichever app has recently been setting this status, or use "any" to allow any app to set the status.
context
(String!
)
Status check context that must pass for commits to be accepted to the matching branch.
RequiredStatusChecksParametersInputChoose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
Input fields forRequiredStatusChecksParametersInput
Name Description
doNotEnforceOnCreate
(Boolean
)
Allow repositories and branches to be created if a check would otherwise prohibit it.
requiredStatusChecks
([StatusCheckConfigurationInput!]!
)
Status checks that are required.
strictRequiredStatusChecksPolicy
(Boolean!
)
Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
RerequestCheckSuiteInputAutogenerated input type of RerequestCheckSuite.
Input fields forRerequestCheckSuiteInput
Name Description
checkSuiteId
(ID!
)
The Node ID of the check suite.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryId
(ID!
)
The Node ID of the repository.
ResolveReviewThreadInputAutogenerated input type of ResolveReviewThread.
Input fields forResolveReviewThreadInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
threadId
(ID!
)
The ID of the thread to resolve.
Autogenerated input type of RetireSponsorsTier.
Input fields forRetireSponsorsTierInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
tierId
(ID!
)
The ID of the published tier to retire.
RevertPullRequestInputAutogenerated input type of RevertPullRequest.
Input fields forRevertPullRequestInput
Name Description
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.
RevokeEnterpriseOrganizationsMigratorRoleInputAutogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.
Input fields forRevokeEnterpriseOrganizationsMigratorRoleInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise to which all organizations managed by it will be granted the migrator role.
login
(String!
)
The login of the user to revoke the migrator role.
RevokeMigratorRoleInputAutogenerated input type of RevokeMigratorRole.
Input fields forRevokeMigratorRoleInput
Name Description
actor
(String!
)
The user login or Team slug to revoke the migrator role from.
actorType
(ActorType!
)
Specifies the type of the actor, can be either USER or TEAM.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
organizationId
(ID!
)
The ID of the organization that the user/team belongs to.
RuleParametersInputSpecifies the parameters for a RepositoryRule
object. Only one of the fields should be specified.
RuleParametersInput
SavedReplyOrder
Ordering options for saved reply connections.
Input fields forSavedReplyOrder
SecurityAdvisoryOrder
Ordering options for security advisory connections.
Input fields forSecurityAdvisoryOrder
SetEnterpriseIdentityProviderInput
Autogenerated input type of SetEnterpriseIdentityProvider.
Input fields forSetEnterpriseIdentityProviderInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
digestMethod
(SamlDigestAlgorithm!
)
The digest algorithm used to sign SAML requests for the identity provider.
enterpriseId
(ID!
)
The ID of the enterprise on which to set an identity provider.
idpCertificate
(String!
)
The x509 certificate used by the identity provider to sign assertions and responses.
issuer
(String
)
The Issuer Entity ID for the SAML identity provider.
signatureMethod
(SamlSignatureAlgorithm!
)
The signature algorithm used to sign SAML requests for the identity provider.
ssoUrl
(URI!
)
The URL endpoint for the identity provider's SAML SSO.
Ordering options for connections to get sponsor entities and associated USD amounts for GitHub Sponsors.
Input fields forSponsorAndLifetimeValueOrder
Ordering options for connections to get sponsor entities for GitHub Sponsors.
Input fields forSponsorOrder
Ordering options for connections to get sponsorable entities for GitHub Sponsors.
Input fields forSponsorableOrder
Ordering options for GitHub Sponsors activity connections.
Input fields forSponsorsActivityOrder
Ordering options for Sponsors tiers connections.
Input fields forSponsorsTierOrder
Ordering options for sponsorship newsletter connections.
Input fields forSponsorshipNewsletterOrder
Ordering options for sponsorship connections.
Input fields forSponsorshipOrder
StarOrder
Ways in which star connections can be ordered.
Input fields forStarOrder
StartOrganizationMigrationInput
Autogenerated input type of StartOrganizationMigration.
Input fields forStartOrganizationMigrationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
sourceAccessToken
(String!
)
The migration source access token.
sourceOrgUrl
(URI!
)
The URL of the organization to migrate.
targetEnterpriseId
(ID!
)
The ID of the enterprise the target organization belongs to.
targetOrgName
(String!
)
The name of the target organization.
StartRepositoryMigrationInputAutogenerated input type of StartRepositoryMigration.
Input fields forStartRepositoryMigrationInput
Name Description
accessToken
(String
)
The migration source access token.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
continueOnError
(Boolean
)
Whether to continue the migration on error. Defaults to true
.
gitArchiveUrl
(String
)
The signed URL to access the user-uploaded git archive.
githubPat
(String
)
The GitHub personal access token of the user importing to the target repository.
lockSource
(Boolean
)
Whether to lock the source repository.
metadataArchiveUrl
(String
)
The signed URL to access the user-uploaded metadata archive.
ownerId
(ID!
)
The ID of the organization that will own the imported repository.
repositoryName
(String!
)
The name of the imported repository.
skipReleases
(Boolean
)
Whether to skip migrating releases for the repository.
sourceId
(ID!
)
The ID of the migration source.
sourceRepositoryUrl
(URI!
)
The URL of the source repository.
targetRepoVisibility
(String
)
The visibility of the imported repository.
StatusCheckConfigurationInputRequired status check.
Input fields forStatusCheckConfigurationInput
Name Description
context
(String!
)
The status check context name that must be present on the commit.
integrationId
(Int
)
The optional integration ID that this status check must originate from.
SubmitPullRequestReviewInputAutogenerated input type of SubmitPullRequestReview.
Input fields forSubmitPullRequestReviewInput
Name Description
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.
TagNamePatternParametersInputParameters to be used for the tag_name_pattern rule.
Input fields forTagNamePatternParametersInput
Name Description
name
(String
)
How this rule will appear to users.
negate
(Boolean
)
If true, the rule will fail if the pattern matches.
operator
(String!
)
The operator to use for matching.
pattern
(String!
)
The pattern to match with.
Ways in which team discussion comment connections can be ordered.
Input fields forTeamDiscussionCommentOrder
TeamDiscussionOrder
Ways in which team discussion connections can be ordered.
Input fields forTeamDiscussionOrder
TeamMemberOrder
Ordering options for team member connections.
Input fields forTeamMemberOrder
TeamOrder
Ways in which team connections can be ordered.
Input fields forTeamOrder
TeamRepositoryOrder
Ordering options for team repository connections.
Input fields forTeamRepositoryOrder
TransferEnterpriseOrganizationInput
Autogenerated input type of TransferEnterpriseOrganization.
Input fields forTransferEnterpriseOrganizationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
destinationEnterpriseId
(ID!
)
The ID of the enterprise where the organization should be transferred.
organizationId
(ID!
)
The ID of the organization to transfer.
TransferIssueInputAutogenerated input type of TransferIssue.
Input fields forTransferIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
createLabelsIfMissing
(Boolean
)
Whether to create labels if they don't exist in the target repository (matched by name).
issueId
(ID!
)
The Node ID of the issue to be transferred.
repositoryId
(ID!
)
The Node ID of the repository the issue should be transferred to.
UnarchiveProjectV2ItemInputAutogenerated input type of UnarchiveProjectV2Item.
Input fields forUnarchiveProjectV2ItemInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
itemId
(ID!
)
The ID of the ProjectV2Item to unarchive.
projectId
(ID!
)
The ID of the Project to archive the item from.
UnarchiveRepositoryInputAutogenerated input type of UnarchiveRepository.
Input fields forUnarchiveRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryId
(ID!
)
The ID of the repository to unarchive.
UnfollowOrganizationInputAutogenerated input type of UnfollowOrganization.
Input fields forUnfollowOrganizationInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
organizationId
(ID!
)
ID of the organization to unfollow.
UnfollowUserInputAutogenerated input type of UnfollowUser.
Input fields forUnfollowUserInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
userId
(ID!
)
ID of the user to unfollow.
UnlinkProjectV2FromRepositoryInputAutogenerated input type of UnlinkProjectV2FromRepository.
Input fields forUnlinkProjectV2FromRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the project to unlink from the repository.
repositoryId
(ID!
)
The ID of the repository to unlink from the project.
UnlinkProjectV2FromTeamInputAutogenerated input type of UnlinkProjectV2FromTeam.
Input fields forUnlinkProjectV2FromTeamInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the project to unlink from the team.
teamId
(ID!
)
The ID of the team to unlink from the project.
UnlinkRepositoryFromProjectInputAutogenerated input type of UnlinkRepositoryFromProject.
Input fields forUnlinkRepositoryFromProjectInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the Project linked to the Repository.
repositoryId
(ID!
)
The ID of the Repository linked to the Project.
UnlockLockableInputAutogenerated input type of UnlockLockable.
Input fields forUnlockLockableInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
lockableId
(ID!
)
ID of the item to be unlocked.
Autogenerated input type of UnmarkDiscussionCommentAsAnswer.
Input fields forUnmarkDiscussionCommentAsAnswerInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The Node ID of the discussion comment to unmark as an answer.
UnmarkFileAsViewedInputAutogenerated input type of UnmarkFileAsViewed.
Input fields forUnmarkFileAsViewedInput
Name Description
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.
UnmarkIssueAsDuplicateInputAutogenerated input type of UnmarkIssueAsDuplicate.
Input fields forUnmarkIssueAsDuplicateInput
Name Description
canonicalId
(ID!
)
ID of the issue or pull request currently considered canonical/authoritative/original.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
duplicateId
(ID!
)
ID of the issue or pull request currently marked as a duplicate.
UnmarkProjectV2AsTemplateInputAutogenerated input type of UnmarkProjectV2AsTemplate.
Input fields forUnmarkProjectV2AsTemplateInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
projectId
(ID!
)
The ID of the Project to unmark as a template.
Autogenerated input type of UnminimizeComment.
Input fields forUnminimizeCommentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
subjectId
(ID!
)
The Node ID of the subject to modify.
UnpinIssueInputAutogenerated input type of UnpinIssue.
Input fields forUnpinIssueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
The ID of the issue to be unpinned.
UnresolveReviewThreadInputAutogenerated input type of UnresolveReviewThread.
Input fields forUnresolveReviewThreadInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
threadId
(ID!
)
The ID of the thread to unresolve.
UpdateBranchProtectionRuleInputAutogenerated input type of UpdateBranchProtectionRule.
Input fields forUpdateBranchProtectionRuleInput
Name Description
allowsDeletions
(Boolean
)
Can this branch be deleted.
allowsForcePushes
(Boolean
)
Are force pushes allowed on this branch.
blocksCreations
(Boolean
)
Is branch creation a protected operation.
branchProtectionRuleId
(ID!
)
The global relay id of the branch protection rule to be updated.
bypassForcePushActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.
bypassPullRequestActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
dismissesStaleReviews
(Boolean
)
Will new commits pushed to matching branches dismiss pull request review approvals.
isAdminEnforced
(Boolean
)
Can admins override branch protection.
lockAllowsFetchAndMerge
(Boolean
)
Whether users can pull changes from upstream when the branch is locked. Set to true
to allow fork syncing. Set to false
to prevent fork syncing.
lockBranch
(Boolean
)
Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
pattern
(String
)
The glob-like pattern used to determine matching branches.
pushActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to push to matching branches.
requireLastPushApproval
(Boolean
)
Whether the most recent push must be approved by someone other than the person who pushed it.
requiredApprovingReviewCount
(Int
)
Number of approving reviews required to update matching branches.
requiredDeploymentEnvironments
([String!]
)
The list of required deployment environments.
requiredStatusCheckContexts
([String!]
)
List of required status check contexts that must pass for commits to be accepted to matching branches.
requiredStatusChecks
([RequiredStatusCheckInput!]
)
The list of required status checks.
requiresApprovingReviews
(Boolean
)
Are approving reviews required to update matching branches.
requiresCodeOwnerReviews
(Boolean
)
Are reviews from code owners required to update matching branches.
requiresCommitSignatures
(Boolean
)
Are commits required to be signed.
requiresConversationResolution
(Boolean
)
Are conversations required to be resolved before merging.
requiresDeployments
(Boolean
)
Are successful deployments required before merging.
requiresLinearHistory
(Boolean
)
Are merge commits prohibited from being pushed to this branch.
requiresStatusChecks
(Boolean
)
Are status checks required to update matching branches.
requiresStrictStatusChecks
(Boolean
)
Are branches required to be up to date before merging.
restrictsPushes
(Boolean
)
Is pushing to matching branches restricted.
restrictsReviewDismissals
(Boolean
)
Is dismissal of pull request reviews restricted.
reviewDismissalActorIds
([ID!]
)
A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.
UpdateCheckRunInputAutogenerated input type of UpdateCheckRun.
Input fields forUpdateCheckRunInput
Name Description
actions
([CheckRunAction!]
)
Possible further actions the integrator can perform, which a user may trigger.
checkRunId
(ID!
)
The node of the check.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
completedAt
(DateTime
)
The time that the check run finished.
conclusion
(CheckConclusionState
)
The final conclusion of the check.
detailsUrl
(URI
)
The URL of the integrator's site that has the full details of the check.
externalId
(String
)
A reference for the run on the integrator's system.
name
(String
)
The name of the check.
output
(CheckRunOutput
)
Descriptive details about the run.
repositoryId
(ID!
)
The node ID of the repository.
startedAt
(DateTime
)
The time that the check run began.
status
(RequestableCheckStatusState
)
The current status.
UpdateCheckSuitePreferencesInputAutogenerated input type of UpdateCheckSuitePreferences.
Input fields forUpdateCheckSuitePreferencesInput
Name Description
autoTriggerPreferences
([CheckSuiteAutoTriggerPreference!]!
)
The check suite preferences to modify.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryId
(ID!
)
The Node ID of the repository.
Autogenerated input type of UpdateDiscussionComment.
Input fields forUpdateDiscussionCommentInput
Name Description
body
(String!
)
The new contents of the comment body.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
commentId
(ID!
)
The Node ID of the discussion comment to update.
UpdateDiscussionInputAutogenerated input type of UpdateDiscussion.
Input fields forUpdateDiscussionInput
Name Description
body
(String
)
The new contents of the discussion body.
categoryId
(ID
)
The Node ID of a discussion category within the same repository to change this discussion to.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
discussionId
(ID!
)
The Node ID of the discussion to update.
title
(String
)
The new discussion title.
UpdateEnterpriseAdministratorRoleInputAutogenerated input type of UpdateEnterpriseAdministratorRole.
Input fields forUpdateEnterpriseAdministratorRoleInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the Enterprise which the admin belongs to.
login
(String!
)
The login of a administrator whose role is being changed.
role
(EnterpriseAdministratorRole!
)
The new role for the Enterprise administrator.
UpdateEnterpriseDeployKeySettingInputAutogenerated input type of UpdateEnterpriseDeployKeySetting.
Input fields forUpdateEnterpriseDeployKeySettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the deploy key setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the deploy key setting on the enterprise.
UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInputAutogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.
Input fields forUpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can change repository visibility setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the members can change repository visibility setting on the enterprise.
UpdateEnterpriseMembersCanCreateRepositoriesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.
Input fields forUpdateEnterpriseMembersCanCreateRepositoriesSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can create repositories setting.
membersCanCreateInternalRepositories
(Boolean
)
Allow members to create internal repositories. Defaults to current value.
membersCanCreatePrivateRepositories
(Boolean
)
Allow members to create private repositories. Defaults to current value.
membersCanCreatePublicRepositories
(Boolean
)
Allow members to create public repositories. Defaults to current value.
membersCanCreateRepositoriesPolicyEnabled
(Boolean
)
When false, allow member organizations to set their own repository creation member privileges.
settingValue
(EnterpriseMembersCanCreateRepositoriesSettingValue
)
Value for the members can create repositories setting on the enterprise. This or the granular public/private/internal allowed fields (but not both) must be provided.
UpdateEnterpriseMembersCanDeleteIssuesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.
Input fields forUpdateEnterpriseMembersCanDeleteIssuesSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can delete issues setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the members can delete issues setting on the enterprise.
UpdateEnterpriseMembersCanDeleteRepositoriesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.
Input fields forUpdateEnterpriseMembersCanDeleteRepositoriesSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can delete repositories setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the members can delete repositories setting on the enterprise.
Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.
Input fields forUpdateEnterpriseMembersCanInviteCollaboratorsSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can invite collaborators setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the members can invite collaborators setting on the enterprise.
UpdateEnterpriseMembersCanMakePurchasesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.
Input fields forUpdateEnterpriseMembersCanMakePurchasesSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can make purchases setting.
settingValue
(EnterpriseMembersCanMakePurchasesSettingValue!
)
The value for the members can make purchases setting on the enterprise.
UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.
Input fields forUpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can update protected branches setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the members can update protected branches setting on the enterprise.
UpdateEnterpriseMembersCanViewDependencyInsightsSettingInputAutogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.
Input fields forUpdateEnterpriseMembersCanViewDependencyInsightsSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the members can view dependency insights setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the members can view dependency insights setting on the enterprise.
UpdateEnterpriseOrganizationProjectsSettingInputAutogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.
Input fields forUpdateEnterpriseOrganizationProjectsSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the organization projects setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the organization projects setting on the enterprise.
UpdateEnterpriseOwnerOrganizationRoleInputAutogenerated input type of UpdateEnterpriseOwnerOrganizationRole.
Input fields forUpdateEnterpriseOwnerOrganizationRoleInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the Enterprise which the owner belongs to.
organizationId
(ID!
)
The ID of the organization for membership change.
organizationRole
(RoleInOrganization!
)
The role to assume in the organization.
UpdateEnterpriseProfileInputAutogenerated input type of UpdateEnterpriseProfile.
Input fields forUpdateEnterpriseProfileInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String
)
The description of the enterprise.
enterpriseId
(ID!
)
The Enterprise ID to update.
location
(String
)
The location of the enterprise.
name
(String
)
The name of the enterprise.
websiteUrl
(String
)
The URL of the enterprise's website.
UpdateEnterpriseRepositoryProjectsSettingInputAutogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.
Input fields forUpdateEnterpriseRepositoryProjectsSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the repository projects setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the repository projects setting on the enterprise.
UpdateEnterpriseTeamDiscussionsSettingInputAutogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.
Input fields forUpdateEnterpriseTeamDiscussionsSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the team discussions setting.
settingValue
(EnterpriseEnabledDisabledSettingValue!
)
The value for the team discussions setting on the enterprise.
UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInputAutogenerated input type of UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting.
Input fields forUpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the two-factor authentication disallowed methods setting.
settingValue
(EnterpriseDisallowedMethodsSettingValue!
)
The value for the two-factor authentication disallowed methods setting on the enterprise.
UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInputAutogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.
Input fields forUpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enterpriseId
(ID!
)
The ID of the enterprise on which to set the two factor authentication required setting.
settingValue
(EnterpriseEnabledSettingValue!
)
The value for the two factor authentication required setting on the enterprise.
UpdateEnvironmentInputAutogenerated input type of UpdateEnvironment.
Input fields forUpdateEnvironmentInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
environmentId
(ID!
)
The node ID of the environment.
preventSelfReview
(Boolean
)
Whether deployments to this environment can be approved by the user who created the deployment.
reviewers
([ID!]
)
The ids of users or teams that can approve deployments to this environment.
waitTimer
(Int
)
The wait timer in minutes.
UpdateIpAllowListEnabledSettingInputAutogenerated input type of UpdateIpAllowListEnabledSetting.
Input fields forUpdateIpAllowListEnabledSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
ownerId
(ID!
)
The ID of the owner on which to set the IP allow list enabled setting.
settingValue
(IpAllowListEnabledSettingValue!
)
The value for the IP allow list enabled setting.
UpdateIpAllowListEntryInputAutogenerated input type of UpdateIpAllowListEntry.
Input fields forUpdateIpAllowListEntryInput
Name Description
allowListValue
(String!
)
An IP address or range of addresses in CIDR notation.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
ipAllowListEntryId
(ID!
)
The ID of the IP allow list entry to update.
isActive
(Boolean!
)
Whether the IP allow list entry is active when an IP allow list is enabled.
name
(String
)
An optional name for the IP allow list entry.
Autogenerated input type of UpdateIssueComment.
Input fields forUpdateIssueCommentInput
Name Description
body
(String!
)
The updated text of the comment.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the IssueComment to modify.
UpdateIssueInputAutogenerated input type of UpdateIssue.
Input fields forUpdateIssueInput
Name Description
assigneeIds
([ID!]
)
An array of Node IDs of users for this issue.
body
(String
)
The body for the issue description.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the Issue to modify.
issueTypeId
(ID
)
The ID of the Issue Type for this issue.
labelIds
([ID!]
)
An array of Node IDs of labels for this issue.
milestoneId
(ID
)
The Node ID of the milestone for this issue.
projectIds
([ID!]
)
An array of Node IDs for projects associated with this issue.
state
(IssueState
)
The desired issue state.
title
(String
)
The title for the issue.
UpdateIssueIssueTypeInputAutogenerated input type of UpdateIssueIssueType.
Input fields forUpdateIssueIssueTypeInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
issueId
(ID!
)
The ID of the issue to update.
issueTypeId
(ID
)
The ID of the issue type to update on the issue.
UpdateIssueTypeInputAutogenerated input type of UpdateIssueType.
Input fields forUpdateIssueTypeInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
color
(IssueTypeColor
)
Color for the issue type.
description
(String
)
The description of the issue type.
isEnabled
(Boolean
)
Whether or not the issue type is enabled for the organization.
issueTypeId
(ID!
)
The ID of the issue type to update.
name
(String
)
The name of the issue type.
UpdateLabelInputAutogenerated input type of UpdateLabel.
Input fields forUpdateLabelInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
color
(String
)
A 6 character hex code, without the leading #, identifying the updated color of the label.
description
(String
)
A brief description of the label, such as its purpose.
id
(ID!
)
The Node ID of the label to be updated.
name
(String
)
The updated name of the label.
UpdateNotificationRestrictionSettingInputAutogenerated input type of UpdateNotificationRestrictionSetting.
Input fields forUpdateNotificationRestrictionSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
ownerId
(ID!
)
The ID of the owner on which to set the restrict notifications setting.
settingValue
(NotificationRestrictionSettingValue!
)
The value for the restrict notifications setting.
UpdateOrganizationAllowPrivateRepositoryForkingSettingInputAutogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting.
Input fields forUpdateOrganizationAllowPrivateRepositoryForkingSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
forkingEnabled
(Boolean!
)
Enable forking of private repositories in the organization?.
organizationId
(ID!
)
The ID of the organization on which to set the allow private repository forking setting.
UpdateOrganizationWebCommitSignoffSettingInputAutogenerated input type of UpdateOrganizationWebCommitSignoffSetting.
Input fields forUpdateOrganizationWebCommitSignoffSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
organizationId
(ID!
)
The ID of the organization on which to set the web commit signoff setting.
webCommitSignoffRequired
(Boolean!
)
Enable signoff on web-based commits for repositories in the organization?.
UpdateParametersInputOnly allow users with bypass permission to update matching refs.
Input fields forUpdateParametersInput
Name Description
updateAllowsFetchAndMerge
(Boolean!
)
Branch can pull changes from its upstream repository.
Autogenerated input type of UpdatePatreonSponsorability.
Input fields forUpdatePatreonSponsorabilityInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
enablePatreonSponsorships
(Boolean!
)
Whether Patreon tiers should be shown on the GitHub Sponsors profile page, allowing potential sponsors to make their payment through Patreon instead of GitHub.
sponsorableLogin
(String
)
The username of the organization with the GitHub Sponsors profile, if any. Defaults to the GitHub Sponsors profile for the authenticated user if omitted.
UpdateProjectCardInputAutogenerated input type of UpdateProjectCard.
Input fields forUpdateProjectCardInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
isArchived
(Boolean
)
Whether or not the ProjectCard should be archived.
note
(String
)
The note of ProjectCard.
projectCardId
(ID!
)
The ProjectCard ID to update.
UpdateProjectColumnInputAutogenerated input type of UpdateProjectColumn.
Input fields forUpdateProjectColumnInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String!
)
The name of project column.
projectColumnId
(ID!
)
The ProjectColumn ID to update.
UpdateProjectInputAutogenerated input type of UpdateProject.
Input fields forUpdateProjectInput
Name Description
body
(String
)
The description of project.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
name
(String
)
The name of project.
projectId
(ID!
)
The Project ID to update.
public
(Boolean
)
Whether the project is public or not.
state
(ProjectState
)
Whether the project is open or closed.
UpdateProjectV2CollaboratorsInputAutogenerated input type of UpdateProjectV2Collaborators.
Input fields forUpdateProjectV2CollaboratorsInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
collaborators
([ProjectV2Collaborator!]!
)
The collaborators to update.
projectId
(ID!
)
The ID of the project to update the collaborators for.
UpdateProjectV2DraftIssueInputAutogenerated input type of UpdateProjectV2DraftIssue.
Input fields forUpdateProjectV2DraftIssueInput
Name Description
assigneeIds
([ID!]
)
The IDs of the assignees of the draft issue.
body
(String
)
The body of the draft issue.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
draftIssueId
(ID!
)
The ID of the draft issue to update.
title
(String
)
The title of the draft issue.
UpdateProjectV2FieldInputAutogenerated input type of UpdateProjectV2Field.
Input fields forUpdateProjectV2FieldInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
fieldId
(ID!
)
The ID of the field to update.
iterationConfiguration
(ProjectV2IterationFieldConfigurationInput
)
Configuration for an iteration field.
name
(String
)
The name to update.
singleSelectOptions
([ProjectV2SingleSelectFieldOptionInput!]
)
Options for a field of type SINGLE_SELECT. If empty, no changes will be made to the options. If values are present, they will overwrite the existing options for the field.
UpdateProjectV2InputAutogenerated input type of UpdateProjectV2.
Input fields forUpdateProjectV2Input
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
closed
(Boolean
)
Set the project to closed or open.
projectId
(ID!
)
The ID of the Project to update.
public
(Boolean
)
Set the project to public or private.
readme
(String
)
Set the readme description of the project.
shortDescription
(String
)
Set the short description of the project.
title
(String
)
Set the title of the project.
UpdateProjectV2ItemFieldValueInputAutogenerated input type of UpdateProjectV2ItemFieldValue.
Input fields forUpdateProjectV2ItemFieldValueInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
fieldId
(ID!
)
The ID of the field to be updated.
itemId
(ID!
)
The ID of the item to be updated.
projectId
(ID!
)
The ID of the Project.
value
(ProjectV2FieldValue!
)
The value which will be set on the field.
UpdateProjectV2ItemPositionInputAutogenerated input type of UpdateProjectV2ItemPosition.
Input fields forUpdateProjectV2ItemPositionInput
Name Description
afterId
(ID
)
The ID of the item to position this item after. If omitted or set to null the item will be moved to top.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
itemId
(ID!
)
The ID of the item to be moved.
projectId
(ID!
)
The ID of the Project.
UpdateProjectV2StatusUpdateInputAutogenerated input type of UpdateProjectV2StatusUpdate.
Input fields forUpdateProjectV2StatusUpdateInput
Name Description
body
(String
)
The body of the status update.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
startDate
(Date
)
The start date of the status update.
status
(ProjectV2StatusUpdateStatus
)
The status of the status update.
statusUpdateId
(ID!
)
The ID of the status update to be updated.
targetDate
(Date
)
The target date of the status update.
UpdatePullRequestBranchInputAutogenerated input type of UpdatePullRequestBranch.
Input fields forUpdatePullRequestBranchInput
Name Description
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'.
UpdatePullRequestInputAutogenerated input type of UpdatePullRequest.
Input fields forUpdatePullRequestInput
Name Description
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.
Autogenerated input type of UpdatePullRequestReviewComment.
Input fields forUpdatePullRequestReviewCommentInput
Name Description
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.
UpdatePullRequestReviewInputAutogenerated input type of UpdatePullRequestReview.
Input fields forUpdatePullRequestReviewInput
Name Description
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.
UpdateRefInputAutogenerated input type of UpdateRef.
Input fields forUpdateRefInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
force
(Boolean
)
Permit updates of branch Refs that are not fast-forwards?.
oid
(GitObjectID!
)
The GitObjectID that the Ref shall be updated to target.
refId
(ID!
)
The Node ID of the Ref to be updated.
UpdateRefsInputAutogenerated input type of UpdateRefs.
Input fields forUpdateRefsInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
refUpdates
([RefUpdate!]!
)
A list of ref updates.
repositoryId
(ID!
)
The Node ID of the repository.
UpdateRepositoryInputAutogenerated input type of UpdateRepository.
Input fields forUpdateRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String
)
A new description for the repository. Pass an empty string to erase the existing description.
hasDiscussionsEnabled
(Boolean
)
Indicates if the repository should have the discussions feature enabled.
hasIssuesEnabled
(Boolean
)
Indicates if the repository should have the issues feature enabled.
hasProjectsEnabled
(Boolean
)
Indicates if the repository should have the project boards feature enabled.
hasSponsorshipsEnabled
(Boolean
)
Indicates if the repository displays a Sponsor button for financial contributions.
hasWikiEnabled
(Boolean
)
Indicates if the repository should have the wiki feature enabled.
homepageUrl
(URI
)
The URL for a web page about this repository. Pass an empty string to erase the existing URL.
name
(String
)
The new name of the repository.
repositoryId
(ID!
)
The ID of the repository to update.
template
(Boolean
)
Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure.
UpdateRepositoryWebCommitSignoffSettingInputAutogenerated input type of UpdateRepositoryWebCommitSignoffSetting.
Input fields forUpdateRepositoryWebCommitSignoffSettingInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryId
(ID!
)
The ID of the repository to update.
webCommitSignoffRequired
(Boolean!
)
Indicates if the repository should require signoff on web-based commits.
Autogenerated input type of UpdateSponsorshipPreferences.
Input fields forUpdateSponsorshipPreferencesInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
privacyLevel
(SponsorshipPrivacy
)
Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used.
receiveEmails
(Boolean
)
Whether the sponsor should receive email updates from the sponsorable.
sponsorId
(ID
)
The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given.
sponsorLogin
(String
)
The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given.
sponsorableId
(ID
)
The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
sponsorableLogin
(String
)
The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.
UpdateSubscriptionInputAutogenerated input type of UpdateSubscription.
Input fields forUpdateSubscriptionInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
state
(SubscriptionState!
)
The new state of the subscription.
subscribableId
(ID!
)
The Node ID of the subscribable object to modify.
Autogenerated input type of UpdateTeamDiscussionComment.
Input fields forUpdateTeamDiscussionCommentInput
Name Description
body
(String!
)
The updated text of the comment.
bodyVersion
(String
)
The current version of the body content.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the comment to modify.
UpdateTeamDiscussionInputAutogenerated input type of UpdateTeamDiscussion.
Input fields forUpdateTeamDiscussionInput
Name Description
body
(String
)
The updated text of the discussion.
bodyVersion
(String
)
The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The Node ID of the discussion to modify.
pinned
(Boolean
)
If provided, sets the pinned state of the updated discussion.
title
(String
)
The updated title of the discussion.
UpdateTeamReviewAssignmentInputAutogenerated input type of UpdateTeamReviewAssignment.
Input fields forUpdateTeamReviewAssignmentInput
Name Description
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.
UpdateTeamsRepositoryInputAutogenerated input type of UpdateTeamsRepository.
Input fields forUpdateTeamsRepositoryInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
permission
(RepositoryPermission!
)
Permission that should be granted to the teams.
repositoryId
(ID!
)
Repository ID being granted access to.
teamIds
([ID!]!
)
A list of teams being granted access. Limit: 10.
UpdateTopicsInputAutogenerated input type of UpdateTopics.
Input fields forUpdateTopicsInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
repositoryId
(ID!
)
The Node ID of the repository.
topicNames
([String!]!
)
An array of topic names.
UpdateUserListInputAutogenerated input type of UpdateUserList.
Input fields forUpdateUserListInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
description
(String
)
A description of the list.
isPrivate
(Boolean
)
Whether or not the list is private.
listId
(ID!
)
The ID of the list to update.
name
(String
)
The name of the list.
UpdateUserListsForItemInputAutogenerated input type of UpdateUserListsForItem.
Input fields forUpdateUserListsForItemInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
itemId
(ID!
)
The item to add to the list.
listIds
([ID!]!
)
The lists to which this item should belong.
suggestedListIds
([ID!]
)
The suggested lists to create and add this item to.
UserStatusOrderOrdering options for user status connections.
Input fields forUserStatusOrder
VerifiableDomainOrder
Ordering options for verifiable domain connections.
Input fields forVerifiableDomainOrder
VerifyVerifiableDomainInput
Autogenerated input type of VerifyVerifiableDomain.
Input fields forVerifyVerifiableDomainInput
Name Description
clientMutationId
(String
)
A unique identifier for the client performing the mutation.
id
(ID!
)
The ID of the verifiable domain to verify.
WorkflowFileReferenceInputA workflow that must run for this rule to pass.
Input fields forWorkflowFileReferenceInput
Name Description
path
(String!
)
The path to the workflow file.
ref
(String
)
The ref (branch or tag) of the workflow file to use.
repositoryId
(Int!
)
The ID of the repository where the workflow is defined.
sha
(String
)
The commit SHA of the workflow file to use.
WorkflowRunOrderWays in which lists of workflow runs can be ordered upon return.
Input fields forWorkflowRunOrder
WorkflowsParametersInput
Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
Input fields forWorkflowsParametersInput
Name Description
doNotEnforceOnCreate
(Boolean
)
Allow repositories and branches to be created if a check would otherwise prohibit it.
workflows
([WorkflowFileReferenceInput!]!
)
Workflows that must pass for this rule to pass.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4