Input objects
#
AcceptEnterpriseAdministratorInvitationInputAutogenerated input type of AcceptEnterpriseAdministratorInvitation
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
invitationIdID! | The id of the invitation being accepted |
#
AcceptTopicSuggestionInputAutogenerated input type of AcceptTopicSuggestion
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
nameString! | The name of the suggested topic. |
repositoryIdID! | The Node ID of the repository. |
#
AddAssigneesToAssignableInputAutogenerated input type of AddAssigneesToAssignable
Arguments
Name | Description |
---|---|
assignableIdID! | The id of the assignable object to add assignees to. |
assigneeIds[ID!]! | The id of users to add as assignees. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
#
AddCommentInputAutogenerated input type of AddComment
Arguments
Name | Description |
---|---|
bodyString! | The contents of the comment. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
subjectIdID! | The Node ID of the subject to modify. |
#
AddEnterpriseSupportEntitlementInputAutogenerated input type of AddEnterpriseSupportEntitlement
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the Enterprise which the admin belongs to. |
loginString! | The login of a member who will receive the support entitlement. |
#
AddLabelsToLabelableInputAutogenerated input type of AddLabelsToLabelable
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
labelIds[ID!]! | The ids of the labels to add. |
labelableIdID! | The id of the labelable object to add labels to. |
#
AddProjectCardInputAutogenerated input type of AddProjectCard
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
contentIdID | The content of the card. Must be a member of the ProjectCardItem union |
noteString | The note on the card. |
projectColumnIdID! | The Node ID of the ProjectColumn. |
#
AddProjectColumnInputAutogenerated input type of AddProjectColumn
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
nameString! | The name of the column. |
projectIdID! | The Node ID of the project. |
#
AddPullRequestReviewCommentInputAutogenerated input type of AddPullRequestReviewComment
Arguments
Name | Description |
---|---|
bodyString! | The text of the comment. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
commitOIDGitObjectID | The SHA of the commit to comment on. |
inReplyToID | The comment id to reply to. |
pathString | The relative path of the file to comment on. |
positionInt | The line index in the diff to comment on. |
pullRequestIdID | The node ID of the pull request reviewing |
pullRequestReviewIdID | The Node ID of the review to modify. |
#
AddPullRequestReviewInputAutogenerated input type of AddPullRequestReview
Arguments
Name | Description |
---|---|
bodyString | The contents of the review body comment. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
comments[DraftPullRequestReviewComment] | The review line comments. |
commitOIDGitObjectID | The commit OID the review pertains to. |
eventPullRequestReviewEvent | The event to perform on the pull request review. |
pullRequestIdID! | The Node ID of the pull request to modify. |
threads[DraftPullRequestReviewThread] | The review line comment threads. |
#
AddPullRequestReviewThreadInputAutogenerated input type of AddPullRequestReviewThread
Arguments
Name | Description |
---|---|
bodyString! | Body of the thread's first comment. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
lineInt! | The line of the blob to which the thread refers. The end of the line range for multi-line comments. |
pathString! | Path to the file being commented on. |
pullRequestIdID | The node ID of the pull request reviewing |
pullRequestReviewIdID | The Node ID of the review to modify. |
sideDiffSide | 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. |
startLineInt | The first line of the range to which the comment refers. |
startSideDiffSide | The side of the diff on which the start line resides. |
#
AddReactionInputAutogenerated input type of AddReaction
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
contentReactionContent! | The name of the emoji to react with. |
subjectIdID! | The Node ID of the subject to modify. |
#
AddStarInputAutogenerated input type of AddStar
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
starrableIdID! | The Starrable ID to star. |
#
AddVerifiableDomainInputAutogenerated input type of AddVerifiableDomain
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
domainURI! | The URL of the domain |
ownerIdID! | The ID of the owner to add the domain to |
#
ApproveVerifiableDomainInputAutogenerated input type of ApproveVerifiableDomain
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the verifiable domain to approve. |
#
ArchiveRepositoryInputAutogenerated input type of ArchiveRepository
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
repositoryIdID! | The ID of the repository to mark as archived. |
#
AuditLogOrderOrdering options for Audit Log connections.
Arguments
Name | Description |
---|---|
directionOrderDirection | The ordering direction. |
fieldAuditLogOrderField | The field to order Audit Logs by. |
#
CancelEnterpriseAdminInvitationInputAutogenerated input type of CancelEnterpriseAdminInvitation
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
invitationIdID! | The Node ID of the pending enterprise administrator invitation. |
#
ChangeUserStatusInputAutogenerated input type of ChangeUserStatus
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
emojiString | The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., :grinning:. |
expiresAtDateTime | If set, the user status will not be shown after this date. |
limitedAvailabilityBoolean | Whether this status should indicate you are not fully available on GitHub, e.g., you are away. |
messageString | A short description of your current status. |
organizationIdID | 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.
Arguments
Name | Description |
---|---|
annotationLevelCheckAnnotationLevel! | Represents an annotation's information level |
locationCheckAnnotationRange! | The location of the annotation |
messageString! | A short description of the feedback for these lines of code. |
pathString! | The path of the file to add an annotation to. |
rawDetailsString | Details about this annotation. |
titleString | The title that represents the annotation. |
#
CheckAnnotationRangeInformation from a check run analysis to specific lines of code.
Arguments
Name | Description |
---|---|
endColumnInt | The ending column of the range. |
endLineInt! | The ending line of the range. |
startColumnInt | The starting column of the range. |
startLineInt! | The starting line of the range. |
#
CheckRunActionPossible further actions the integrator can perform.
Arguments
Name | Description |
---|---|
descriptionString! | A short explanation of what this action would do. |
identifierString! | A reference for the action on the integrator's system. |
labelString! | The text to be displayed on a button in the web UI. |
#
CheckRunFilterThe filters that are available when fetching check runs.
Arguments
Name | Description |
---|---|
appIdInt | Filters the check runs created by this application ID. |
checkNameString | Filters the check runs by this name. |
checkTypeCheckRunType | Filters the check runs by this type. |
statusCheckStatusState | Filters the check runs by this status. |
#
CheckRunOutputDescriptive details about the check run.
Arguments
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. |
summaryString! | The summary of the check run (supports Commonmark). |
textString | The details of the check run (supports Commonmark). |
titleString! | A title to provide for this check run. |
#
CheckRunOutputImageImages attached to the check run output displayed in the GitHub pull request UI.
Arguments
Name | Description |
---|---|
altString! | The alternative text for the image. |
captionString | A short image description. |
imageUrlURI! | The full URL of the image. |
#
CheckSuiteAutoTriggerPreferenceThe auto-trigger preferences that are available for check suites.
Arguments
Name | Description |
---|---|
appIdID! | The node ID of the application that owns the check suite. |
settingBoolean! | Set to |
#
CheckSuiteFilterThe filters that are available when fetching check suites.
Arguments
Name | Description |
---|---|
appIdInt | Filters the check suites created by this application ID. |
checkNameString | Filters the check suites by this name. |
#
ClearLabelsFromLabelableInputAutogenerated input type of ClearLabelsFromLabelable
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
labelableIdID! | The id of the labelable object to clear the labels from. |
#
CloneProjectInputAutogenerated input type of CloneProject
Arguments
Name | Description |
---|---|
bodyString | The description of the project. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
includeWorkflowsBoolean! | Whether or not to clone the source project's workflows. |
nameString! | The name of the project. |
publicBoolean | The visibility of the project, defaults to false (private). |
sourceIdID! | The source project to clone. |
targetOwnerIdID! | The owner ID to create the project under. |
#
CloneTemplateRepositoryInputAutogenerated input type of CloneTemplateRepository
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
descriptionString | A short description of the new repository. |
includeAllBranchesBoolean | Whether to copy all branches from the template to the new repository. Defaults to copying only the default branch of the template. |
nameString! | The name of the new repository. |
ownerIdID! | The ID of the owner for the new repository. |
repositoryIdID! | The Node ID of the template repository. |
visibilityRepositoryVisibility! | Indicates the repository's visibility level. |
#
CloseIssueInputAutogenerated input type of CloseIssue
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
issueIdID! | ID of the issue to be closed. |
#
ClosePullRequestInputAutogenerated input type of ClosePullRequest
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestIdID! | ID of the pull request to be closed. |
#
CommitAuthorSpecifies an author for filtering Git commits.
Arguments
Name | Description |
---|---|
emails[String!] | Email addresses to filter by. Commits authored by any of the specified email addresses will be returned. |
idID | 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. |
#
CommitContributionOrderOrdering options for commit contribution connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldCommitContributionOrderField! | The field by which to order commit contributions. |
#
ContributionOrderOrdering options for contribution connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
#
ConvertProjectCardNoteToIssueInputAutogenerated input type of ConvertProjectCardNoteToIssue
Arguments
Name | Description |
---|---|
bodyString | The body of the newly created issue. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
projectCardIdID! | The ProjectCard ID to convert. |
repositoryIdID! | The ID of the repository to create the issue in. |
titleString | The title of the newly created issue. Defaults to the card's note text. |
#
CreateBranchProtectionRuleInputAutogenerated input type of CreateBranchProtectionRule
Arguments
Name | Description |
---|---|
allowsDeletionsBoolean | Can this branch be deleted. |
allowsForcePushesBoolean | Are force pushes allowed on this branch. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
dismissesStaleReviewsBoolean | Will new commits pushed to matching branches dismiss pull request review approvals. |
isAdminEnforcedBoolean | Can admins overwrite branch protection. |
patternString! | 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. |
repositoryIdID! | The global relay id of the repository in which a new branch protection rule should be created in. |
requiredApprovingReviewCountInt | Number of approving reviews required to update matching branches. |
requiredStatusCheckContexts[String!] | List of required status check contexts that must pass for commits to be accepted to matching branches. |
requiresApprovingReviewsBoolean | Are approving reviews required to update matching branches. |
requiresCodeOwnerReviewsBoolean | Are reviews from code owners required to update matching branches. |
requiresCommitSignaturesBoolean | Are commits required to be signed. |
requiresLinearHistoryBoolean | Are merge commits prohibited from being pushed to this branch. |
requiresStatusChecksBoolean | Are status checks required to update matching branches. |
requiresStrictStatusChecksBoolean | Are branches required to be up to date before merging. |
restrictsPushesBoolean | Is pushing to matching branches restricted. |
restrictsReviewDismissalsBoolean | Is dismissal of pull request reviews restricted. |
reviewDismissalActorIds[ID!] | A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches. |
#
CreateCheckRunInputAutogenerated input type of CreateCheckRun
Arguments
Name | Description |
---|---|
actions[CheckRunAction!] | Possible further actions the integrator can perform, which a user may trigger. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
completedAtDateTime | The time that the check run finished. |
conclusionCheckConclusionState | The final conclusion of the check. |
detailsUrlURI | The URL of the integrator's site that has the full details of the check. |
externalIdString | A reference for the run on the integrator's system. |
headShaGitObjectID! | The SHA of the head commit. |
nameString! | The name of the check. |
outputCheckRunOutput | Descriptive details about the run. |
repositoryIdID! | The node ID of the repository. |
startedAtDateTime | The time that the check run began. |
statusRequestableCheckStatusState | The current status. |
#
CreateCheckSuiteInputAutogenerated input type of CreateCheckSuite
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
headShaGitObjectID! | The SHA of the head commit. |
repositoryIdID! | The Node ID of the repository. |
#
CreateContentAttachmentInputAutogenerated input type of CreateContentAttachment
Arguments
Name | Description |
---|---|
bodyString! | The body of the content attachment, which may contain markdown. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
contentReferenceIdID! | The node ID of the content_reference. |
titleString! | The title of the content attachment. |
#
CreateDeploymentInputAutogenerated input type of CreateDeployment
Arguments
Name | Description |
---|---|
autoMergeBoolean | Attempt to automatically merge the default branch into the requested ref, defaults to true. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
descriptionString | Short description of the deployment. |
environmentString | Name for the target deployment environment. |
payloadString | JSON payload with extra information about the deployment. |
refIdID! | The node ID of the ref to be deployed. |
repositoryIdID! | 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. |
taskString | Specifies a task to execute. |
#
CreateDeploymentStatusInputAutogenerated input type of CreateDeploymentStatus
Arguments
Name | Description |
---|---|
autoInactiveBoolean | 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. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
deploymentIdID! | The node ID of the deployment. |
descriptionString | A short description of the status. Maximum length of 140 characters. |
environmentString | If provided, updates the environment of the deploy. Otherwise, does not modify the environment. |
environmentUrlString | Sets the URL for accessing your environment. |
logUrlString | 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. |
stateDeploymentStatusState! | The state of the deployment. |
#
CreateEnterpriseOrganizationInputAutogenerated input type of CreateEnterpriseOrganization
Arguments
Name | Description |
---|---|
adminLogins[String!]! | The logins for the administrators of the new organization. |
billingEmailString! | The email used for sending billing receipts. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise owning the new organization. |
loginString! | The login of the new organization. |
profileNameString! | The profile name of the new organization. |
#
CreateIpAllowListEntryInputAutogenerated input type of CreateIpAllowListEntry
Arguments
Name | Description |
---|---|
allowListValueString! | An IP address or range of addresses in CIDR notation. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
isActiveBoolean! | Whether the IP allow list entry is active when an IP allow list is enabled. |
nameString | An optional name for the IP allow list entry. |
ownerIdID! | The ID of the owner for which to create the new IP allow list entry. |
#
CreateIssueInputAutogenerated input type of CreateIssue
Arguments
Name | Description |
---|---|
assigneeIds[ID!] | The Node ID for the user assignee for this issue. |
bodyString | The body for the issue description. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
issueTemplateString | The name of an issue template in the repository, assigns labels and assignees from the template to the issue |
labelIds[ID!] | An array of Node IDs of labels for this issue. |
milestoneIdID | The Node ID of the milestone for this issue. |
projectIds[ID!] | An array of Node IDs for projects associated with this issue. |
repositoryIdID! | The Node ID of the repository. |
titleString! | The title for the issue. |
#
CreateLabelInputAutogenerated input type of CreateLabel
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
colorString! | A 6 character hex code, without the leading #, identifying the color of the label. |
descriptionString | A brief description of the label, such as its purpose. |
nameString! | The name of the label. |
repositoryIdID! | The Node ID of the repository. |
#
CreateProjectInputAutogenerated input type of CreateProject
Arguments
Name | Description |
---|---|
bodyString | The description of project. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
nameString! | The name of project. |
ownerIdID! | The owner ID to create the project under. |
repositoryIds[ID!] | A list of repository IDs to create as linked repositories for the project |
templateProjectTemplate | The name of the GitHub-provided template. |
#
CreatePullRequestInputAutogenerated input type of CreatePullRequest
Arguments
Name | Description |
---|---|
baseRefNameString! | 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. |
bodyString | The contents of the pull request. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
draftBoolean | Indicates whether this pull request should be a draft. |
headRefNameString! | The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace |
maintainerCanModifyBoolean | Indicates whether maintainers can modify the pull request. |
repositoryIdID! | The Node ID of the repository. |
titleString! | The title of the pull request. |
#
CreateRefInputAutogenerated input type of CreateRef
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
nameString! | The fully qualified name of the new Ref (ie: |
oidGitObjectID! | The GitObjectID that the new Ref shall target. Must point to a commit. |
repositoryIdID! | The Node ID of the Repository to create the Ref in. |
#
CreateRepositoryInputAutogenerated input type of CreateRepository
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
descriptionString | A short description of the new repository. |
hasIssuesEnabledBoolean | Indicates if the repository should have the issues feature enabled. |
hasWikiEnabledBoolean | Indicates if the repository should have the wiki feature enabled. |
homepageUrlURI | The URL for a web page about this repository. |
nameString! | The name of the new repository. |
ownerIdID | The ID of the owner for the new repository. |
teamIdID | When an organization is specified as the owner, this ID identifies the team that should be granted access to the new repository. |
templateBoolean | 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. |
visibilityRepositoryVisibility! | Indicates the repository's visibility level. |
#
CreateTeamDiscussionCommentInputAutogenerated input type of CreateTeamDiscussionComment
Arguments
Name | Description |
---|---|
bodyString! | The content of the comment. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
discussionIdID! | The ID of the discussion to which the comment belongs. |
#
CreateTeamDiscussionInputAutogenerated input type of CreateTeamDiscussion
Arguments
Name | Description |
---|---|
bodyString! | The content of the discussion. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
privateBoolean | If true, restricts the visibility of this discussion to team members and organization admins. If false or not specified, allows any organization member to view this discussion. |
teamIdID! | The ID of the team to which the discussion belongs. |
titleString! | The title of the discussion. |
#
DeclineTopicSuggestionInputAutogenerated input type of DeclineTopicSuggestion
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
nameString! | The name of the suggested topic. |
reasonTopicSuggestionDeclineReason! | The reason why the suggested topic is declined. |
repositoryIdID! | The Node ID of the repository. |
#
DeleteBranchProtectionRuleInputAutogenerated input type of DeleteBranchProtectionRule
Arguments
Name | Description |
---|---|
branchProtectionRuleIdID! | The global relay id of the branch protection rule to be deleted. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
#
DeleteDeploymentInputAutogenerated input type of DeleteDeployment
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The Node ID of the deployment to be deleted. |
#
DeleteIpAllowListEntryInputAutogenerated input type of DeleteIpAllowListEntry
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
ipAllowListEntryIdID! | The ID of the IP allow list entry to delete. |
#
DeleteIssueCommentInputAutogenerated input type of DeleteIssueComment
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the comment to delete. |
#
DeleteIssueInputAutogenerated input type of DeleteIssue
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
issueIdID! | The ID of the issue to delete. |
#
DeleteLabelInputAutogenerated input type of DeleteLabel
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The Node ID of the label to be deleted. |
#
DeletePackageVersionInputAutogenerated input type of DeletePackageVersion
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
packageVersionIdID! | The ID of the package version to be deleted. |
#
DeleteProjectCardInputAutogenerated input type of DeleteProjectCard
Arguments
Name | Description |
---|---|
cardIdID! | The id of the card to delete. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
#
DeleteProjectColumnInputAutogenerated input type of DeleteProjectColumn
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
columnIdID! | The id of the column to delete. |
#
DeleteProjectInputAutogenerated input type of DeleteProject
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
projectIdID! | The Project ID to update. |
#
DeletePullRequestReviewCommentInputAutogenerated input type of DeletePullRequestReviewComment
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the comment to delete. |
#
DeletePullRequestReviewInputAutogenerated input type of DeletePullRequestReview
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestReviewIdID! | The Node ID of the pull request review to delete. |
#
DeleteRefInputAutogenerated input type of DeleteRef
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
refIdID! | The Node ID of the Ref to be deleted. |
#
DeleteTeamDiscussionCommentInputAutogenerated input type of DeleteTeamDiscussionComment
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the comment to delete. |
#
DeleteTeamDiscussionInputAutogenerated input type of DeleteTeamDiscussion
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The discussion ID to delete. |
#
DeleteVerifiableDomainInputAutogenerated input type of DeleteVerifiableDomain
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the verifiable domain to delete. |
#
DeploymentOrderOrdering options for deployment connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldDeploymentOrderField! | The field to order deployments by. |
#
DisablePullRequestAutoMergeInputAutogenerated input type of DisablePullRequestAutoMerge
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestIdID! | ID of the pull request to disable auto merge on. |
#
DismissPullRequestReviewInputAutogenerated input type of DismissPullRequestReview
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
messageString! | The contents of the pull request review dismissal message. |
pullRequestReviewIdID! | The Node ID of the pull request review to modify. |
#
DraftPullRequestReviewCommentSpecifies a review comment to be left with a Pull Request Review.
Arguments
Name | Description |
---|---|
bodyString! | Body of the comment to leave. |
pathString! | Path to the file being commented on. |
positionInt! | Position in the file to leave a comment on. |
#
DraftPullRequestReviewThreadSpecifies a review comment thread to be left with a Pull Request Review.
Arguments
Name | Description |
---|---|
bodyString! | Body of the comment to leave. |
lineInt! | The line of the blob to which the thread refers. The end of the line range for multi-line comments. |
pathString! | Path to the file being commented on. |
sideDiffSide | 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. |
startLineInt | The first line of the range to which the comment refers. |
startSideDiffSide | The side of the diff on which the start line resides. |
#
EnablePullRequestAutoMergeInputAutogenerated input type of EnablePullRequestAutoMerge
Arguments
Name | Description |
---|---|
authorEmailString | The email address to associate with this merge. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
commitBodyString | Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used. |
commitHeadlineString | Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used. |
mergeMethodPullRequestMergeMethod | The merge method to use. If omitted, defaults to 'MERGE' |
pullRequestIdID! | ID of the pull request to enable auto-merge on. |
#
EnterpriseAdministratorInvitationOrderOrdering options for enterprise administrator invitation connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldEnterpriseAdministratorInvitationOrderField! | The field to order enterprise administrator invitations by. |
#
EnterpriseMemberOrderOrdering options for enterprise member connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldEnterpriseMemberOrderField! | The field to order enterprise members by. |
#
EnterpriseServerInstallationOrderOrdering options for Enterprise Server installation connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldEnterpriseServerInstallationOrderField! | The field to order Enterprise Server installations by. |
#
EnterpriseServerUserAccountEmailOrderOrdering options for Enterprise Server user account email connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldEnterpriseServerUserAccountEmailOrderField! | The field to order emails by. |
#
EnterpriseServerUserAccountOrderOrdering options for Enterprise Server user account connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldEnterpriseServerUserAccountOrderField! | The field to order user accounts by. |
#
EnterpriseServerUserAccountsUploadOrderOrdering options for Enterprise Server user accounts upload connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldEnterpriseServerUserAccountsUploadOrderField! | The field to order user accounts uploads by. |
#
FollowUserInputAutogenerated input type of FollowUser
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
userIdID! | ID of the user to follow. |
#
GistOrderOrdering options for gist connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldGistOrderField! | The field to order repositories by. |
#
ImportProjectInputAutogenerated input type of ImportProject
Arguments
Name | Description |
---|---|
bodyString | The description of Project. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
columnImports[ProjectColumnImport!]! | A list of columns containing issues and pull requests. |
nameString! | The name of Project. |
ownerNameString! | The name of the Organization or User to create the Project under. |
publicBoolean | Whether the Project is public or not. |
#
InviteEnterpriseAdminInputAutogenerated input type of InviteEnterpriseAdmin
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
emailString | The email of the person to invite as an administrator. |
enterpriseIdID! | The ID of the enterprise to which you want to invite an administrator. |
inviteeString | The login of a user to invite as an administrator. |
roleEnterpriseAdministratorRole | The role of the administrator. |
#
IpAllowListEntryOrderOrdering options for IP allow list entry connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldIpAllowListEntryOrderField! | The field to order IP allow list entries by. |
#
IssueCommentOrderWays in which lists of issue comments can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order issue comments by the specified field. |
fieldIssueCommentOrderField! | The field in which to order issue comments by. |
#
IssueFiltersWays in which to filter lists of issues.
Arguments
Name | Description |
---|---|
assigneeString | List issues assigned to given name. Pass in |
createdByString | List issues created by given name. |
labels[String!] | List issues where the list of label names exist on the issue. |
mentionedString | List issues where the given name is mentioned in the issue. |
milestoneString | 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 |
sinceDateTime | List issues that have been updated at or after the given date. |
states[IssueState!] | List issues filtered by the list of states given. |
viewerSubscribedBoolean | List issues subscribed to by viewer. |
#
IssueOrderWays in which lists of issues can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order issues by the specified field. |
fieldIssueOrderField! | The field in which to order issues by. |
#
LabelOrderWays in which lists of labels can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order labels by the specified field. |
fieldLabelOrderField! | The field in which to order labels by. |
#
LanguageOrderOrdering options for language connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldLanguageOrderField! | The field to order languages by. |
#
LinkRepositoryToProjectInputAutogenerated input type of LinkRepositoryToProject
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
projectIdID! | The ID of the Project to link to a Repository |
repositoryIdID! | The ID of the Repository to link to a Project. |
#
LockLockableInputAutogenerated input type of LockLockable
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
lockReasonLockReason | A reason for why the item will be locked. |
lockableIdID! | ID of the item to be locked. |
#
MarkFileAsViewedInputAutogenerated input type of MarkFileAsViewed
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pathString! | The path of the file to mark as viewed |
pullRequestIdID! | The Node ID of the pull request. |
#
MarkPullRequestReadyForReviewInputAutogenerated input type of MarkPullRequestReadyForReview
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestIdID! | ID of the pull request to be marked as ready for review. |
#
MergeBranchInputAutogenerated input type of MergeBranch
Arguments
Name | Description |
---|---|
authorEmailString | The email address to associate with this commit. |
baseString! | The name of the base branch that the provided head will be merged into. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
commitMessageString | Message to use for the merge commit. If omitted, a default will be used. |
headString! | The head to merge into the base branch. This can be a branch name or a commit GitObjectID. |
repositoryIdID! | The Node ID of the Repository containing the base branch that will be modified. |
#
MergePullRequestInputAutogenerated input type of MergePullRequest
Arguments
Name | Description |
---|---|
authorEmailString | The email address to associate with this merge. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
commitBodyString | Commit body to use for the merge commit; if omitted, a default message will be used |
commitHeadlineString | Commit headline to use for the merge commit; if omitted, a default message will be used. |
expectedHeadOidGitObjectID | OID that the pull request head ref must match to allow merge; if omitted, no check is performed. |
mergeMethodPullRequestMergeMethod | The merge method to use. If omitted, defaults to 'MERGE' |
pullRequestIdID! | ID of the pull request to be merged. |
#
MilestoneOrderOrdering options for milestone connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldMilestoneOrderField! | The field to order milestones by. |
#
MinimizeCommentInputAutogenerated input type of MinimizeComment
Arguments
Name | Description |
---|---|
classifierReportedContentClassifiers! | The classification of comment |
clientMutationIdString | A unique identifier for the client performing the mutation. |
subjectIdID! | The Node ID of the subject to modify. |
#
MoveProjectCardInputAutogenerated input type of MoveProjectCard
Arguments
Name | Description |
---|---|
afterCardIdID | Place the new card after the card with this id. Pass null to place it at the top. |
cardIdID! | The id of the card to move. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
columnIdID! | The id of the column to move it into. |
#
MoveProjectColumnInputAutogenerated input type of MoveProjectColumn
Arguments
Name | Description |
---|---|
afterColumnIdID | Place the new column after the column with this id. Pass null to place it at the front. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
columnIdID! | The id of the column to move. |
#
OrganizationOrderOrdering options for organization connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldOrganizationOrderField! | The field to order organizations by. |
#
PackageFileOrderWays in which lists of package files can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection | The direction in which to order package files by the specified field. |
fieldPackageFileOrderField | The field in which to order package files by. |
#
PackageOrderWays in which lists of packages can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection | The direction in which to order packages by the specified field. |
fieldPackageOrderField | The field in which to order packages by. |
#
PackageVersionOrderWays in which lists of package versions can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection | The direction in which to order package versions by the specified field. |
fieldPackageVersionOrderField | The field in which to order package versions by. |
#
PinIssueInputAutogenerated input type of PinIssue
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
issueIdID! | The ID of the issue to be pinned |
#
ProjectCardImportAn issue or PR and its owning repository to be used in a project card.
Arguments
Name | Description |
---|---|
numberInt! | The issue or pull request number. |
repositoryString! | Repository name with owner (owner/repository). |
#
ProjectColumnImportA project column and a list of its issues and PRs.
Arguments
Name | Description |
---|---|
columnNameString! | The name of the column. |
issues[ProjectCardImport!] | A list of issues and pull requests in the column. |
positionInt! | The position of the column, starting from 0. |
#
ProjectOrderWays in which lists of projects can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order projects by the specified field. |
fieldProjectOrderField! | The field in which to order projects by. |
#
PullRequestOrderWays in which lists of issues can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order pull requests by the specified field. |
fieldPullRequestOrderField! | The field in which to order pull requests by. |
#
ReactionOrderWays in which lists of reactions can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order reactions by the specified field. |
fieldReactionOrderField! | The field in which to order reactions by. |
#
RefOrderWays in which lists of git refs can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order refs by the specified field. |
fieldRefOrderField! | The field in which to order refs by. |
#
RefUpdateA ref update
Arguments
Name | Description |
---|---|
afterOidGitObjectID! | The value this ref should be updated to. |
beforeOidGitObjectID | The value this ref needs to point to before the update. |
forceBoolean | Force a non fast-forward update. |
nameGitRefname! | The fully qualified name of the ref to be update. For example |
#
RegenerateEnterpriseIdentityProviderRecoveryCodesInputAutogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set an identity provider. |
#
RegenerateVerifiableDomainTokenInputAutogenerated input type of RegenerateVerifiableDomainToken
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the verifiable domain to regenerate the verification token of. |
#
ReleaseOrderWays in which lists of releases can be ordered upon return.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order releases by the specified field. |
fieldReleaseOrderField! | The field in which to order releases by. |
#
RemoveAssigneesFromAssignableInputAutogenerated input type of RemoveAssigneesFromAssignable
Arguments
Name | Description |
---|---|
assignableIdID! | The id of the assignable object to remove assignees from. |
assigneeIds[ID!]! | The id of users to remove as assignees. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
#
RemoveEnterpriseAdminInputAutogenerated input type of RemoveEnterpriseAdmin
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The Enterprise ID from which to remove the administrator. |
loginString! | The login of the user to remove as an administrator. |
#
RemoveEnterpriseIdentityProviderInputAutogenerated input type of RemoveEnterpriseIdentityProvider
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise from which to remove the identity provider. |
#
RemoveEnterpriseOrganizationInputAutogenerated input type of RemoveEnterpriseOrganization
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise from which the organization should be removed. |
organizationIdID! | The ID of the organization to remove from the enterprise. |
#
RemoveEnterpriseSupportEntitlementInputAutogenerated input type of RemoveEnterpriseSupportEntitlement
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the Enterprise which the admin belongs to. |
loginString! | The login of a member who will lose the support entitlement. |
#
RemoveLabelsFromLabelableInputAutogenerated input type of RemoveLabelsFromLabelable
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
labelIds[ID!]! | The ids of labels to remove. |
labelableIdID! | The id of the Labelable to remove labels from. |
#
RemoveOutsideCollaboratorInputAutogenerated input type of RemoveOutsideCollaborator
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
organizationIdID! | The ID of the organization to remove the outside collaborator from. |
userIdID! | The ID of the outside collaborator to remove. |
#
RemoveReactionInputAutogenerated input type of RemoveReaction
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
contentReactionContent! | The name of the emoji reaction to remove. |
subjectIdID! | The Node ID of the subject to modify. |
#
RemoveStarInputAutogenerated input type of RemoveStar
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
starrableIdID! | The Starrable ID to unstar. |
#
ReopenIssueInputAutogenerated input type of ReopenIssue
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
issueIdID! | ID of the issue to be opened. |
#
ReopenPullRequestInputAutogenerated input type of ReopenPullRequest
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestIdID! | ID of the pull request to be reopened. |
#
RepositoryInvitationOrderOrdering options for repository invitation connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldRepositoryInvitationOrderField! | The field to order repository invitations by. |
#
RepositoryOrderOrdering options for repository connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldRepositoryOrderField! | The field to order repositories by. |
#
RequestReviewsInputAutogenerated input type of RequestReviews
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestIdID! | The Node ID of the pull request to modify. |
teamIds[ID!] | The Node IDs of the team to request. |
unionBoolean | Add users to the set rather than replace. |
userIds[ID!] | The Node IDs of the user to request. |
#
RerequestCheckSuiteInputAutogenerated input type of RerequestCheckSuite
Arguments
Name | Description |
---|---|
checkSuiteIdID! | The Node ID of the check suite. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
repositoryIdID! | The Node ID of the repository. |
#
ResolveReviewThreadInputAutogenerated input type of ResolveReviewThread
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
threadIdID! | The ID of the thread to resolve |
#
SavedReplyOrderOrdering options for saved reply connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldSavedReplyOrderField! | The field to order saved replies by. |
#
SecurityAdvisoryIdentifierFilterAn advisory identifier to filter results on.
Arguments
Name | Description |
---|---|
typeSecurityAdvisoryIdentifierType! | The identifier type. |
valueString! | The identifier string. Supports exact or partial matching. |
#
SecurityAdvisoryOrderOrdering options for security advisory connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldSecurityAdvisoryOrderField! | The field to order security advisories by. |
#
SecurityVulnerabilityOrderOrdering options for security vulnerability connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldSecurityVulnerabilityOrderField! | The field to order security vulnerabilities by. |
#
SetEnterpriseIdentityProviderInputAutogenerated input type of SetEnterpriseIdentityProvider
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
digestMethodSamlDigestAlgorithm! | The digest algorithm used to sign SAML requests for the identity provider. |
enterpriseIdID! | The ID of the enterprise on which to set an identity provider. |
idpCertificateString! | The x509 certificate used by the identity provider to sign assertions and responses. |
issuerString | The Issuer Entity ID for the SAML identity provider |
signatureMethodSamlSignatureAlgorithm! | The signature algorithm used to sign SAML requests for the identity provider. |
ssoUrlURI! | The URL endpoint for the identity provider's SAML SSO. |
#
SetOrganizationInteractionLimitInputAutogenerated input type of SetOrganizationInteractionLimit
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
expiryRepositoryInteractionLimitExpiry | When this limit should expire. |
limitRepositoryInteractionLimit! | The limit to set. |
organizationIdID! | The ID of the organization to set a limit for. |
#
SetRepositoryInteractionLimitInputAutogenerated input type of SetRepositoryInteractionLimit
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
expiryRepositoryInteractionLimitExpiry | When this limit should expire. |
limitRepositoryInteractionLimit! | The limit to set. |
repositoryIdID! | The ID of the repository to set a limit for. |
#
SetUserInteractionLimitInputAutogenerated input type of SetUserInteractionLimit
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
expiryRepositoryInteractionLimitExpiry | When this limit should expire. |
limitRepositoryInteractionLimit! | The limit to set. |
userIdID! | The ID of the user to set a limit for. |
#
SponsorableOrderOrdering options for connections to get sponsorable entities for GitHub Sponsors.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldSponsorableOrderField! | The field to order sponsorable entities by. |
#
SponsorshipOrderOrdering options for sponsorship connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldSponsorshipOrderField! | The field to order sponsorship by. |
#
SponsorsTierOrderOrdering options for Sponsors tiers connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldSponsorsTierOrderField! | The field to order tiers by. |
#
StarOrderWays in which star connections can be ordered.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order nodes. |
fieldStarOrderField! | The field in which to order nodes by. |
#
SubmitPullRequestReviewInputAutogenerated input type of SubmitPullRequestReview
Arguments
Name | Description |
---|---|
bodyString | The text field to set on the Pull Request Review. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
eventPullRequestReviewEvent! | The event to send to the Pull Request Review. |
pullRequestIdID | The Pull Request ID to submit any pending reviews. |
pullRequestReviewIdID | The Pull Request Review ID to submit. |
#
TeamDiscussionCommentOrderWays in which team discussion comment connections can be ordered.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order nodes. |
fieldTeamDiscussionCommentOrderField! | The field by which to order nodes. |
#
TeamDiscussionOrderWays in which team discussion connections can be ordered.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order nodes. |
fieldTeamDiscussionOrderField! | The field by which to order nodes. |
#
TeamMemberOrderOrdering options for team member connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldTeamMemberOrderField! | The field to order team members by. |
#
TeamOrderWays in which team connections can be ordered.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The direction in which to order nodes. |
fieldTeamOrderField! | The field in which to order nodes by. |
#
TeamRepositoryOrderOrdering options for team repository connections
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldTeamRepositoryOrderField! | The field to order repositories by. |
#
TransferIssueInputAutogenerated input type of TransferIssue
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
issueIdID! | The Node ID of the issue to be transferred |
repositoryIdID! | The Node ID of the repository the issue should be transferred to |
#
UnarchiveRepositoryInputAutogenerated input type of UnarchiveRepository
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
repositoryIdID! | The ID of the repository to unarchive. |
#
UnfollowUserInputAutogenerated input type of UnfollowUser
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
userIdID! | ID of the user to unfollow. |
#
UnlinkRepositoryFromProjectInputAutogenerated input type of UnlinkRepositoryFromProject
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
projectIdID! | The ID of the Project linked to the Repository. |
repositoryIdID! | The ID of the Repository linked to the Project. |
#
UnlockLockableInputAutogenerated input type of UnlockLockable
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
lockableIdID! | ID of the item to be unlocked. |
#
UnmarkFileAsViewedInputAutogenerated input type of UnmarkFileAsViewed
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
pathString! | The path of the file to mark as unviewed |
pullRequestIdID! | The Node ID of the pull request. |
#
UnmarkIssueAsDuplicateInputAutogenerated input type of UnmarkIssueAsDuplicate
Arguments
Name | Description |
---|---|
canonicalIdID! | ID of the issue or pull request currently considered canonical/authoritative/original. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
duplicateIdID! | ID of the issue or pull request currently marked as a duplicate. |
#
UnminimizeCommentInputAutogenerated input type of UnminimizeComment
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
subjectIdID! | The Node ID of the subject to modify. |
#
UnpinIssueInputAutogenerated input type of UnpinIssue
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
issueIdID! | The ID of the issue to be unpinned |
#
UnresolveReviewThreadInputAutogenerated input type of UnresolveReviewThread
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
threadIdID! | The ID of the thread to unresolve |
#
UpdateBranchProtectionRuleInputAutogenerated input type of UpdateBranchProtectionRule
Arguments
Name | Description |
---|---|
allowsDeletionsBoolean | Can this branch be deleted. |
allowsForcePushesBoolean | Are force pushes allowed on this branch. |
branchProtectionRuleIdID! | The global relay id of the branch protection rule to be updated. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
dismissesStaleReviewsBoolean | Will new commits pushed to matching branches dismiss pull request review approvals. |
isAdminEnforcedBoolean | Can admins overwrite branch protection. |
patternString | 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. |
requiredApprovingReviewCountInt | Number of approving reviews required to update matching branches. |
requiredStatusCheckContexts[String!] | List of required status check contexts that must pass for commits to be accepted to matching branches. |
requiresApprovingReviewsBoolean | Are approving reviews required to update matching branches. |
requiresCodeOwnerReviewsBoolean | Are reviews from code owners required to update matching branches. |
requiresCommitSignaturesBoolean | Are commits required to be signed. |
requiresLinearHistoryBoolean | Are merge commits prohibited from being pushed to this branch. |
requiresStatusChecksBoolean | Are status checks required to update matching branches. |
requiresStrictStatusChecksBoolean | Are branches required to be up to date before merging. |
restrictsPushesBoolean | Is pushing to matching branches restricted. |
restrictsReviewDismissalsBoolean | Is dismissal of pull request reviews restricted. |
reviewDismissalActorIds[ID!] | A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches. |
#
UpdateCheckRunInputAutogenerated input type of UpdateCheckRun
Arguments
Name | Description |
---|---|
actions[CheckRunAction!] | Possible further actions the integrator can perform, which a user may trigger. |
checkRunIdID! | The node of the check. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
completedAtDateTime | The time that the check run finished. |
conclusionCheckConclusionState | The final conclusion of the check. |
detailsUrlURI | The URL of the integrator's site that has the full details of the check. |
externalIdString | A reference for the run on the integrator's system. |
nameString | The name of the check. |
outputCheckRunOutput | Descriptive details about the run. |
repositoryIdID! | The node ID of the repository. |
startedAtDateTime | The time that the check run began. |
statusRequestableCheckStatusState | The current status. |
#
UpdateCheckSuitePreferencesInputAutogenerated input type of UpdateCheckSuitePreferences
Arguments
Name | Description |
---|---|
autoTriggerPreferences[CheckSuiteAutoTriggerPreference!]! | The check suite preferences to modify. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
repositoryIdID! | The Node ID of the repository. |
#
UpdateEnterpriseAdministratorRoleInputAutogenerated input type of UpdateEnterpriseAdministratorRole
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the Enterprise which the admin belongs to. |
loginString! | The login of a administrator whose role is being changed. |
roleEnterpriseAdministratorRole! | The new role for the Enterprise administrator. |
#
UpdateEnterpriseAllowPrivateRepositoryForkingSettingInputAutogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the allow private repository forking setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the allow private repository forking setting on the enterprise. |
#
UpdateEnterpriseDefaultRepositoryPermissionSettingInputAutogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the default repository permission setting. |
settingValueEnterpriseDefaultRepositoryPermissionSettingValue! | The value for the default repository permission setting on the enterprise. |
#
UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInputAutogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can change repository visibility setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the members can change repository visibility setting on the enterprise. |
#
UpdateEnterpriseMembersCanCreateRepositoriesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can create repositories setting. |
membersCanCreateInternalRepositoriesBoolean | Allow members to create internal repositories. Defaults to current value. |
membersCanCreatePrivateRepositoriesBoolean | Allow members to create private repositories. Defaults to current value. |
membersCanCreatePublicRepositoriesBoolean | Allow members to create public repositories. Defaults to current value. |
membersCanCreateRepositoriesPolicyEnabledBoolean | When false, allow member organizations to set their own repository creation member privileges. |
settingValueEnterpriseMembersCanCreateRepositoriesSettingValue | 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
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can delete issues setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the members can delete issues setting on the enterprise. |
#
UpdateEnterpriseMembersCanDeleteRepositoriesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can delete repositories setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the members can delete repositories setting on the enterprise. |
#
UpdateEnterpriseMembersCanInviteCollaboratorsSettingInputAutogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can invite collaborators setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the members can invite collaborators setting on the enterprise. |
#
UpdateEnterpriseMembersCanMakePurchasesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can make purchases setting. |
settingValueEnterpriseMembersCanMakePurchasesSettingValue! | The value for the members can make purchases setting on the enterprise. |
#
UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInputAutogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can update protected branches setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the members can update protected branches setting on the enterprise. |
#
UpdateEnterpriseMembersCanViewDependencyInsightsSettingInputAutogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the members can view dependency insights setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the members can view dependency insights setting on the enterprise. |
#
UpdateEnterpriseOrganizationProjectsSettingInputAutogenerated input type of UpdateEnterpriseOrganizationProjectsSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the organization projects setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the organization projects setting on the enterprise. |
#
UpdateEnterpriseProfileInputAutogenerated input type of UpdateEnterpriseProfile
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
descriptionString | The description of the enterprise. |
enterpriseIdID! | The Enterprise ID to update. |
locationString | The location of the enterprise. |
nameString | The name of the enterprise. |
websiteUrlString | The URL of the enterprise's website. |
#
UpdateEnterpriseRepositoryProjectsSettingInputAutogenerated input type of UpdateEnterpriseRepositoryProjectsSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the repository projects setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the repository projects setting on the enterprise. |
#
UpdateEnterpriseTeamDiscussionsSettingInputAutogenerated input type of UpdateEnterpriseTeamDiscussionsSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the team discussions setting. |
settingValueEnterpriseEnabledDisabledSettingValue! | The value for the team discussions setting on the enterprise. |
#
UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInputAutogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
enterpriseIdID! | The ID of the enterprise on which to set the two factor authentication required setting. |
settingValueEnterpriseEnabledSettingValue! | The value for the two factor authentication required setting on the enterprise. |
#
UpdateIpAllowListEnabledSettingInputAutogenerated input type of UpdateIpAllowListEnabledSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
ownerIdID! | The ID of the owner on which to set the IP allow list enabled setting. |
settingValueIpAllowListEnabledSettingValue! | The value for the IP allow list enabled setting. |
#
UpdateIpAllowListEntryInputAutogenerated input type of UpdateIpAllowListEntry
Arguments
Name | Description |
---|---|
allowListValueString! | An IP address or range of addresses in CIDR notation. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
ipAllowListEntryIdID! | The ID of the IP allow list entry to update. |
isActiveBoolean! | Whether the IP allow list entry is active when an IP allow list is enabled. |
nameString | An optional name for the IP allow list entry. |
#
UpdateIssueCommentInputAutogenerated input type of UpdateIssueComment
Arguments
Name | Description |
---|---|
bodyString! | The updated text of the comment. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the IssueComment to modify. |
#
UpdateIssueInputAutogenerated input type of UpdateIssue
Arguments
Name | Description |
---|---|
assigneeIds[ID!] | An array of Node IDs of users for this issue. |
bodyString | The body for the issue description. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the Issue to modify. |
labelIds[ID!] | An array of Node IDs of labels for this issue. |
milestoneIdID | The Node ID of the milestone for this issue. |
projectIds[ID!] | An array of Node IDs for projects associated with this issue. |
stateIssueState | The desired issue state. |
titleString | The title for the issue. |
#
UpdateLabelInputAutogenerated input type of UpdateLabel
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
colorString | A 6 character hex code, without the leading #, identifying the updated color of the label. |
descriptionString | A brief description of the label, such as its purpose. |
idID! | The Node ID of the label to be updated. |
nameString | The updated name of the label. |
#
UpdateNotificationRestrictionSettingInputAutogenerated input type of UpdateNotificationRestrictionSetting
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
ownerIdID! | The ID of the owner on which to set the restrict notifications setting. |
settingValueNotificationRestrictionSettingValue! | The value for the restrict notifications setting. |
#
UpdateProjectCardInputAutogenerated input type of UpdateProjectCard
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
isArchivedBoolean | Whether or not the ProjectCard should be archived |
noteString | The note of ProjectCard. |
projectCardIdID! | The ProjectCard ID to update. |
#
UpdateProjectColumnInputAutogenerated input type of UpdateProjectColumn
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
nameString! | The name of project column. |
projectColumnIdID! | The ProjectColumn ID to update. |
#
UpdateProjectInputAutogenerated input type of UpdateProject
Arguments
Name | Description |
---|---|
bodyString | The description of project. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
nameString | The name of project. |
projectIdID! | The Project ID to update. |
publicBoolean | Whether the project is public or not. |
stateProjectState | Whether the project is open or closed. |
#
UpdatePullRequestInputAutogenerated input type of UpdatePullRequest
Arguments
Name | Description |
---|---|
assigneeIds[ID!] | An array of Node IDs of users for this pull request. |
baseRefNameString | The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. |
bodyString | The contents of the pull request. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
labelIds[ID!] | An array of Node IDs of labels for this pull request. |
maintainerCanModifyBoolean | Indicates whether maintainers can modify the pull request. |
milestoneIdID | The Node ID of the milestone for this pull request. |
projectIds[ID!] | An array of Node IDs for projects associated with this pull request. |
pullRequestIdID! | The Node ID of the pull request. |
statePullRequestUpdateState | The target state of the pull request. |
titleString | The title of the pull request. |
#
UpdatePullRequestReviewCommentInputAutogenerated input type of UpdatePullRequestReviewComment
Arguments
Name | Description |
---|---|
bodyString! | The text of the comment. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestReviewCommentIdID! | The Node ID of the comment to modify. |
#
UpdatePullRequestReviewInputAutogenerated input type of UpdatePullRequestReview
Arguments
Name | Description |
---|---|
bodyString! | The contents of the pull request review body. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
pullRequestReviewIdID! | The Node ID of the pull request review to modify. |
#
UpdateRefInputAutogenerated input type of UpdateRef
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
forceBoolean | Permit updates of branch Refs that are not fast-forwards? |
oidGitObjectID! | The GitObjectID that the Ref shall be updated to target. |
refIdID! | The Node ID of the Ref to be updated. |
#
UpdateRefsInputAutogenerated input type of UpdateRefs
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
refUpdates[RefUpdate!]! | A list of ref updates. |
repositoryIdID! | The Node ID of the repository. |
#
UpdateRepositoryInputAutogenerated input type of UpdateRepository
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
descriptionString | A new description for the repository. Pass an empty string to erase the existing description. |
hasIssuesEnabledBoolean | Indicates if the repository should have the issues feature enabled. |
hasProjectsEnabledBoolean | Indicates if the repository should have the project boards feature enabled. |
hasWikiEnabledBoolean | Indicates if the repository should have the wiki feature enabled. |
homepageUrlURI | The URL for a web page about this repository. Pass an empty string to erase the existing URL. |
nameString | The new name of the repository. |
repositoryIdID! | The ID of the repository to update. |
templateBoolean | 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. |
#
UpdateSubscriptionInputAutogenerated input type of UpdateSubscription
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
stateSubscriptionState! | The new state of the subscription. |
subscribableIdID! | The Node ID of the subscribable object to modify. |
#
UpdateTeamDiscussionCommentInputAutogenerated input type of UpdateTeamDiscussionComment
Arguments
Name | Description |
---|---|
bodyString! | The updated text of the comment. |
bodyVersionString | The current version of the body content. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the comment to modify. |
#
UpdateTeamDiscussionInputAutogenerated input type of UpdateTeamDiscussion
Arguments
Name | Description |
---|---|
bodyString | The updated text of the discussion. |
bodyVersionString | 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. |
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The Node ID of the discussion to modify. |
pinnedBoolean | If provided, sets the pinned state of the updated discussion. |
titleString | The updated title of the discussion. |
#
UpdateTeamReviewAssignmentInputAutogenerated input type of UpdateTeamReviewAssignment
Arguments
Name | Description |
---|---|
algorithmTeamReviewAssignmentAlgorithm | The algorithm to use for review assignment |
clientMutationIdString | A unique identifier for the client performing the mutation. |
enabledBoolean! | Turn on or off review assignment |
excludedTeamMemberIds[ID!] | An array of team member IDs to exclude |
idID! | The Node ID of the team to update review assignments of |
notifyTeamBoolean | Notify the entire team of the PR if it is delegated |
teamMemberCountInt | The number of team members to assign |
#
UpdateTopicsInputAutogenerated input type of UpdateTopics
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
repositoryIdID! | The Node ID of the repository. |
topicNames[String!]! | An array of topic names. |
#
UserStatusOrderOrdering options for user status connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldUserStatusOrderField! | The field to order user statuses by. |
#
VerifiableDomainOrderOrdering options for verifiable domain connections.
Arguments
Name | Description |
---|---|
directionOrderDirection! | The ordering direction. |
fieldVerifiableDomainOrderField! | The field to order verifiable domains by. |
#
VerifyVerifiableDomainInputAutogenerated input type of VerifyVerifiableDomain
Arguments
Name | Description |
---|---|
clientMutationIdString | A unique identifier for the client performing the mutation. |
idID! | The ID of the verifiable domain to verify. |