Input objects

Input objects can be described as "composable objects" because they include a set of input fields that define the object.

About input objects

Input objects can be described as "composable objects" because they include a set of input fields that define the object.

For example, CommitAuthor takes a field called emails. Providing a value for emails transforms CommitAuthor into a list of User objects containing that email address. Note that objects may have input objects, whereas mutations require input objects.

For more information, see Forming calls with GraphQL.

AbortQueuedMigrationsInput

Autogenerated input type of AbortQueuedMigrations.

Input fields for `AbortQueuedMigrationsInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`ownerId` (`ID!`)	The ID of the organization that is running the migrations.

AbortRepositoryMigrationInput

Autogenerated input type of AbortRepositoryMigration.

Input fields for `AbortRepositoryMigrationInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`migrationId` (`ID!`)	The ID of the migration to be aborted.

AcceptEnterpriseAdministratorInvitationInput

Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

Input fields for `AcceptEnterpriseAdministratorInvitationInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`invitationId` (`ID!`)	The id of the invitation being accepted.

AcceptEnterpriseMemberInvitationInput

Autogenerated input type of AcceptEnterpriseMemberInvitation.

Input fields for `AcceptEnterpriseMemberInvitationInput`

Name	Description
`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.

Input fields for `AcceptTopicSuggestionInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`name` (`String`)	The name of the suggested topic. Upcoming Change on 2024-04-01 UTC Description: `name` will be removed. Reason: Suggested topics are no longer supported.
`repositoryId` (`ID`)	The Node ID of the repository. Upcoming Change on 2024-04-01 UTC Description: `repositoryId` will be removed. Reason: Suggested topics are no longer supported.

AccessUserNamespaceRepositoryInput

Autogenerated input type of AccessUserNamespaceRepository.

Input fields for `AccessUserNamespaceRepositoryInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enterpriseId` (`ID!`)	The ID of the enterprise owning the user namespace repository.
`repositoryId` (`ID!`)	The ID of the user namespace repository to access.

AddAssigneesToAssignableInput

Autogenerated input type of AddAssigneesToAssignable.

Input fields for `AddAssigneesToAssignableInput`

Name	Description
`assignableId` (`ID!`)	The id of the assignable object to add assignees to.
`assigneeIds` (`[ID!]!`)	The id of users to add as assignees.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.

AddBlockedByInput

Autogenerated input type of AddBlockedBy.

Input fields for `AddBlockedByInput`

Name	Description
`blockingIssueId` (`ID!`)	The ID of the issue that blocks the given issue.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`issueId` (`ID!`)	The ID of the issue to be blocked.

AddCommentInput

Autogenerated input type of AddComment.

Input fields for `AddCommentInput`

Name	Description
`body` (`String!`)	The contents of the comment.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`subjectId` (`ID!`)	The Node ID of the subject to modify.

AddDiscussionCommentInput

Autogenerated input type of AddDiscussionComment.

Input fields for `AddDiscussionCommentInput`

Name	Description
`body` (`String!`)	The contents of the comment.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`discussionId` (`ID!`)	The Node ID of the discussion to comment on.
`replyToId` (`ID`)	The Node ID of the discussion comment within this discussion to reply to.

AddDiscussionPollVoteInput

Autogenerated input type of AddDiscussionPollVote.

Input fields for `AddDiscussionPollVoteInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`pollOptionId` (`ID!`)	The Node ID of the discussion poll option to vote for.

AddEnterpriseOrganizationMemberInput

Autogenerated input type of AddEnterpriseOrganizationMember.

Input fields for `AddEnterpriseOrganizationMemberInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enterpriseId` (`ID!`)	The ID of the enterprise which owns the organization.
`organizationId` (`ID!`)	The ID of the organization the users will be added to.
`role` (`OrganizationMemberRole`)	The role to assign the users in the organization.
`userIds` (`[ID!]!`)	The IDs of the enterprise members to add.

AddEnterpriseSupportEntitlementInput

Autogenerated input type of AddEnterpriseSupportEntitlement.

Input fields for `AddEnterpriseSupportEntitlementInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enterpriseId` (`ID!`)	The ID of the Enterprise which the admin belongs to.
`login` (`String!`)	The login of a member who will receive the support entitlement.

AddLabelsToLabelableInput

Autogenerated input type of AddLabelsToLabelable.

Input fields for `AddLabelsToLabelableInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`labelIds` (`[ID!]!`)	The ids of the labels to add.
`labelableId` (`ID!`)	The id of the labelable object to add labels to.

AddProjectCardInput

Autogenerated input type of AddProjectCard.

Input fields for `AddProjectCardInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`contentId` (`ID`)	The content of the card. Must be a member of the ProjectCardItem union.
`note` (`String`)	The note on the card.
`projectColumnId` (`ID!`)	The Node ID of the ProjectColumn.

AddProjectColumnInput

Autogenerated input type of AddProjectColumn.

Input fields for `AddProjectColumnInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`name` (`String!`)	The name of the column.
`projectId` (`ID!`)	The Node ID of the project.

AddProjectV2DraftIssueInput

Autogenerated input type of AddProjectV2DraftIssue.

Input fields for `AddProjectV2DraftIssueInput`

Name	Description
`assigneeIds` (`[ID!]`)	The IDs of the assignees of the draft issue.
`body` (`String`)	The body of the draft issue.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`projectId` (`ID!`)	The ID of the Project to add the draft issue to.
`title` (`String!`)	The title of the draft issue. A project item can also be created by providing the URL of an Issue or Pull Request if you have access.

AddProjectV2ItemByIdInput

Autogenerated input type of AddProjectV2ItemById.

Input fields for `AddProjectV2ItemByIdInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`contentId` (`ID!`)	The id of the Issue or Pull Request to add.
`projectId` (`ID!`)	The ID of the Project to add the item to.

AddPullRequestReviewCommentInput

Autogenerated input type of AddPullRequestReviewComment.

Input fields for `AddPullRequestReviewCommentInput`

Name	Description
`body` (`String`)	The text of the comment. This field is required Upcoming Change on 2023-10-01 UTC Description: `body` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`commitOID` (`GitObjectID`)	The SHA of the commit to comment on. Upcoming Change on 2023-10-01 UTC Description: `commitOID` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.
`inReplyTo` (`ID`)	The comment id to reply to. Upcoming Change on 2023-10-01 UTC Description: `inReplyTo` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.
`path` (`String`)	The relative path of the file to comment on. Upcoming Change on 2023-10-01 UTC Description: `path` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.
`position` (`Int`)	The line index in the diff to comment on. Upcoming Change on 2023-10-01 UTC Description: `position` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.
`pullRequestId` (`ID`)	The node ID of the pull request reviewing Upcoming Change on 2023-10-01 UTC Description: `pullRequestId` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.
`pullRequestReviewId` (`ID`)	The Node ID of the review to modify. Upcoming Change on 2023-10-01 UTC Description: `pullRequestReviewId` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

AddPullRequestReviewInput

Autogenerated input type of AddPullRequestReview.

Input fields for `AddPullRequestReviewInput`

Name	Description
`body` (`String`)	The contents of the review body comment.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`comments` (`[DraftPullRequestReviewComment]`)	The review line comments. Upcoming Change on 2023-10-01 UTC Description: `comments` will be removed. use the `threads` argument instead Reason: We are deprecating comment fields that use diff-relative positioning.
`commitOID` (`GitObjectID`)	The commit OID the review pertains to.
`event` (`PullRequestReviewEvent`)	The event to perform on the pull request review.
`pullRequestId` (`ID!`)	The Node ID of the pull request to modify.
`threads` (`[DraftPullRequestReviewThread]`)	The review line comment threads.

AddPullRequestReviewThreadInput

Autogenerated input type of AddPullRequestReviewThread.

Input fields for `AddPullRequestReviewThreadInput`

Name	Description
`body` (`String!`)	Body of the thread's first comment.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`line` (`Int`)	The line of the blob to which the thread refers, required for line-level threads. The end of the line range for multi-line comments.
`path` (`String`)	Path to the file being commented on.
`pullRequestId` (`ID`)	The node ID of the pull request reviewing.
`pullRequestReviewId` (`ID`)	The Node ID of the review to modify.
`side` (`DiffSide`)	The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
`startLine` (`Int`)	The first line of the range to which the comment refers.
`startSide` (`DiffSide`)	The side of the diff on which the start line resides.
`subjectType` (`PullRequestReviewThreadSubjectType`)	The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

AddPullRequestReviewThreadReplyInput

Autogenerated input type of AddPullRequestReviewThreadReply.

Input fields for `AddPullRequestReviewThreadReplyInput`

Name	Description
`body` (`String!`)	The text of the reply.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`pullRequestReviewId` (`ID`)	The Node ID of the pending review to which the reply will belong.
`pullRequestReviewThreadId` (`ID!`)	The Node ID of the thread to which this reply is being written.

AddReactionInput

Autogenerated input type of AddReaction.

Input fields for `AddReactionInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`content` (`ReactionContent!`)	The name of the emoji to react with.
`subjectId` (`ID!`)	The Node ID of the subject to modify.

AddStarInput

Autogenerated input type of AddStar.

Input fields for `AddStarInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`starrableId` (`ID!`)	The Starrable ID to star.

AddSubIssueInput

Autogenerated input type of AddSubIssue.

Input fields for `AddSubIssueInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`issueId` (`ID!`)	The id of the issue.
`replaceParent` (`Boolean`)	Option to replace parent issue if one already exists.
`subIssueId` (`ID`)	The id of the sub-issue.
`subIssueUrl` (`String`)	The url of the sub-issue.

AddUpvoteInput

Autogenerated input type of AddUpvote.

Input fields for `AddUpvoteInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`subjectId` (`ID!`)	The Node ID of the discussion or comment to upvote.

AddVerifiableDomainInput

Autogenerated input type of AddVerifiableDomain.

Input fields for `AddVerifiableDomainInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`domain` (`URI!`)	The URL of the domain.
`ownerId` (`ID!`)	The ID of the owner to add the domain to.

ApproveDeploymentsInput

Autogenerated input type of ApproveDeployments.

Input fields for `ApproveDeploymentsInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`comment` (`String`)	Optional comment for approving deployments.
`environmentIds` (`[ID!]!`)	The ids of environments to reject deployments.
`workflowRunId` (`ID!`)	The node ID of the workflow run containing the pending deployments.

ApproveVerifiableDomainInput

Autogenerated input type of ApproveVerifiableDomain.

Input fields for `ApproveVerifiableDomainInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The ID of the verifiable domain to approve.

ArchiveProjectV2ItemInput

Autogenerated input type of ArchiveProjectV2Item.

Input fields for `ArchiveProjectV2ItemInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`itemId` (`ID!`)	The ID of the ProjectV2Item to archive.
`projectId` (`ID!`)	The ID of the Project to archive the item from.

ArchiveRepositoryInput

Autogenerated input type of ArchiveRepository.

Input fields for `ArchiveRepositoryInput`

Name	Description
`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.

Input fields for `AuditLogOrder`

Name	Description
`direction` (`OrderDirection`)	The ordering direction.
`field` (`AuditLogOrderField`)	The field to order Audit Logs by.

BranchNamePatternParametersInput

Parameters to be used for the branch_name_pattern rule.

Input fields for `BranchNamePatternParametersInput`

Name	Description
`name` (`String`)	How this rule will appear to users.
`negate` (`Boolean`)	If true, the rule will fail if the pattern matches.
`operator` (`String!`)	The operator to use for matching.
`pattern` (`String!`)	The pattern to match with.

BulkSponsorship

Information about a sponsorship to make for a user or organization with a GitHub Sponsors profile, as part of sponsoring many users or organizations at once.

Input fields for `BulkSponsorship`

Name	Description
`amount` (`Int!`)	The amount to pay to the sponsorable in US dollars. Valid values: 1-12000.
`sponsorableId` (`ID`)	The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
`sponsorableLogin` (`String`)	The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

CancelEnterpriseAdminInvitationInput

Autogenerated input type of CancelEnterpriseAdminInvitation.

Input fields for `CancelEnterpriseAdminInvitationInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`invitationId` (`ID!`)	The Node ID of the pending enterprise administrator invitation.

CancelEnterpriseMemberInvitationInput

Autogenerated input type of CancelEnterpriseMemberInvitation.

Input fields for `CancelEnterpriseMemberInvitationInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`invitationId` (`ID!`)	The Node ID of the pending enterprise member invitation.

CancelSponsorshipInput

Autogenerated input type of CancelSponsorship.

Input fields for `CancelSponsorshipInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`sponsorId` (`ID`)	The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given.
`sponsorLogin` (`String`)	The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given.
`sponsorableId` (`ID`)	The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
`sponsorableLogin` (`String`)	The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

ChangeUserStatusInput

Autogenerated input type of ChangeUserStatus.

Input fields for `ChangeUserStatusInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`emoji` (`String`)	The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.
`expiresAt` (`DateTime`)	If set, the user status will not be shown after this date.
`limitedAvailability` (`Boolean`)	Whether this status should indicate you are not fully available on GitHub, e.g., you are away.
`message` (`String`)	A short description of your current status.
`organizationId` (`ID`)	The ID of the organization whose members will be allowed to see the status. If omitted, the status will be publicly visible.

CheckAnnotationData

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

Input fields for `CheckAnnotationData`

Name	Description
`annotationLevel` (`CheckAnnotationLevel!`)	Represents an annotation's information level.
`location` (`CheckAnnotationRange!`)	The location of the annotation.
`message` (`String!`)	A short description of the feedback for these lines of code.
`path` (`String!`)	The path of the file to add an annotation to.
`rawDetails` (`String`)	Details about this annotation.
`title` (`String`)	The title that represents the annotation.

CheckAnnotationRange

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

Input fields for `CheckAnnotationRange`

Name	Description
`endColumn` (`Int`)	The ending column of the range.
`endLine` (`Int!`)	The ending line of the range.
`startColumn` (`Int`)	The starting column of the range.
`startLine` (`Int!`)	The starting line of the range.

CheckRunAction

Possible further actions the integrator can perform.

Input fields for `CheckRunAction`

Name	Description
`description` (`String!`)	A short explanation of what this action would do.
`identifier` (`String!`)	A reference for the action on the integrator's system.
`label` (`String!`)	The text to be displayed on a button in the web UI.

CheckRunFilter

The filters that are available when fetching check runs.

Input fields for `CheckRunFilter`

Name	Description
`appId` (`Int`)	Filters the check runs created by this application ID.
`checkName` (`String`)	Filters the check runs by this name.
`checkType` (`CheckRunType`)	Filters the check runs by this type.
`conclusions` (`[CheckConclusionState!]`)	Filters the check runs by these conclusions.
`status` (`CheckStatusState`)	Filters the check runs by this status. Superceded by statuses.
`statuses` (`[CheckStatusState!]`)	Filters the check runs by this status. Overrides status.

CheckRunOutput

Descriptive details about the check run.

Input fields for `CheckRunOutput`

Name	Description
`annotations` (`[CheckAnnotationData!]`)	The annotations that are made as part of the check run.
`images` (`[CheckRunOutputImage!]`)	Images attached to the check run output displayed in the GitHub pull request UI.
`summary` (`String!`)	The summary of the check run (supports Commonmark).
`text` (`String`)	The details of the check run (supports Commonmark).
`title` (`String!`)	A title to provide for this check run.

CheckRunOutputImage

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

Input fields for `CheckRunOutputImage`

Name	Description
`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.

Input fields for `CheckSuiteAutoTriggerPreference`

Name	Description
`appId` (`ID!`)	The node ID of the application that owns the check suite.
`setting` (`Boolean!`)	Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository.

CheckSuiteFilter

The filters that are available when fetching check suites.

Input fields for `CheckSuiteFilter`

Name	Description
`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.

Input fields for `ClearLabelsFromLabelableInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`labelableId` (`ID!`)	The id of the labelable object to clear the labels from.

ClearProjectV2ItemFieldValueInput

Autogenerated input type of ClearProjectV2ItemFieldValue.

Input fields for `ClearProjectV2ItemFieldValueInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`fieldId` (`ID!`)	The ID of the field to be cleared.
`itemId` (`ID!`)	The ID of the item to be cleared.
`projectId` (`ID!`)	The ID of the Project.

CloneProjectInput

Autogenerated input type of CloneProject.

Input fields for `CloneProjectInput`

Name	Description
`body` (`String`)	The description of the project.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`includeWorkflows` (`Boolean!`)	Whether or not to clone the source project's workflows.
`name` (`String!`)	The name of the project.
`public` (`Boolean`)	The visibility of the project, defaults to false (private).
`sourceId` (`ID!`)	The source project to clone.
`targetOwnerId` (`ID!`)	The owner ID to create the project under.

CloneTemplateRepositoryInput

Autogenerated input type of CloneTemplateRepository.

Input fields for `CloneTemplateRepositoryInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`description` (`String`)	A short description of the new repository.
`includeAllBranches` (`Boolean`)	Whether to copy all branches from the template to the new repository. Defaults to copying only the default branch of the template.
`name` (`String!`)	The name of the new repository.
`ownerId` (`ID!`)	The ID of the owner for the new repository.
`repositoryId` (`ID!`)	The Node ID of the template repository.
`visibility` (`RepositoryVisibility!`)	Indicates the repository's visibility level.

CloseDiscussionInput

Autogenerated input type of CloseDiscussion.

Input fields for `CloseDiscussionInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`discussionId` (`ID!`)	ID of the discussion to be closed.
`reason` (`DiscussionCloseReason`)	The reason why the discussion is being closed.

CloseIssueInput

Autogenerated input type of CloseIssue.

Input fields for `CloseIssueInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`duplicateIssueId` (`ID`)	ID of the issue that this is a duplicate of.
`issueId` (`ID!`)	ID of the issue to be closed.
`stateReason` (`IssueClosedStateReason`)	The reason the issue is to be closed.

ClosePullRequestInput

Autogenerated input type of ClosePullRequest.

Input fields for `ClosePullRequestInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`pullRequestId` (`ID!`)	ID of the pull request to be closed.

CodeScanningParametersInput

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

Input fields for `CodeScanningParametersInput`

Name	Description
`codeScanningTools` (`[CodeScanningToolInput!]!`)	Tools that must provide code scanning results for this rule to pass.

CodeScanningToolInput

A tool that must provide code scanning results for this rule to pass.

Input fields for `CodeScanningToolInput`

Name	Description
`alertsThreshold` (`String!`)	The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts.".
`securityAlertsThreshold` (`String!`)	The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts.".
`tool` (`String!`)	The name of a code scanning tool.

CommitAuthor

Specifies an author for filtering Git commits.

Input fields for `CommitAuthor`

Name	Description
`emails` (`[String!]`)	Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.
`id` (`ID`)	ID of a User to filter by. If non-null, only commits authored by this user will be returned. This field takes precedence over emails.

CommitAuthorEmailPatternParametersInput

Parameters to be used for the commit_author_email_pattern rule.

Input fields for `CommitAuthorEmailPatternParametersInput`

Name	Description
`name` (`String`)	How this rule will appear to users.
`negate` (`Boolean`)	If true, the rule will fail if the pattern matches.
`operator` (`String!`)	The operator to use for matching.
`pattern` (`String!`)	The pattern to match with.

CommitContributionOrder

Ordering options for commit contribution connections.

Input fields for `CommitContributionOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`CommitContributionOrderField!`)	The field by which to order commit contributions.

CommitMessage

A message to include with a new commit.

Input fields for `CommitMessage`

Name	Description
`body` (`String`)	The body of the message.
`headline` (`String!`)	The headline of the message.

CommitMessagePatternParametersInput

Parameters to be used for the commit_message_pattern rule.

Input fields for `CommitMessagePatternParametersInput`

Name	Description
`name` (`String`)	How this rule will appear to users.
`negate` (`Boolean`)	If true, the rule will fail if the pattern matches.
`operator` (`String!`)	The operator to use for matching.
`pattern` (`String!`)	The pattern to match with.

CommittableBranch

A git ref for a commit to be appended to.

The ref must be a branch, i.e. its fully qualified name must start with refs/heads/ (although the input is not required to be fully qualified).

The Ref may be specified by its global node ID or by the repositoryNameWithOwner and branchName.

Examples

Specify a branch using a global node ID:

{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }

Specify a branch using repositoryNameWithOwner and branchName:

{
  "repositoryNameWithOwner": "github/graphql-client",
  "branchName": "main"
}.

Input fields for `CommittableBranch`

Name	Description
`branchName` (`String`)	The unqualified name of the branch to append the commit to.
`id` (`ID`)	The Node ID of the Ref to be updated.
`repositoryNameWithOwner` (`String`)	The nameWithOwner of the repository to commit to.

CommitterEmailPatternParametersInput

Parameters to be used for the committer_email_pattern rule.

Input fields for `CommitterEmailPatternParametersInput`

Name	Description
`name` (`String`)	How this rule will appear to users.
`negate` (`Boolean`)	If true, the rule will fail if the pattern matches.
`operator` (`String!`)	The operator to use for matching.
`pattern` (`String!`)	The pattern to match with.

ContributionOrder

Ordering options for contribution connections.

Input fields for `ContributionOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.

ConvertProjectCardNoteToIssueInput

Autogenerated input type of ConvertProjectCardNoteToIssue.

Input fields for `ConvertProjectCardNoteToIssueInput`

Name	Description
`body` (`String`)	The body of the newly created issue.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`projectCardId` (`ID!`)	The ProjectCard ID to convert.
`repositoryId` (`ID!`)	The ID of the repository to create the issue in.
`title` (`String`)	The title of the newly created issue. Defaults to the card's note text.

ConvertProjectV2DraftIssueItemToIssueInput

Autogenerated input type of ConvertProjectV2DraftIssueItemToIssue.

Input fields for `ConvertProjectV2DraftIssueItemToIssueInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`itemId` (`ID!`)	The ID of the draft issue ProjectV2Item to convert.
`repositoryId` (`ID!`)	The ID of the repository to create the issue in.

ConvertPullRequestToDraftInput

Autogenerated input type of ConvertPullRequestToDraft.

Input fields for `ConvertPullRequestToDraftInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`pullRequestId` (`ID!`)	ID of the pull request to convert to draft.

CopyProjectV2Input

Autogenerated input type of CopyProjectV2.

Input fields for `CopyProjectV2Input`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`includeDraftIssues` (`Boolean`)	Include draft issues in the new project.
`ownerId` (`ID!`)	The owner ID of the new project.
`projectId` (`ID!`)	The ID of the source Project to copy.
`title` (`String!`)	The title of the project.

CreateAttributionInvitationInput

Autogenerated input type of CreateAttributionInvitation.

Input fields for `CreateAttributionInvitationInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`ownerId` (`ID!`)	The Node ID of the owner scoping the reattributable data.
`sourceId` (`ID!`)	The Node ID of the account owning the data to reattribute.
`targetId` (`ID!`)	The Node ID of the account which may claim the data.

CreateBranchProtectionRuleInput

Autogenerated input type of CreateBranchProtectionRule.

Input fields for `CreateBranchProtectionRuleInput`

Name	Description
`allowsDeletions` (`Boolean`)	Can this branch be deleted.
`allowsForcePushes` (`Boolean`)	Are force pushes allowed on this branch.
`blocksCreations` (`Boolean`)	Is branch creation a protected operation.
`bypassForcePushActorIds` (`[ID!]`)	A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.
`bypassPullRequestActorIds` (`[ID!]`)	A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`dismissesStaleReviews` (`Boolean`)	Will new commits pushed to matching branches dismiss pull request review approvals.
`isAdminEnforced` (`Boolean`)	Can admins override branch protection.
`lockAllowsFetchAndMerge` (`Boolean`)	Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.
`lockBranch` (`Boolean`)	Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
`pattern` (`String!`)	The glob-like pattern used to determine matching branches.
`pushActorIds` (`[ID!]`)	A list of User, Team, or App IDs allowed to push to matching branches.
`repositoryId` (`ID!`)	The global relay id of the repository in which a new branch protection rule should be created in.
`requireLastPushApproval` (`Boolean`)	Whether the most recent push must be approved by someone other than the person who pushed it.
`requiredApprovingReviewCount` (`Int`)	Number of approving reviews required to update matching branches.
`requiredDeploymentEnvironments` (`[String!]`)	The list of required deployment environments.
`requiredStatusCheckContexts` (`[String!]`)	List of required status check contexts that must pass for commits to be accepted to matching branches.
`requiredStatusChecks` (`[RequiredStatusCheckInput!]`)	The list of required status checks.
`requiresApprovingReviews` (`Boolean`)	Are approving reviews required to update matching branches.
`requiresCodeOwnerReviews` (`Boolean`)	Are reviews from code owners required to update matching branches.
`requiresCommitSignatures` (`Boolean`)	Are commits required to be signed.
`requiresConversationResolution` (`Boolean`)	Are conversations required to be resolved before merging.
`requiresDeployments` (`Boolean`)	Are successful deployments required before merging.
`requiresLinearHistory` (`Boolean`)	Are merge commits prohibited from being pushed to this branch.
`requiresStatusChecks` (`Boolean`)	Are status checks required to update matching branches.
`requiresStrictStatusChecks` (`Boolean`)	Are branches required to be up to date before merging.
`restrictsPushes` (`Boolean`)	Is pushing to matching branches restricted.
`restrictsReviewDismissals` (`Boolean`)	Is dismissal of pull request reviews restricted.
`reviewDismissalActorIds` (`[ID!]`)	A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

CreateCheckRunInput

Autogenerated input type of CreateCheckRun.

Input fields for `CreateCheckRunInput`

Name	Description
`actions` (`[CheckRunAction!]`)	Possible further actions the integrator can perform, which a user may trigger.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`completedAt` (`DateTime`)	The time that the check run finished.
`conclusion` (`CheckConclusionState`)	The final conclusion of the check.
`detailsUrl` (`URI`)	The URL of the integrator's site that has the full details of the check.
`externalId` (`String`)	A reference for the run on the integrator's system.
`headSha` (`GitObjectID!`)	The SHA of the head commit.
`name` (`String!`)	The name of the check.
`output` (`CheckRunOutput`)	Descriptive details about the run.
`repositoryId` (`ID!`)	The node ID of the repository.
`startedAt` (`DateTime`)	The time that the check run began.
`status` (`RequestableCheckStatusState`)	The current status.

CreateCheckSuiteInput

Autogenerated input type of CreateCheckSuite.

Input fields for `CreateCheckSuiteInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`headSha` (`GitObjectID!`)	The SHA of the head commit.
`repositoryId` (`ID!`)	The Node ID of the repository.

CreateCommitOnBranchInput

Autogenerated input type of CreateCommitOnBranch.

Input fields for `CreateCommitOnBranchInput`

Name	Description
`branch` (`CommittableBranch!`)	The Ref to be updated. Must be a branch.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`expectedHeadOid` (`GitObjectID!`)	The git commit oid expected at the head of the branch prior to the commit.
`fileChanges` (`FileChanges`)	A description of changes to files in this commit.
`message` (`CommitMessage!`)	The commit message the be included with the commit.

CreateDeploymentInput

Autogenerated input type of CreateDeployment.

Input fields for `CreateDeploymentInput`

Name	Description
`autoMerge` (`Boolean`)	Attempt to automatically merge the default branch into the requested ref, defaults to true.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`description` (`String`)	Short description of the deployment.
`environment` (`String`)	Name for the target deployment environment.
`payload` (`String`)	JSON payload with extra information about the deployment.
`refId` (`ID!`)	The node ID of the ref to be deployed.
`repositoryId` (`ID!`)	The node ID of the repository.
`requiredContexts` (`[String!]`)	The status contexts to verify against commit status checks. To bypass required contexts, pass an empty array. Defaults to all unique contexts.
`task` (`String`)	Specifies a task to execute.

CreateDeploymentStatusInput

Autogenerated input type of CreateDeploymentStatus.

Input fields for `CreateDeploymentStatusInput`

Name	Description
`autoInactive` (`Boolean`)	Adds a new inactive status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`deploymentId` (`ID!`)	The node ID of the deployment.
`description` (`String`)	A short description of the status. Maximum length of 140 characters.
`environment` (`String`)	If provided, updates the environment of the deploy. Otherwise, does not modify the environment.
`environmentUrl` (`String`)	Sets the URL for accessing your environment.
`logUrl` (`String`)	The log URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
`state` (`DeploymentStatusState!`)	The state of the deployment.

CreateDiscussionInput

Autogenerated input type of CreateDiscussion.

Input fields for `CreateDiscussionInput`

Name	Description
`body` (`String!`)	The body of the discussion.
`categoryId` (`ID!`)	The id of the discussion category to associate with this discussion.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`repositoryId` (`ID!`)	The id of the repository on which to create the discussion.
`title` (`String!`)	The title of the discussion.

CreateEnterpriseOrganizationInput

Autogenerated input type of CreateEnterpriseOrganization.

Input fields for `CreateEnterpriseOrganizationInput`

Name	Description
`adminLogins` (`[String!]!`)	The logins for the administrators of the new organization.
`billingEmail` (`String!`)	The email used for sending billing receipts.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enterpriseId` (`ID!`)	The ID of the enterprise owning the new organization.
`login` (`String!`)	The login of the new organization.
`profileName` (`String!`)	The profile name of the new organization.

CreateEnvironmentInput

Autogenerated input type of CreateEnvironment.

Input fields for `CreateEnvironmentInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`name` (`String!`)	The name of the environment.
`repositoryId` (`ID!`)	The node ID of the repository.

CreateIpAllowListEntryInput

Autogenerated input type of CreateIpAllowListEntry.

Input fields for `CreateIpAllowListEntryInput`

Name	Description
`allowListValue` (`String!`)	An IP address or range of addresses in CIDR notation.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`isActive` (`Boolean!`)	Whether the IP allow list entry is active when an IP allow list is enabled.
`name` (`String`)	An optional name for the IP allow list entry.
`ownerId` (`ID!`)	The ID of the owner for which to create the new IP allow list entry.

CreateIssueInput

Autogenerated input type of CreateIssue.

Input fields for `CreateIssueInput`

Name	Description
`assigneeIds` (`[ID!]`)	The Node ID of assignees for this issue.
`body` (`String`)	The body for the issue description.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`issueTemplate` (`String`)	The name of an issue template in the repository, assigns labels and assignees from the template to the issue.
`issueTypeId` (`ID`)	The Node ID of the issue type for this issue.
`labelIds` (`[ID!]`)	An array of Node IDs of labels for this issue.
`milestoneId` (`ID`)	The Node ID of the milestone for this issue.
`parentIssueId` (`ID`)	The Node ID of the parent issue to add this new issue to.
`projectIds` (`[ID!]`)	An array of Node IDs for projects associated with this issue.
`repositoryId` (`ID!`)	The Node ID of the repository.
`title` (`String!`)	The title for the issue.

CreateIssueTypeInput

Autogenerated input type of CreateIssueType.

Input fields for `CreateIssueTypeInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`color` (`IssueTypeColor`)	Color for the issue type.
`description` (`String`)	Description of the new issue type.
`isEnabled` (`Boolean!`)	Whether or not the issue type is enabled on the org level.
`name` (`String!`)	Name of the new issue type.
`ownerId` (`ID!`)	The ID for the organization on which the issue type is created.

CreateLabelInput

Autogenerated input type of CreateLabel.

Input fields for `CreateLabelInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`color` (`String!`)	A 6 character hex code, without the leading #, identifying the color of the label.
`description` (`String`)	A brief description of the label, such as its purpose.
`name` (`String!`)	The name of the label.
`repositoryId` (`ID!`)	The Node ID of the repository.

CreateLinkedBranchInput

Autogenerated input type of CreateLinkedBranch.

Input fields for `CreateLinkedBranchInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`issueId` (`ID!`)	ID of the issue to link to.
`name` (`String`)	The name of the new branch. Defaults to issue number and title.
`oid` (`GitObjectID!`)	The commit SHA to base the new branch on.
`repositoryId` (`ID`)	ID of the repository to create the branch in. Defaults to the issue repository.

CreateMigrationSourceInput

Autogenerated input type of CreateMigrationSource.

Input fields for `CreateMigrationSourceInput`

Name	Description
`accessToken` (`String`)	The migration source access token.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`githubPat` (`String`)	The GitHub personal access token of the user importing to the target repository.
`name` (`String!`)	The migration source name.
`ownerId` (`ID!`)	The ID of the organization that will own the migration source.
`type` (`MigrationSourceType!`)	The migration source type.
`url` (`String`)	The migration source URL, for example `https://github.com` or `https://monalisa.ghe.com`.

CreateProjectInput

Autogenerated input type of CreateProject.

Input fields for `CreateProjectInput`

Name	Description
`body` (`String`)	The description of project.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`name` (`String!`)	The name of project.
`ownerId` (`ID!`)	The owner ID to create the project under.
`repositoryIds` (`[ID!]`)	A list of repository IDs to create as linked repositories for the project.
`template` (`ProjectTemplate`)	The name of the GitHub-provided template.

CreateProjectV2FieldInput

Autogenerated input type of CreateProjectV2Field.

Input fields for `CreateProjectV2FieldInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`dataType` (`ProjectV2CustomFieldType!`)	The data type of the field.
`iterationConfiguration` (`ProjectV2IterationFieldConfigurationInput`)	Configuration for an iteration field.
`name` (`String!`)	The name of the field.
`projectId` (`ID!`)	The ID of the Project to create the field in.
`singleSelectOptions` (`[ProjectV2SingleSelectFieldOptionInput!]`)	Options for a single select field. At least one value is required if data_type is SINGLE_SELECT.

CreateProjectV2Input

Autogenerated input type of CreateProjectV2.

Input fields for `CreateProjectV2Input`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`ownerId` (`ID!`)	The owner ID to create the project under.
`repositoryId` (`ID`)	The repository to link the project to.
`teamId` (`ID`)	The team to link the project to. The team will be granted read permissions.
`title` (`String!`)	The title of the project.

CreateProjectV2StatusUpdateInput

Autogenerated input type of CreateProjectV2StatusUpdate.

Input fields for `CreateProjectV2StatusUpdateInput`

Name	Description
`body` (`String`)	The body of the status update.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`projectId` (`ID!`)	The ID of the Project to create the status update in.
`startDate` (`Date`)	The start date of the status update.
`status` (`ProjectV2StatusUpdateStatus`)	The status of the status update.
`targetDate` (`Date`)	The target date of the status update.

CreatePullRequestInput

Autogenerated input type of CreatePullRequest.

Input fields for `CreatePullRequestInput`

Name	Description
`baseRefName` (`String!`)	The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
`body` (`String`)	The contents of the pull request.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`draft` (`Boolean`)	Indicates whether this pull request should be a draft.
`headRefName` (`String!`)	The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head_ref_name` with a user like this: `username:branch`.
`headRepositoryId` (`ID`)	The Node ID of the head repository.
`maintainerCanModify` (`Boolean`)	Indicates whether maintainers can modify the pull request.
`repositoryId` (`ID!`)	The Node ID of the repository.
`title` (`String!`)	The title of the pull request.

CreateRefInput

Autogenerated input type of CreateRef.

Input fields for `CreateRefInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`name` (`String!`)	The fully qualified name of the new Ref (ie: `refs/heads/my_new_branch`).
`oid` (`GitObjectID!`)	The GitObjectID that the new Ref shall target. Must point to a commit.
`repositoryId` (`ID!`)	The Node ID of the Repository to create the Ref in.

CreateRepositoryInput

Autogenerated input type of CreateRepository.

Input fields for `CreateRepositoryInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`description` (`String`)	A short description of the new repository.
`hasIssuesEnabled` (`Boolean`)	Indicates if the repository should have the issues feature enabled.
`hasWikiEnabled` (`Boolean`)	Indicates if the repository should have the wiki feature enabled.
`homepageUrl` (`URI`)	The URL for a web page about this repository.
`name` (`String!`)	The name of the new repository.
`ownerId` (`ID`)	The ID of the owner for the new repository.
`teamId` (`ID`)	When an organization is specified as the owner, this ID identifies the team that should be granted access to the new repository.
`template` (`Boolean`)	Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure.
`visibility` (`RepositoryVisibility!`)	Indicates the repository's visibility level.

CreateRepositoryRulesetInput

Autogenerated input type of CreateRepositoryRuleset.

Input fields for `CreateRepositoryRulesetInput`

Name	Description
`bypassActors` (`[RepositoryRulesetBypassActorInput!]`)	A list of actors that are allowed to bypass rules in this ruleset.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`conditions` (`RepositoryRuleConditionsInput!`)	The set of conditions for this ruleset.
`enforcement` (`RuleEnforcement!`)	The enforcement level for this ruleset.
`name` (`String!`)	The name of the ruleset.
`rules` (`[RepositoryRuleInput!]`)	The list of rules for this ruleset.
`sourceId` (`ID!`)	The global relay id of the source in which a new ruleset should be created in.
`target` (`RepositoryRulesetTarget`)	The target of the ruleset.

CreateSponsorsListingInput

Autogenerated input type of CreateSponsorsListing.

Input fields for `CreateSponsorsListingInput`

Name	Description
`billingCountryOrRegionCode` (`SponsorsCountryOrRegionCode`)	The country or region where the sponsorable's bank account is located. Required if fiscalHostLogin is not specified, ignored when fiscalHostLogin is specified.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`contactEmail` (`String`)	The email address we should use to contact you about the GitHub Sponsors profile being created. This will not be shared publicly. Must be a verified email address already on your GitHub account. Only relevant when the sponsorable is yourself. Defaults to your primary email address on file if omitted.
`fiscalHostLogin` (`String`)	The username of the supported fiscal host's GitHub organization, if you want to receive sponsorship payouts through a fiscal host rather than directly to a bank account. For example,`Open-Source-Collective`for Open Source Collective or 'numfocus' for numFOCUS. Case insensitive. See https://docs.github.com/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts for more information.
`fiscallyHostedProjectProfileUrl` (`String`)	The URL for your profile page on the fiscal host's website, e.g., https://opencollective.com/babel or https://numfocus.org/project/bokeh. Required if fiscalHostLogin is specified.
`fullDescription` (`String`)	Provide an introduction to serve as the main focus that appears on your GitHub Sponsors profile. It's a great opportunity to help potential sponsors learn more about you, your work, and why their sponsorship is important to you. GitHub-flavored Markdown is supported.
`residenceCountryOrRegionCode` (`SponsorsCountryOrRegionCode`)	The country or region where the sponsorable resides. This is for tax purposes. Required if the sponsorable is yourself, ignored when sponsorableLogin specifies an organization.
`sponsorableLogin` (`String`)	The username of the organization to create a GitHub Sponsors profile for, if desired. Defaults to creating a GitHub Sponsors profile for the authenticated user if omitted.

CreateSponsorsTierInput

Autogenerated input type of CreateSponsorsTier.

Input fields for `CreateSponsorsTierInput`

Name	Description
`amount` (`Int!`)	The value of the new tier in US dollars. Valid values: 1-12000.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`description` (`String!`)	A description of what this tier is, what perks sponsors might receive, what a sponsorship at this tier means for you, etc.
`isRecurring` (`Boolean`)	Whether sponsorships using this tier should happen monthly/yearly or just once.
`publish` (`Boolean`)	Whether to make the tier available immediately for sponsors to choose. Defaults to creating a draft tier that will not be publicly visible.
`repositoryId` (`ID`)	Optional ID of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization.
`repositoryName` (`String`)	Optional name of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. Necessary if repositoryOwnerLogin is given. Will be ignored if repositoryId is given.
`repositoryOwnerLogin` (`String`)	Optional login of the organization owner of the private repository that sponsors at this tier should gain read-only access to. Necessary if repositoryName is given. Will be ignored if repositoryId is given.
`sponsorableId` (`ID`)	The ID of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableLogin is not given.
`sponsorableLogin` (`String`)	The username of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableId is not given.
`welcomeMessage` (`String`)	Optional message new sponsors at this tier will receive.

CreateSponsorshipInput

Autogenerated input type of CreateSponsorship.

Input fields for `CreateSponsorshipInput`

Name	Description
`amount` (`Int`)	The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`isRecurring` (`Boolean`)	Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.
`privacyLevel` (`SponsorshipPrivacy`)	Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used.
`receiveEmails` (`Boolean`)	Whether the sponsor should receive email updates from the sponsorable.
`sponsorId` (`ID`)	The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given.
`sponsorLogin` (`String`)	The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given.
`sponsorableId` (`ID`)	The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.
`sponsorableLogin` (`String`)	The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.
`tierId` (`ID`)	The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.

CreateSponsorshipsInput

Autogenerated input type of CreateSponsorships.

Input fields for `CreateSponsorshipsInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`privacyLevel` (`SponsorshipPrivacy`)	Specify whether others should be able to see that the sponsor is sponsoring the sponsorables. Public visibility still does not reveal the dollar value of the sponsorship.
`receiveEmails` (`Boolean`)	Whether the sponsor should receive email updates from the sponsorables.
`recurring` (`Boolean`)	Whether the sponsorships created should continue each billing cycle for the sponsor (monthly or annually), versus lasting only a single month. Defaults to one-time sponsorships.
`sponsorLogin` (`String!`)	The username of the user or organization who is acting as the sponsor, paying for the sponsorships.
`sponsorships` (`[BulkSponsorship!]!`)	The list of maintainers to sponsor and for how much apiece.

CreateTeamDiscussionCommentInput

Autogenerated input type of CreateTeamDiscussionComment.

Input fields for `CreateTeamDiscussionCommentInput`

Name	Description
`body` (`String`)	The content of the comment. This field is required. Upcoming Change on 2024-07-01 UTC Description: `body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`discussionId` (`ID`)	The ID of the discussion to which the comment belongs. This field is required. Upcoming Change on 2024-07-01 UTC Description: `discussionId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

CreateTeamDiscussionInput

Autogenerated input type of CreateTeamDiscussion.

Input fields for `CreateTeamDiscussionInput`

Name	Description
`body` (`String`)	The content of the discussion. This field is required. Upcoming Change on 2024-07-01 UTC Description: `body` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`private` (`Boolean`)	If true, restricts the visibility of this discussion to team members and organization owners. If false or not specified, allows any organization member to view this discussion. Upcoming Change on 2024-07-01 UTC Description: `private` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
`teamId` (`ID`)	The ID of the team to which the discussion belongs. This field is required. Upcoming Change on 2024-07-01 UTC Description: `teamId` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.
`title` (`String`)	The title of the discussion. This field is required. Upcoming Change on 2024-07-01 UTC Description: `title` will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

CreateUserListInput

Autogenerated input type of CreateUserList.

Input fields for `CreateUserListInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`description` (`String`)	A description of the list.
`isPrivate` (`Boolean`)	Whether or not the list is private.
`name` (`String!`)	The name of the new list.

DeclineTopicSuggestionInput

Autogenerated input type of DeclineTopicSuggestion.

Input fields for `DeclineTopicSuggestionInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`name` (`String`)	The name of the suggested topic. Upcoming Change on 2024-04-01 UTC Description: `name` will be removed. Reason: Suggested topics are no longer supported.
`reason` (`TopicSuggestionDeclineReason`)	The reason why the suggested topic is declined. Upcoming Change on 2024-04-01 UTC Description: `reason` will be removed. Reason: Suggested topics are no longer supported.
`repositoryId` (`ID`)	The Node ID of the repository. Upcoming Change on 2024-04-01 UTC Description: `repositoryId` will be removed. Reason: Suggested topics are no longer supported.

DeleteBranchProtectionRuleInput

Autogenerated input type of DeleteBranchProtectionRule.

Input fields for `DeleteBranchProtectionRuleInput`

Name	Description
`branchProtectionRuleId` (`ID!`)	The global relay id of the branch protection rule to be deleted.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.

DeleteDeploymentInput

Autogenerated input type of DeleteDeployment.

Input fields for `DeleteDeploymentInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The Node ID of the deployment to be deleted.

DeleteDiscussionCommentInput

Autogenerated input type of DeleteDiscussionComment.

Input fields for `DeleteDiscussionCommentInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The Node id of the discussion comment to delete.

DeleteDiscussionInput

Autogenerated input type of DeleteDiscussion.

Input fields for `DeleteDiscussionInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The id of the discussion to delete.

DeleteEnvironmentInput

Autogenerated input type of DeleteEnvironment.

Input fields for `DeleteEnvironmentInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The Node ID of the environment to be deleted.

DeleteIpAllowListEntryInput

Autogenerated input type of DeleteIpAllowListEntry.

Input fields for `DeleteIpAllowListEntryInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`ipAllowListEntryId` (`ID!`)	The ID of the IP allow list entry to delete.

DeleteIssueCommentInput

Autogenerated input type of DeleteIssueComment.

Input fields for `DeleteIssueCommentInput`

Name	Description
`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.

Input fields for `DeleteIssueInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`issueId` (`ID!`)	The ID of the issue to delete.

DeleteIssueTypeInput

Autogenerated input type of DeleteIssueType.

Input fields for `DeleteIssueTypeInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`issueTypeId` (`ID!`)	The ID of the issue type to delete.

DeleteLabelInput

Autogenerated input type of DeleteLabel.

Input fields for `DeleteLabelInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The Node ID of the label to be deleted.

DeleteLinkedBranchInput

Autogenerated input type of DeleteLinkedBranch.

Input fields for `DeleteLinkedBranchInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`linkedBranchId` (`ID!`)	The ID of the linked branch.

DeletePackageVersionInput

Autogenerated input type of DeletePackageVersion.

Input fields for `DeletePackageVersionInput`

Name	Description
`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.

Input fields for `DeleteProjectCardInput`

Name	Description
`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.

Input fields for `DeleteProjectColumnInput`

Name	Description
`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.

Input fields for `DeleteProjectInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`projectId` (`ID!`)	The Project ID to update.

DeleteProjectV2FieldInput

Autogenerated input type of DeleteProjectV2Field.

Input fields for `DeleteProjectV2FieldInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`fieldId` (`ID!`)	The ID of the field to delete.

DeleteProjectV2Input

Autogenerated input type of DeleteProjectV2.

Input fields for `DeleteProjectV2Input`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`projectId` (`ID!`)	The ID of the Project to delete.

DeleteProjectV2ItemInput

Autogenerated input type of DeleteProjectV2Item.

Input fields for `DeleteProjectV2ItemInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`itemId` (`ID!`)	The ID of the item to be removed.
`projectId` (`ID!`)	The ID of the Project from which the item should be removed.

DeleteProjectV2StatusUpdateInput

Autogenerated input type of DeleteProjectV2StatusUpdate.

Input fields for `DeleteProjectV2StatusUpdateInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`statusUpdateId` (`ID!`)	The ID of the status update to be removed.

DeleteProjectV2WorkflowInput

Autogenerated input type of DeleteProjectV2Workflow.

Input fields for `DeleteProjectV2WorkflowInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`workflowId` (`ID!`)	The ID of the workflow to be removed.

DeletePullRequestReviewCommentInput

Autogenerated input type of DeletePullRequestReviewComment.

Input fields for `DeletePullRequestReviewCommentInput`

Name	Description
`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.

Input fields for `DeletePullRequestReviewInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`pullRequestReviewId` (`ID!`)	The Node ID of the pull request review to delete.

DeleteRefInput

Autogenerated input type of DeleteRef.

Input fields for `DeleteRefInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`refId` (`ID!`)	The Node ID of the Ref to be deleted.

DeleteRepositoryRulesetInput

Autogenerated input type of DeleteRepositoryRuleset.

Input fields for `DeleteRepositoryRulesetInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`repositoryRulesetId` (`ID!`)	The global relay id of the repository ruleset to be deleted.

DeleteTeamDiscussionCommentInput

Autogenerated input type of DeleteTeamDiscussionComment.

Input fields for `DeleteTeamDiscussionCommentInput`

Name	Description
`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.

Input fields for `DeleteTeamDiscussionInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The discussion ID to delete.

DeleteUserListInput

Autogenerated input type of DeleteUserList.

Input fields for `DeleteUserListInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`listId` (`ID!`)	The ID of the list to delete.

DeleteVerifiableDomainInput

Autogenerated input type of DeleteVerifiableDomain.

Input fields for `DeleteVerifiableDomainInput`

Name	Description
`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.

Input fields for `DeploymentOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`DeploymentOrderField!`)	The field to order deployments by.

DequeuePullRequestInput

Autogenerated input type of DequeuePullRequest.

Input fields for `DequeuePullRequestInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The ID of the pull request to be dequeued.

DisablePullRequestAutoMergeInput

Autogenerated input type of DisablePullRequestAutoMerge.

Input fields for `DisablePullRequestAutoMergeInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`pullRequestId` (`ID!`)	ID of the pull request to disable auto merge on.

DiscussionOrder

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

Input fields for `DiscussionOrder`

Name	Description
`direction` (`OrderDirection!`)	The direction in which to order discussions by the specified field.
`field` (`DiscussionOrderField!`)	The field by which to order discussions.

DiscussionPollOptionOrder

Ordering options for discussion poll option connections.

Input fields for `DiscussionPollOptionOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`DiscussionPollOptionOrderField!`)	The field to order poll options by.

DismissPullRequestReviewInput

Autogenerated input type of DismissPullRequestReview.

Input fields for `DismissPullRequestReviewInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`message` (`String!`)	The contents of the pull request review dismissal message.
`pullRequestReviewId` (`ID!`)	The Node ID of the pull request review to modify.

DismissRepositoryVulnerabilityAlertInput

Autogenerated input type of DismissRepositoryVulnerabilityAlert.

Input fields for `DismissRepositoryVulnerabilityAlertInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`dismissReason` (`DismissReason!`)	The reason the Dependabot alert is being dismissed.
`repositoryVulnerabilityAlertId` (`ID!`)	The Dependabot alert ID to dismiss.

DraftPullRequestReviewComment

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

Input fields for `DraftPullRequestReviewComment`

Name	Description
`body` (`String!`)	Body of the comment to leave.
`path` (`String!`)	Path to the file being commented on.
`position` (`Int!`)	Position in the file to leave a comment on.

DraftPullRequestReviewThread

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

Input fields for `DraftPullRequestReviewThread`

Name	Description
`body` (`String!`)	Body of the comment to leave.
`line` (`Int`)	The line of the blob to which the thread refers. The end of the line range for multi-line comments. Required if not using positioning.
`path` (`String`)	Path to the file being commented on. Required if not using positioning.
`side` (`DiffSide`)	The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
`startLine` (`Int`)	The first line of the range to which the comment refers.
`startSide` (`DiffSide`)	The side of the diff on which the start line resides.

EnablePullRequestAutoMergeInput

Autogenerated input type of EnablePullRequestAutoMerge.

Input fields for `EnablePullRequestAutoMergeInput`

Name	Description
`authorEmail` (`String`)	The email address to associate with this merge.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`commitBody` (`String`)	Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit message is ignored.
`commitHeadline` (`String`)	Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit headline is ignored.
`expectedHeadOid` (`GitObjectID`)	The expected head OID of the pull request.
`mergeMethod` (`PullRequestMergeMethod`)	The merge method to use. If omitted, defaults to `MERGE`. NOTE: when merging with a merge queue any input value for merge method is ignored.
`pullRequestId` (`ID!`)	ID of the pull request to enable auto-merge on.

EnqueuePullRequestInput

Autogenerated input type of EnqueuePullRequest.

Input fields for `EnqueuePullRequestInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`expectedHeadOid` (`GitObjectID`)	The expected head OID of the pull request.
`jump` (`Boolean`)	Add the pull request to the front of the queue.
`pullRequestId` (`ID!`)	The ID of the pull request to enqueue.

EnterpriseAdministratorInvitationOrder

Ordering options for enterprise administrator invitation connections.

Input fields for `EnterpriseAdministratorInvitationOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`EnterpriseAdministratorInvitationOrderField!`)	The field to order enterprise administrator invitations by.

EnterpriseMemberInvitationOrder

Ordering options for enterprise administrator invitation connections.

Input fields for `EnterpriseMemberInvitationOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`EnterpriseMemberInvitationOrderField!`)	The field to order enterprise member invitations by.

EnterpriseMemberOrder

Ordering options for enterprise member connections.

Input fields for `EnterpriseMemberOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`EnterpriseMemberOrderField!`)	The field to order enterprise members by.

EnterpriseOrder

Ordering options for enterprises.

Input fields for `EnterpriseOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`EnterpriseOrderField!`)	The field to order enterprises by.

EnterpriseServerInstallationOrder

Ordering options for Enterprise Server installation connections.

Input fields for `EnterpriseServerInstallationOrder`

Name	Description
`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.

Input fields for `EnterpriseServerUserAccountEmailOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`EnterpriseServerUserAccountEmailOrderField!`)	The field to order emails by.

EnterpriseServerUserAccountOrder

Ordering options for Enterprise Server user account connections.

Input fields for `EnterpriseServerUserAccountOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`EnterpriseServerUserAccountOrderField!`)	The field to order user accounts by.

EnterpriseServerUserAccountsUploadOrder

Ordering options for Enterprise Server user accounts upload connections.

Input fields for `EnterpriseServerUserAccountsUploadOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`EnterpriseServerUserAccountsUploadOrderField!`)	The field to order user accounts uploads by.

Environments

Ordering options for environments.

Input fields for `Environments`

Name	Description
`direction` (`OrderDirection!`)	The direction in which to order environments by the specified field.
`field` (`EnvironmentOrderField!`)	The field to order environments by.

FileAddition

A command to add a file at the given path with the given contents as part of a commit. Any existing file at that that path will be replaced.

Input fields for `FileAddition`

Name	Description
`contents` (`Base64String!`)	The base64 encoded contents of the file.
`path` (`String!`)	The path in the repository where the file will be located.

FileChanges

A description of a set of changes to a file tree to be made as part of a git commit, modeled as zero or more file additions and zero or more file deletions.

Both fields are optional; omitting both will produce a commit with no file changes.

deletions and additions describe changes to files identified by their path in the git tree using unix-style path separators, i.e. /. The root of a git tree is an empty string, so paths are not slash-prefixed.

path values must be unique across all additions and deletions provided. Any duplication will result in a validation error.

Encoding

File contents must be provided in full for each FileAddition.

The contents of a FileAddition must be encoded using RFC 4648 compliant base64, i.e. correct padding is required and no characters outside the standard alphabet may be used. Invalid base64 encoding will be rejected with a validation error.

The encoded contents may be binary.

For text files, no assumptions are made about the character encoding of the file contents (after base64 decoding). No charset transcoding or line-ending normalization will be performed; it is the client's responsibility to manage the character encoding of files they provide. However, for maximum compatibility we recommend using UTF-8 encoding and ensuring that all files in a repository use a consistent line-ending convention (\n or \r\n), and that all files end with a newline.

Modeling file changes

Each of the the five types of conceptual changes that can be made in a git commit can be described using the FileChanges type as follows:

New file addition: create file hello world\n at path docs/README.txt:

{
  "additions" [
    {
      "path": "docs/README.txt",
      "contents": base64encode("hello world\n")
    }
  ]
}

Existing file modification: change existing docs/README.txt to have new content new content here\n:

{
  "additions" [
    {
      "path": "docs/README.txt",
      "contents": base64encode("new content here\n")
    }
  ]
}

Existing file deletion: remove existing file docs/README.txt. Note that the path is required to exist -- specifying a path that does not exist on the given branch will abort the commit and return an error.
```
{
  "deletions" [
    {
      "path": "docs/README.txt"
    }
  ]
}
```

File rename with no changes: rename docs/README.txt with previous content hello world\n to the same content at newdocs/README.txt:

{
  "deletions" [
    {
      "path": "docs/README.txt",
    }
  ],
  "additions" [
    {
      "path": "newdocs/README.txt",
      "contents": base64encode("hello world\n")
    }
  ]
}

File rename with changes: rename docs/README.txt with previous content hello world\n to a file at path newdocs/README.txt with content new contents\n:

{
  "deletions" [
    {
      "path": "docs/README.txt",
    }
  ],
  "additions" [
    {
      "path": "newdocs/README.txt",
      "contents": base64encode("new contents\n")
    }
  ]
}.

Input fields for `FileChanges`

Name	Description
`additions` (`[FileAddition!]`)	File to add or change.
`deletions` (`[FileDeletion!]`)	Files to delete.

FileDeletion

A command to delete the file at the given path as part of a commit.

Input fields for `FileDeletion`

Name	Description
`path` (`String!`)	The path to delete.

FileExtensionRestrictionParametersInput

Prevent commits that include files with specified file extensions from being pushed to the commit graph.

Input fields for `FileExtensionRestrictionParametersInput`

Name	Description
`restrictedFileExtensions` (`[String!]!`)	The file extensions that are restricted from being pushed to the commit graph.

FilePathRestrictionParametersInput

Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.

Input fields for `FilePathRestrictionParametersInput`

Name	Description
`restrictedFilePaths` (`[String!]!`)	The file paths that are restricted from being pushed to the commit graph.

FollowOrganizationInput

Autogenerated input type of FollowOrganization.

Input fields for `FollowOrganizationInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`organizationId` (`ID!`)	ID of the organization to follow.

FollowUserInput

Autogenerated input type of FollowUser.

Input fields for `FollowUserInput`

Name	Description
`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.

Input fields for `GistOrder`

Name	Description
`direction` (`OrderDirection!`)	The ordering direction.
`field` (`GistOrderField!`)	The field to order repositories by.

GrantEnterpriseOrganizationsMigratorRoleInput

Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.

Input fields for `GrantEnterpriseOrganizationsMigratorRoleInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enterpriseId` (`ID!`)	The ID of the enterprise to which all organizations managed by it will be granted the migrator role.
`login` (`String!`)	The login of the user to grant the migrator role.

GrantMigratorRoleInput

Autogenerated input type of GrantMigratorRole.

Input fields for `GrantMigratorRoleInput`

Name	Description
`actor` (`String!`)	The user login or Team slug to grant the migrator role.
`actorType` (`ActorType!`)	Specifies the type of the actor, can be either USER or TEAM.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`organizationId` (`ID!`)	The ID of the organization that the user/team belongs to.

ImportProjectInput

Autogenerated input type of ImportProject.

Input fields for `ImportProjectInput`

Name	Description
`body` (`String`)	The description of Project.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`columnImports` (`[ProjectColumnImport!]!`)	A list of columns containing issues and pull requests.
`name` (`String!`)	The name of Project.
`ownerName` (`String!`)	The name of the Organization or User to create the Project under.
`public` (`Boolean`)	Whether the Project is public or not.

InviteEnterpriseAdminInput

Autogenerated input type of InviteEnterpriseAdmin.

Input fields for `InviteEnterpriseAdminInput`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`email` (`String`)	The email of the person to invite as an administrator.
`enterpriseId` (`ID!`)	The ID of the enterprise to which you want to invite an administrator.
`invitee` (`String`)	The login of a user to invite as an administrator.
`role` (

Input objects

In this article

Input fields for AbortQueuedMigrationsInput

Input fields for AbortRepositoryMigrationInput

Input fields for AcceptEnterpriseAdministratorInvitationInput

Input fields for AcceptEnterpriseMemberInvitationInput

Input fields for AcceptTopicSuggestionInput

Input fields for AccessUserNamespaceRepositoryInput

Input fields for AddAssigneesToAssignableInput

Input fields for AddBlockedByInput

Input fields for AddCommentInput

Input fields for AddDiscussionCommentInput

Input fields for AddDiscussionPollVoteInput

Input fields for AddEnterpriseOrganizationMemberInput

Input fields for AddEnterpriseSupportEntitlementInput

Input fields for AddLabelsToLabelableInput

Input fields for AddProjectCardInput

Input fields for AddProjectColumnInput

Input fields for AddProjectV2DraftIssueInput

Input fields for AddProjectV2ItemByIdInput

Input fields for AddPullRequestReviewCommentInput

Input fields for AddPullRequestReviewInput

Input fields for AddPullRequestReviewThreadInput

Input fields for AddPullRequestReviewThreadReplyInput

Input fields for AddReactionInput

Input fields for AddStarInput

Input fields for AddSubIssueInput

Input fields for AddUpvoteInput

Input fields for AddVerifiableDomainInput

Input fields for ApproveDeploymentsInput

Input fields for ApproveVerifiableDomainInput

Input fields for ArchiveProjectV2ItemInput

Input fields for ArchiveRepositoryInput

Input fields for AuditLogOrder

Input fields for BranchNamePatternParametersInput

Input fields for BulkSponsorship

Input fields for CancelEnterpriseAdminInvitationInput

Input fields for CancelEnterpriseMemberInvitationInput

Input fields for CancelSponsorshipInput

Input fields for ChangeUserStatusInput

Input fields for CheckAnnotationData

Input fields for CheckAnnotationRange

Input fields for CheckRunAction

Input fields for CheckRunFilter

Input fields for CheckRunOutput

Input fields for CheckRunOutputImage

Input fields for CheckSuiteAutoTriggerPreference

Input fields for CheckSuiteFilter

Input fields for ClearLabelsFromLabelableInput

Input fields for ClearProjectV2ItemFieldValueInput

Input fields for CloneProjectInput

Input fields for CloneTemplateRepositoryInput

Input fields for CloseDiscussionInput

Input fields for CloseIssueInput

Input fields for ClosePullRequestInput

Input fields for CodeScanningParametersInput

Input fields for CodeScanningToolInput

Input fields for CommitAuthor

Input fields for CommitAuthorEmailPatternParametersInput

Input fields for CommitContributionOrder

Input fields for CommitMessage

Input fields for CommitMessagePatternParametersInput

Input fields for CommittableBranch

Input fields for CommitterEmailPatternParametersInput

Input fields for ContributionOrder

Input fields for ConvertProjectCardNoteToIssueInput

Input fields for ConvertProjectV2DraftIssueItemToIssueInput

Input fields for ConvertPullRequestToDraftInput

Input fields for CopyProjectV2Input

Input fields for CreateAttributionInvitationInput

Input fields for CreateBranchProtectionRuleInput

Input fields for CreateCheckRunInput

Input fields for CreateCheckSuiteInput

Input fields for CreateCommitOnBranchInput