Skip to main content

Input objects

AcceptEnterpriseAdministratorInvitationInput#

Autogenerated input type of AcceptEnterpriseAdministratorInvitation

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

invitationId
ID!

The id of the invitation being accepted

AcceptTopicSuggestionInput#

Autogenerated input type of AcceptTopicSuggestion

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

name
String!

The name of the suggested topic.

repositoryId
ID!

The Node ID of the repository.

AddAssigneesToAssignableInput#

Autogenerated input type of AddAssigneesToAssignable

Arguments

NameDescription
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.

AddCommentInput#

Autogenerated input type of AddComment

Arguments

NameDescription
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.

AddEnterpriseSupportEntitlementInput#

Autogenerated input type of AddEnterpriseSupportEntitlement

Arguments

NameDescription
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.

AddLabelsToLabelableInput#

Autogenerated input type of AddLabelsToLabelable

Arguments

NameDescription
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.

AddProjectCardInput#

Autogenerated input type of AddProjectCard

Arguments

NameDescription
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.

AddProjectColumnInput#

Autogenerated input type of AddProjectColumn

Arguments

NameDescription
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.

AddPullRequestReviewCommentInput#

Autogenerated input type of AddPullRequestReviewComment

Arguments

NameDescription
body
String!

The text of the comment.

clientMutationId
String

A unique identifier for the client performing the mutation.

commitOID
GitObjectID

The SHA of the commit to comment on.

inReplyTo
ID

The comment id to reply to.

path
String

The relative path of the file to comment on.

position
Int

The line index in the diff to comment on.

pullRequestId
ID

The node ID of the pull request reviewing

pullRequestReviewId
ID

The Node ID of the review to modify.

AddPullRequestReviewInput#

Autogenerated input type of AddPullRequestReview

Arguments

NameDescription
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.

commitOID
GitObjectID

The commit OID the review pertains to.

event
PullRequestReviewEvent

The event to perform on the pull request review.

pullRequestId
ID!

The Node ID of the pull request to modify.

threads
[DraftPullRequestReviewThread]

The review line comment threads.

AddPullRequestReviewThreadInput#

Autogenerated input type of AddPullRequestReviewThread

Arguments

NameDescription
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. 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.

AddReactionInput#

Autogenerated input type of AddReaction

Arguments

NameDescription
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.

AddStarInput#

Autogenerated input type of AddStar

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

starrableId
ID!

The Starrable ID to star.

AddVerifiableDomainInput#

Autogenerated input type of AddVerifiableDomain

Arguments

NameDescription
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

ApproveVerifiableDomainInput#

Autogenerated input type of ApproveVerifiableDomain

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The ID of the verifiable domain to approve.

ArchiveRepositoryInput#

Autogenerated input type of ArchiveRepository

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repositoryId
ID!

The ID of the repository to mark as archived.

AuditLogOrder#

Ordering options for Audit Log connections.

Arguments

NameDescription
direction
OrderDirection

The ordering direction.

field
AuditLogOrderField

The field to order Audit Logs by.

CancelEnterpriseAdminInvitationInput#

Autogenerated input type of CancelEnterpriseAdminInvitation

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

invitationId
ID!

The Node ID of the pending enterprise administrator invitation.

ChangeUserStatusInput#

Autogenerated input type of ChangeUserStatus

Arguments

NameDescription
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., :grinning:.

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.

CheckAnnotationData#

Information from a check run analysis to specific lines of code.

Arguments

NameDescription
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.

CheckAnnotationRange#

Information from a check run analysis to specific lines of code.

Arguments

NameDescription
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.

CheckRunAction#

Possible further actions the integrator can perform.

Arguments

NameDescription
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.

CheckRunFilter#

The filters that are available when fetching check runs.

Arguments

NameDescription
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.

status
CheckStatusState

Filters the check runs by this status.

CheckRunOutput#

Descriptive details about the check run.

Arguments

NameDescription
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.

CheckRunOutputImage#

Images attached to the check run output displayed in the GitHub pull request UI.

Arguments

NameDescription
alt
String!

The alternative text for the image.

caption
String

A short image description.

imageUrl
URI!

The full URL of the image.

CheckSuiteAutoTriggerPreference#

The auto-trigger preferences that are available for check suites.

Arguments

NameDescription
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.

CheckSuiteFilter#

The filters that are available when fetching check suites.

Arguments

NameDescription
appId
Int

Filters the check suites created by this application ID.

checkName
String

Filters the check suites by this name.

ClearLabelsFromLabelableInput#

Autogenerated input type of ClearLabelsFromLabelable

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

labelableId
ID!

The id of the labelable object to clear the labels from.

CloneProjectInput#

Autogenerated input type of CloneProject

Arguments

NameDescription
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.

CloneTemplateRepositoryInput#

Autogenerated input type of CloneTemplateRepository

Arguments

NameDescription
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.

CloseIssueInput#

Autogenerated input type of CloseIssue

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issueId
ID!

ID of the issue to be closed.

ClosePullRequestInput#

Autogenerated input type of ClosePullRequest

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestId
ID!

ID of the pull request to be closed.

CommitAuthor#

Specifies an author for filtering Git commits.

Arguments

NameDescription
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.

CommitContributionOrder#

Ordering options for commit contribution connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
CommitContributionOrderField!

The field by which to order commit contributions.

ContributionOrder#

Ordering options for contribution connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

ConvertProjectCardNoteToIssueInput#

Autogenerated input type of ConvertProjectCardNoteToIssue

Arguments

NameDescription
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.

CreateBranchProtectionRuleInput#

Autogenerated input type of CreateBranchProtectionRule

Arguments

NameDescription
allowsDeletions
Boolean

Can this branch be deleted.

allowsForcePushes
Boolean

Are force pushes allowed on this branch.

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 overwrite branch protection.

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.

requiredApprovingReviewCount
Int

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.

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.

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 or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

CreateCheckRunInput#

Autogenerated input type of CreateCheckRun

Arguments

NameDescription
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.

CreateCheckSuiteInput#

Autogenerated input type of CreateCheckSuite

Arguments

NameDescription
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.

CreateContentAttachmentInput#

Autogenerated input type of CreateContentAttachment

Arguments

NameDescription
body
String!

The body of the content attachment, which may contain markdown.

clientMutationId
String

A unique identifier for the client performing the mutation.

contentReferenceId
ID!

The node ID of the content_reference.

title
String!

The title of the content attachment.

CreateDeploymentInput#

Autogenerated input type of CreateDeployment

Arguments

NameDescription
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.

CreateDeploymentStatusInput#

Autogenerated input type of CreateDeploymentStatus

Arguments

NameDescription
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.

CreateEnterpriseOrganizationInput#

Autogenerated input type of CreateEnterpriseOrganization

Arguments

NameDescription
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.

CreateIpAllowListEntryInput#

Autogenerated input type of CreateIpAllowListEntry

Arguments

NameDescription
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.

CreateIssueInput#

Autogenerated input type of CreateIssue

Arguments

NameDescription
assigneeIds
[ID!]

The Node ID for the user assignee 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

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.

repositoryId
ID!

The Node ID of the repository.

title
String!

The title for the issue.

CreateLabelInput#

Autogenerated input type of CreateLabel

Arguments

NameDescription
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.

CreateProjectInput#

Autogenerated input type of CreateProject

Arguments

NameDescription
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.

CreatePullRequestInput#

Autogenerated input type of CreatePullRequest

Arguments

NameDescription
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.

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.

CreateRefInput#

Autogenerated input type of CreateRef

Arguments

NameDescription
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.

CreateRepositoryInput#

Autogenerated input type of CreateRepository

Arguments

NameDescription
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.

CreateTeamDiscussionCommentInput#

Autogenerated input type of CreateTeamDiscussionComment

Arguments

NameDescription
body
String!

The content of the comment.

clientMutationId
String

A unique identifier for the client performing the mutation.

discussionId
ID!

The ID of the discussion to which the comment belongs.

CreateTeamDiscussionInput#

Autogenerated input type of CreateTeamDiscussion

Arguments

NameDescription
body
String!

The content of the discussion.

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 admins. If false or not specified, allows any organization member to view this discussion.

teamId
ID!

The ID of the team to which the discussion belongs.

title
String!

The title of the discussion.

DeclineTopicSuggestionInput#

Autogenerated input type of DeclineTopicSuggestion

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

name
String!

The name of the suggested topic.

reason
TopicSuggestionDeclineReason!

The reason why the suggested topic is declined.

repositoryId
ID!

The Node ID of the repository.

DeleteBranchProtectionRuleInput#

Autogenerated input type of DeleteBranchProtectionRule

Arguments

NameDescription
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.

DeleteDeploymentInput#

Autogenerated input type of DeleteDeployment

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The Node ID of the deployment to be deleted.

DeleteIpAllowListEntryInput#

Autogenerated input type of DeleteIpAllowListEntry

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

ipAllowListEntryId
ID!

The ID of the IP allow list entry to delete.

DeleteIssueCommentInput#

Autogenerated input type of DeleteIssueComment

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The ID of the comment to delete.

DeleteIssueInput#

Autogenerated input type of DeleteIssue

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issueId
ID!

The ID of the issue to delete.

DeleteLabelInput#

Autogenerated input type of DeleteLabel

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The Node ID of the label to be deleted.

DeletePackageVersionInput#

Autogenerated input type of DeletePackageVersion

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

packageVersionId
ID!

The ID of the package version to be deleted.

DeleteProjectCardInput#

Autogenerated input type of DeleteProjectCard

Arguments

NameDescription
cardId
ID!

The id of the card to delete.

clientMutationId
String

A unique identifier for the client performing the mutation.

DeleteProjectColumnInput#

Autogenerated input type of DeleteProjectColumn

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

columnId
ID!

The id of the column to delete.

DeleteProjectInput#

Autogenerated input type of DeleteProject

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

projectId
ID!

The Project ID to update.

DeletePullRequestReviewCommentInput#

Autogenerated input type of DeletePullRequestReviewComment

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The ID of the comment to delete.

DeletePullRequestReviewInput#

Autogenerated input type of DeletePullRequestReview

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReviewId
ID!

The Node ID of the pull request review to delete.

DeleteRefInput#

Autogenerated input type of DeleteRef

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

refId
ID!

The Node ID of the Ref to be deleted.

DeleteTeamDiscussionCommentInput#

Autogenerated input type of DeleteTeamDiscussionComment

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The ID of the comment to delete.

DeleteTeamDiscussionInput#

Autogenerated input type of DeleteTeamDiscussion

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The discussion ID to delete.

DeleteVerifiableDomainInput#

Autogenerated input type of DeleteVerifiableDomain

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The ID of the verifiable domain to delete.

DeploymentOrder#

Ordering options for deployment connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
DeploymentOrderField!

The field to order deployments by.

DisablePullRequestAutoMergeInput#

Autogenerated input type of DisablePullRequestAutoMerge

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestId
ID!

ID of the pull request to disable auto merge on.

DismissPullRequestReviewInput#

Autogenerated input type of DismissPullRequestReview

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

message
String!

The contents of the pull request review dismissal message.

pullRequestReviewId
ID!

The Node ID of the pull request review to modify.

DraftPullRequestReviewComment#

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

Arguments

NameDescription
body
String!

Body of the comment to leave.

path
String!

Path to the file being commented on.

position
Int!

Position in the file to leave a comment on.

DraftPullRequestReviewThread#

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

Arguments

NameDescription
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.

path
String!

Path to the file being commented on.

side
DiffSide

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

startLine
Int

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

startSide
DiffSide

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

EnablePullRequestAutoMergeInput#

Autogenerated input type of EnablePullRequestAutoMerge

Arguments

NameDescription
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.

commitHeadline
String

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

mergeMethod
PullRequestMergeMethod

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

pullRequestId
ID!

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

EnterpriseAdministratorInvitationOrder#

Ordering options for enterprise administrator invitation connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
EnterpriseAdministratorInvitationOrderField!

The field to order enterprise administrator invitations by.

EnterpriseMemberOrder#

Ordering options for enterprise member connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
EnterpriseMemberOrderField!

The field to order enterprise members by.

EnterpriseServerInstallationOrder#

Ordering options for Enterprise Server installation connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
EnterpriseServerInstallationOrderField!

The field to order Enterprise Server installations by.

EnterpriseServerUserAccountEmailOrder#

Ordering options for Enterprise Server user account email connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
EnterpriseServerUserAccountEmailOrderField!

The field to order emails by.

EnterpriseServerUserAccountOrder#

Ordering options for Enterprise Server user account connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
EnterpriseServerUserAccountOrderField!

The field to order user accounts by.

EnterpriseServerUserAccountsUploadOrder#

Ordering options for Enterprise Server user accounts upload connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
EnterpriseServerUserAccountsUploadOrderField!

The field to order user accounts uploads by.

FollowUserInput#

Autogenerated input type of FollowUser

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

userId
ID!

ID of the user to follow.

GistOrder#

Ordering options for gist connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
GistOrderField!

The field to order repositories by.

ImportProjectInput#

Autogenerated input type of ImportProject

Arguments

NameDescription
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.

InviteEnterpriseAdminInput#

Autogenerated input type of InviteEnterpriseAdmin

Arguments

NameDescription
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.

IpAllowListEntryOrder#

Ordering options for IP allow list entry connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
IpAllowListEntryOrderField!

The field to order IP allow list entries by.

IssueCommentOrder#

Ways in which lists of issue comments can be ordered upon return.

Arguments

NameDescription
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.

IssueFilters#

Ways in which to filter lists of issues.

Arguments

NameDescription
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 number field. Pass innull 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.

viewerSubscribed
Boolean

List issues subscribed to by viewer.

IssueOrder#

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

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order issues by the specified field.

field
IssueOrderField!

The field in which to order issues by.

LabelOrder#

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

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order labels by the specified field.

field
LabelOrderField!

The field in which to order labels by.

LanguageOrder#

Ordering options for language connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
LanguageOrderField!

The field to order languages by.

LinkRepositoryToProjectInput#

Autogenerated input type of LinkRepositoryToProject

Arguments

NameDescription
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.

LockLockableInput#

Autogenerated input type of LockLockable

Arguments

NameDescription
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.

MarkFileAsViewedInput#

Autogenerated input type of MarkFileAsViewed

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

path
String!

The path of the file to mark as viewed

pullRequestId
ID!

The Node ID of the pull request.

MarkPullRequestReadyForReviewInput#

Autogenerated input type of MarkPullRequestReadyForReview

Arguments

NameDescription
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.

MergeBranchInput#

Autogenerated input type of MergeBranch

Arguments

NameDescription
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.

MergePullRequestInput#

Autogenerated input type of MergePullRequest

Arguments

NameDescription
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.

MilestoneOrder#

Ordering options for milestone connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
MilestoneOrderField!

The field to order milestones by.

MinimizeCommentInput#

Autogenerated input type of MinimizeComment

Arguments

NameDescription
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.

MoveProjectCardInput#

Autogenerated input type of MoveProjectCard

Arguments

NameDescription
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.

MoveProjectColumnInput#

Autogenerated input type of MoveProjectColumn

Arguments

NameDescription
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.

OrganizationOrder#

Ordering options for organization connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
OrganizationOrderField!

The field to order organizations by.

PackageFileOrder#

Ways in which lists of package files can be ordered upon return.

Arguments

NameDescription
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.

PackageOrder#

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

Arguments

NameDescription
direction
OrderDirection

The direction in which to order packages by the specified field.

field
PackageOrderField

The field in which to order packages by.

PackageVersionOrder#

Ways in which lists of package versions can be ordered upon return.

Arguments

NameDescription
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.

PinIssueInput#

Autogenerated input type of PinIssue

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issueId
ID!

The ID of the issue to be pinned

ProjectCardImport#

An issue or PR and its owning repository to be used in a project card.

Arguments

NameDescription
number
Int!

The issue or pull request number.

repository
String!

Repository name with owner (owner/repository).

ProjectColumnImport#

A project column and a list of its issues and PRs.

Arguments

NameDescription
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.

ProjectOrder#

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

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order projects by the specified field.

field
ProjectOrderField!

The field in which to order projects by.

PullRequestOrder#

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

Arguments

NameDescription
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.

ReactionOrder#

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

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order reactions by the specified field.

field
ReactionOrderField!

The field in which to order reactions by.

RefOrder#

Ways in which lists of git refs can be ordered upon return.

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order refs by the specified field.

field
RefOrderField!

The field in which to order refs by.

RefUpdate#

A ref update

Arguments

NameDescription
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

RegenerateEnterpriseIdentityProviderRecoveryCodesInput#

Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes

Arguments

NameDescription
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.

RegenerateVerifiableDomainTokenInput#

Autogenerated input type of RegenerateVerifiableDomainToken

Arguments

NameDescription
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.

ReleaseOrder#

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

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order releases by the specified field.

field
ReleaseOrderField!

The field in which to order releases by.

RemoveAssigneesFromAssignableInput#

Autogenerated input type of RemoveAssigneesFromAssignable

Arguments

NameDescription
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.

RemoveEnterpriseAdminInput#

Autogenerated input type of RemoveEnterpriseAdmin

Arguments

NameDescription
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.

RemoveEnterpriseIdentityProviderInput#

Autogenerated input type of RemoveEnterpriseIdentityProvider

Arguments

NameDescription
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.

RemoveEnterpriseOrganizationInput#

Autogenerated input type of RemoveEnterpriseOrganization

Arguments

NameDescription
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.

RemoveEnterpriseSupportEntitlementInput#

Autogenerated input type of RemoveEnterpriseSupportEntitlement

Arguments

NameDescription
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.

RemoveLabelsFromLabelableInput#

Autogenerated input type of RemoveLabelsFromLabelable

Arguments

NameDescription
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.

RemoveOutsideCollaboratorInput#

Autogenerated input type of RemoveOutsideCollaborator

Arguments

NameDescription
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.

RemoveReactionInput#

Autogenerated input type of RemoveReaction

Arguments

NameDescription
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.

RemoveStarInput#

Autogenerated input type of RemoveStar

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

starrableId
ID!

The Starrable ID to unstar.

ReopenIssueInput#

Autogenerated input type of ReopenIssue

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issueId
ID!

ID of the issue to be opened.

ReopenPullRequestInput#

Autogenerated input type of ReopenPullRequest

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestId
ID!

ID of the pull request to be reopened.

RepositoryInvitationOrder#

Ordering options for repository invitation connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
RepositoryInvitationOrderField!

The field to order repository invitations by.

RepositoryOrder#

Ordering options for repository connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
RepositoryOrderField!

The field to order repositories by.

RequestReviewsInput#

Autogenerated input type of RequestReviews

Arguments

NameDescription
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.

RerequestCheckSuiteInput#

Autogenerated input type of RerequestCheckSuite

Arguments

NameDescription
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.

ResolveReviewThreadInput#

Autogenerated input type of ResolveReviewThread

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

threadId
ID!

The ID of the thread to resolve

SavedReplyOrder#

Ordering options for saved reply connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
SavedReplyOrderField!

The field to order saved replies by.

SecurityAdvisoryIdentifierFilter#

An advisory identifier to filter results on.

Arguments

NameDescription
type
SecurityAdvisoryIdentifierType!

The identifier type.

value
String!

The identifier string. Supports exact or partial matching.

SecurityAdvisoryOrder#

Ordering options for security advisory connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
SecurityAdvisoryOrderField!

The field to order security advisories by.

SecurityVulnerabilityOrder#

Ordering options for security vulnerability connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
SecurityVulnerabilityOrderField!

The field to order security vulnerabilities by.

SetEnterpriseIdentityProviderInput#

Autogenerated input type of SetEnterpriseIdentityProvider

Arguments

NameDescription
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.

SetOrganizationInteractionLimitInput#

Autogenerated input type of SetOrganizationInteractionLimit

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

expiry
RepositoryInteractionLimitExpiry

When this limit should expire.

limit
RepositoryInteractionLimit!

The limit to set.

organizationId
ID!

The ID of the organization to set a limit for.

SetRepositoryInteractionLimitInput#

Autogenerated input type of SetRepositoryInteractionLimit

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

expiry
RepositoryInteractionLimitExpiry

When this limit should expire.

limit
RepositoryInteractionLimit!

The limit to set.

repositoryId
ID!

The ID of the repository to set a limit for.

SetUserInteractionLimitInput#

Autogenerated input type of SetUserInteractionLimit

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

expiry
RepositoryInteractionLimitExpiry

When this limit should expire.

limit
RepositoryInteractionLimit!

The limit to set.

userId
ID!

The ID of the user to set a limit for.

SponsorableOrder#

Ordering options for connections to get sponsorable entities for GitHub Sponsors.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
SponsorableOrderField!

The field to order sponsorable entities by.

SponsorshipOrder#

Ordering options for sponsorship connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
SponsorshipOrderField!

The field to order sponsorship by.

SponsorsTierOrder#

Ordering options for Sponsors tiers connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
SponsorsTierOrderField!

The field to order tiers by.

StarOrder#

Ways in which star connections can be ordered.

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order nodes.

field
StarOrderField!

The field in which to order nodes by.

SubmitPullRequestReviewInput#

Autogenerated input type of SubmitPullRequestReview

Arguments

NameDescription
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.

TeamDiscussionCommentOrder#

Ways in which team discussion comment connections can be ordered.

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order nodes.

field
TeamDiscussionCommentOrderField!

The field by which to order nodes.

TeamDiscussionOrder#

Ways in which team discussion connections can be ordered.

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order nodes.

field
TeamDiscussionOrderField!

The field by which to order nodes.

TeamMemberOrder#

Ordering options for team member connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
TeamMemberOrderField!

The field to order team members by.

TeamOrder#

Ways in which team connections can be ordered.

Arguments

NameDescription
direction
OrderDirection!

The direction in which to order nodes.

field
TeamOrderField!

The field in which to order nodes by.

TeamRepositoryOrder#

Ordering options for team repository connections

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
TeamRepositoryOrderField!

The field to order repositories by.

TransferIssueInput#

Autogenerated input type of TransferIssue

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

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

UnarchiveRepositoryInput#

Autogenerated input type of UnarchiveRepository

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

repositoryId
ID!

The ID of the repository to unarchive.

UnfollowUserInput#

Autogenerated input type of UnfollowUser

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

userId
ID!

ID of the user to unfollow.

UnlinkRepositoryFromProjectInput#

Autogenerated input type of UnlinkRepositoryFromProject

Arguments

NameDescription
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.

UnlockLockableInput#

Autogenerated input type of UnlockLockable

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

lockableId
ID!

ID of the item to be unlocked.

UnmarkFileAsViewedInput#

Autogenerated input type of UnmarkFileAsViewed

Arguments

NameDescription
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.

UnmarkIssueAsDuplicateInput#

Autogenerated input type of UnmarkIssueAsDuplicate

Arguments

NameDescription
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.

UnminimizeCommentInput#

Autogenerated input type of UnminimizeComment

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

subjectId
ID!

The Node ID of the subject to modify.

UnpinIssueInput#

Autogenerated input type of UnpinIssue

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

issueId
ID!

The ID of the issue to be unpinned

UnresolveReviewThreadInput#

Autogenerated input type of UnresolveReviewThread

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

threadId
ID!

The ID of the thread to unresolve

UpdateBranchProtectionRuleInput#

Autogenerated input type of UpdateBranchProtectionRule

Arguments

NameDescription
allowsDeletions
Boolean

Can this branch be deleted.

allowsForcePushes
Boolean

Are force pushes allowed on this branch.

branchProtectionRuleId
ID!

The global relay id of the branch protection rule to be updated.

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 overwrite branch protection.

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.

requiredApprovingReviewCount
Int

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.

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.

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 or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

UpdateCheckRunInput#

Autogenerated input type of UpdateCheckRun

Arguments

NameDescription
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.

UpdateCheckSuitePreferencesInput#

Autogenerated input type of UpdateCheckSuitePreferences

Arguments

NameDescription
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.

UpdateEnterpriseAdministratorRoleInput#

Autogenerated input type of UpdateEnterpriseAdministratorRole

Arguments

NameDescription
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.

UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput#

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterpriseId
ID!

The ID of the enterprise on which to set the allow private repository forking setting.

settingValue
EnterpriseEnabledDisabledSettingValue!

The value for the allow private repository forking setting on the enterprise.

UpdateEnterpriseDefaultRepositoryPermissionSettingInput#

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

enterpriseId
ID!

The ID of the enterprise on which to set the default repository permission setting.

settingValue
EnterpriseDefaultRepositoryPermissionSettingValue!

The value for the default repository permission setting on the enterprise.

UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting

Arguments

NameDescription
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.

UpdateEnterpriseMembersCanCreateRepositoriesSettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting

Arguments

NameDescription
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.

UpdateEnterpriseMembersCanDeleteIssuesSettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting

Arguments

NameDescription
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.

UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting

Arguments

NameDescription
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.

UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting

Arguments

NameDescription
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.

UpdateEnterpriseMembersCanMakePurchasesSettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting

Arguments

NameDescription
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.

UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting

Arguments

NameDescription
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.

UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput#

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting

Arguments

NameDescription
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.

UpdateEnterpriseOrganizationProjectsSettingInput#

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting

Arguments

NameDescription
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.

UpdateEnterpriseProfileInput#

Autogenerated input type of UpdateEnterpriseProfile

Arguments

NameDescription
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.

UpdateEnterpriseRepositoryProjectsSettingInput#

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting

Arguments

NameDescription
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.

UpdateEnterpriseTeamDiscussionsSettingInput#

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting

Arguments

NameDescription
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.

UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput#

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting

Arguments

NameDescription
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.

UpdateIpAllowListEnabledSettingInput#

Autogenerated input type of UpdateIpAllowListEnabledSetting

Arguments

NameDescription
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.

UpdateIpAllowListEntryInput#

Autogenerated input type of UpdateIpAllowListEntry

Arguments

NameDescription
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.

UpdateIssueCommentInput#

Autogenerated input type of UpdateIssueComment

Arguments

NameDescription
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.

UpdateIssueInput#

Autogenerated input type of UpdateIssue

Arguments

NameDescription
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.

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.

UpdateLabelInput#

Autogenerated input type of UpdateLabel

Arguments

NameDescription
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.

UpdateNotificationRestrictionSettingInput#

Autogenerated input type of UpdateNotificationRestrictionSetting

Arguments

NameDescription
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.

UpdateProjectCardInput#

Autogenerated input type of UpdateProjectCard

Arguments

NameDescription
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.

UpdateProjectColumnInput#

Autogenerated input type of UpdateProjectColumn

Arguments

NameDescription
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.

UpdateProjectInput#

Autogenerated input type of UpdateProject

Arguments

NameDescription
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.

UpdatePullRequestInput#

Autogenerated input type of UpdatePullRequest

Arguments

NameDescription
assigneeIds
[ID!]

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

baseRefName
String

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

body
String

The contents of the pull request.

clientMutationId
String

A unique identifier for the client performing the mutation.

labelIds
[ID!]

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

maintainerCanModify
Boolean

Indicates whether maintainers can modify the pull request.

milestoneId
ID

The Node ID of the milestone for this pull request.

projectIds
[ID!]

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

pullRequestId
ID!

The Node ID of the pull request.

state
PullRequestUpdateState

The target state of the pull request.

title
String

The title of the pull request.

UpdatePullRequestReviewCommentInput#

Autogenerated input type of UpdatePullRequestReviewComment

Arguments

NameDescription
body
String!

The text of the comment.

clientMutationId
String

A unique identifier for the client performing the mutation.

pullRequestReviewCommentId
ID!

The Node ID of the comment to modify.

UpdatePullRequestReviewInput#

Autogenerated input type of UpdatePullRequestReview

Arguments

NameDescription
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.

UpdateRefInput#

Autogenerated input type of UpdateRef

Arguments

NameDescription
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.

UpdateRefsInput#

Autogenerated input type of UpdateRefs

Arguments

NameDescription
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.

UpdateRepositoryInput#

Autogenerated input type of UpdateRepository

Arguments

NameDescription
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.

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.

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.

UpdateSubscriptionInput#

Autogenerated input type of UpdateSubscription

Arguments

NameDescription
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.

UpdateTeamDiscussionCommentInput#

Autogenerated input type of UpdateTeamDiscussionComment

Arguments

NameDescription
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.

UpdateTeamDiscussionInput#

Autogenerated input type of UpdateTeamDiscussion

Arguments

NameDescription
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.

UpdateTeamReviewAssignmentInput#

Autogenerated input type of UpdateTeamReviewAssignment

Arguments

NameDescription
algorithm
TeamReviewAssignmentAlgorithm

The algorithm to use for review assignment

clientMutationId
String

A unique identifier for the client performing the mutation.

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

notifyTeam
Boolean

Notify the entire team of the PR if it is delegated

teamMemberCount
Int

The number of team members to assign

UpdateTopicsInput#

Autogenerated input type of UpdateTopics

Arguments

NameDescription
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.

UserStatusOrder#

Ordering options for user status connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
UserStatusOrderField!

The field to order user statuses by.

VerifiableDomainOrder#

Ordering options for verifiable domain connections.

Arguments

NameDescription
direction
OrderDirection!

The ordering direction.

field
VerifiableDomainOrderField!

The field to order verifiable domains by.

VerifyVerifiableDomainInput#

Autogenerated input type of VerifyVerifiableDomain

Arguments

NameDescription
clientMutationId
String

A unique identifier for the client performing the mutation.

id
ID!

The ID of the verifiable domain to verify.