Input objects
Input objects can be described as "composable objects" because they include a set of input fields that define the object.
In this article
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 calledemails. Providing a value foremails transformsCommitAuthor into a list ofUser objects containing that email address. Note thatobjectsmay have input objects, whereasmutationsrequire input objects.
For more information, seeForming calls with GraphQL.
AbortQueuedMigrationsInput
Autogenerated input type of AbortQueuedMigrations.
AbortRepositoryMigrationInput
Autogenerated input type of AbortRepositoryMigration.
AcceptEnterpriseAdministratorInvitationInput
Autogenerated input type of AcceptEnterpriseAdministratorInvitation.
AcceptEnterpriseMemberInvitationInput
Autogenerated input type of AcceptEnterpriseMemberInvitation.
AcceptTopicSuggestionInput
Autogenerated input type of AcceptTopicSuggestion.
Input fields forAcceptTopicSuggestionInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The name of the suggested topic. Upcoming Change on 2024-04-01 UTCDescription: |
| The Node ID of the repository. Upcoming Change on 2024-04-01 UTCDescription: |
AccessUserNamespaceRepositoryInput
Autogenerated input type of AccessUserNamespaceRepository.
AddAssigneesToAssignableInput
Autogenerated input type of AddAssigneesToAssignable.
AddCommentInput
Autogenerated input type of AddComment.
AddDiscussionCommentInput
Autogenerated input type of AddDiscussionComment.
Input fields forAddDiscussionCommentInput
| Name | Description |
|---|---|
| The contents of the comment. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion to comment on. |
| The Node ID of the discussion comment within this discussion to reply to. |
AddDiscussionPollVoteInput
Autogenerated input type of AddDiscussionPollVote.
AddEnterpriseOrganizationMemberInput
Autogenerated input type of AddEnterpriseOrganizationMember.
Input fields forAddEnterpriseOrganizationMemberInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise which owns the organization. |
| The ID of the organization the users will be added to. |
| The role to assign the users in the organization. |
| The IDs of the enterprise members to add. |
AddEnterpriseSupportEntitlementInput
Autogenerated input type of AddEnterpriseSupportEntitlement.
AddLabelsToLabelableInput
Autogenerated input type of AddLabelsToLabelable.
AddProjectCardInput
Autogenerated input type of AddProjectCard.
Input fields forAddProjectCardInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The content of the card. Must be a member of the ProjectCardItem union. |
| The note on the card. |
| The Node ID of the ProjectColumn. |
AddProjectColumnInput
Autogenerated input type of AddProjectColumn.
AddProjectV2DraftIssueInput
Autogenerated input type of AddProjectV2DraftIssue.
Input fields forAddProjectV2DraftIssueInput
| Name | Description |
|---|---|
| The IDs of the assignees of the draft issue. |
| The body of the draft issue. |
| A unique identifier for the client performing the mutation. |
| The ID of the Project to add the draft issue to. |
| The title of the draft issue. A project item can also be created by providingthe URL of an Issue or Pull Request if you have access. |
AddProjectV2ItemByIdInput
Autogenerated input type of AddProjectV2ItemById.
AddPullRequestReviewCommentInput
Autogenerated input type of AddPullRequestReviewComment.
Input fields forAddPullRequestReviewCommentInput
| Name | Description |
|---|---|
| The text of the comment. This field is required Upcoming Change on 2023-10-01 UTCDescription: |
| A unique identifier for the client performing the mutation. |
| The SHA of the commit to comment on. Upcoming Change on 2023-10-01 UTCDescription: |
| The comment id to reply to. Upcoming Change on 2023-10-01 UTCDescription: |
| The relative path of the file to comment on. Upcoming Change on 2023-10-01 UTCDescription: |
| The line index in the diff to comment on. Upcoming Change on 2023-10-01 UTCDescription: |
| The node ID of the pull request reviewing Upcoming Change on 2023-10-01 UTCDescription: |
| The Node ID of the review to modify. Upcoming Change on 2023-10-01 UTCDescription: |
AddPullRequestReviewInput
Autogenerated input type of AddPullRequestReview.
Input fields forAddPullRequestReviewInput
| Name | Description |
|---|---|
| The contents of the review body comment. |
| A unique identifier for the client performing the mutation. |
| The review line comments. Upcoming Change on 2023-10-01 UTCDescription: |
| The commit OID the review pertains to. |
| The event to perform on the pull request review. |
| The Node ID of the pull request to modify. |
| The review line comment threads. |
AddPullRequestReviewThreadInput
Autogenerated input type of AddPullRequestReviewThread.
Input fields forAddPullRequestReviewThreadInput
| Name | Description |
|---|---|
| Body of the thread's first comment. |
| A unique identifier for the client performing the mutation. |
| The line of the blob to which the thread refers, required for line-levelthreads. The end of the line range for multi-line comments. |
| Path to the file being commented on. |
| The node ID of the pull request reviewing. |
| The Node ID of the review to modify. |
| The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. |
| The first line of the range to which the comment refers. |
| The side of the diff on which the start line resides. |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
AddPullRequestReviewThreadReplyInput
Autogenerated input type of AddPullRequestReviewThreadReply.
Input fields forAddPullRequestReviewThreadReplyInput
| Name | Description |
|---|---|
| The text of the reply. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the pending review to which the reply will belong. |
| The Node ID of the thread to which this reply is being written. |
AddReactionInput
Autogenerated input type of AddReaction.
Input fields forAddReactionInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The name of the emoji to react with. |
| The Node ID of the subject to modify. |
AddStarInput
Autogenerated input type of AddStar.
AddSubIssueInput
Autogenerated input type of AddSubIssue.
Input fields forAddSubIssueInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The id of the issue. |
| Option to replace parent issue if one already exists. |
| The id of the sub-issue. |
| The url of the sub-issue. |
AddUpvoteInput
Autogenerated input type of AddUpvote.
AddVerifiableDomainInput
Autogenerated input type of AddVerifiableDomain.
ApproveDeploymentsInput
Autogenerated input type of ApproveDeployments.
Input fields forApproveDeploymentsInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Optional comment for approving deployments. |
| The ids of environments to reject deployments. |
| The node ID of the workflow run containing the pending deployments. |
ApproveVerifiableDomainInput
Autogenerated input type of ApproveVerifiableDomain.
ArchiveProjectV2ItemInput
Autogenerated input type of ArchiveProjectV2Item.
ArchiveRepositoryInput
Autogenerated input type of ArchiveRepository.
AuditLogOrder
Ordering options for Audit Log connections.
Input fields forAuditLogOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order Audit Logs by. |
BranchNamePatternParametersInput
Parameters to be used for the branch_name_pattern rule.
BulkSponsorship
Information about a sponsorship to make for a user or organization with a GitHubSponsors profile, as part of sponsoring many users or organizations at once.
Input fields forBulkSponsorship
| Name | Description |
|---|---|
| The amount to pay to the sponsorable in US dollars. Valid values: 1-12000. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. |
CancelEnterpriseAdminInvitationInput
Autogenerated input type of CancelEnterpriseAdminInvitation.
CancelEnterpriseMemberInvitationInput
Autogenerated input type of CancelEnterpriseMemberInvitation.
CancelSponsorshipInput
Autogenerated input type of CancelSponsorship.
Input fields forCancelSponsorshipInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the user or organization who is acting as the sponsor, paying forthe sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, payingfor the sponsorship. Required if sponsorId is not given. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| 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 forChangeUserStatusInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀. |
| If set, the user status will not be shown after this date. |
| Whether this status should indicate you are not fully available on GitHub, e.g., you are away. |
| A short description of your current status. |
| The ID of the organization whose members will be allowed to see the status. Ifomitted, the status will be publicly visible. |
CheckAnnotationData
Information from a check run analysis to specific lines of code.
Input fields forCheckAnnotationData
| Name | Description |
|---|---|
| Represents an annotation's information level. |
| The location of the annotation. |
| A short description of the feedback for these lines of code. |
| The path of the file to add an annotation to. |
| Details about this annotation. |
| The title that represents the annotation. |
CheckAnnotationRange
Information from a check run analysis to specific lines of code.
CheckRunAction
Possible further actions the integrator can perform.
CheckRunFilter
The filters that are available when fetching check runs.
Input fields forCheckRunFilter
| Name | Description |
|---|---|
| Filters the check runs created by this application ID. |
| Filters the check runs by this name. |
| Filters the check runs by this type. |
| Filters the check runs by these conclusions. |
| Filters the check runs by this status. Superceded by statuses. |
| Filters the check runs by this status. Overrides status. |
CheckRunOutput
Descriptive details about the check run.
Input fields forCheckRunOutput
| Name | Description |
|---|---|
| The annotations that are made as part of the check run. |
| Images attached to the check run output displayed in the GitHub pull request UI. |
| The summary of the check run (supports Commonmark). |
| The details of the check run (supports Commonmark). |
| A title to provide for this check run. |
CheckRunOutputImage
Images attached to the check run output displayed in the GitHub pull request UI.
CheckSuiteAutoTriggerPreference
The auto-trigger preferences that are available for check suites.
CheckSuiteFilter
The filters that are available when fetching check suites.
ClearLabelsFromLabelableInput
Autogenerated input type of ClearLabelsFromLabelable.
ClearProjectV2ItemFieldValueInput
Autogenerated input type of ClearProjectV2ItemFieldValue.
CloneProjectInput
Autogenerated input type of CloneProject.
Input fields forCloneProjectInput
| Name | Description |
|---|---|
| The description of the project. |
| A unique identifier for the client performing the mutation. |
| Whether or not to clone the source project's workflows. |
| The name of the project. |
| The visibility of the project, defaults to false (private). |
| The source project to clone. |
| The owner ID to create the project under. |
CloneTemplateRepositoryInput
Autogenerated input type of CloneTemplateRepository.
Input fields forCloneTemplateRepositoryInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A short description of the new repository. |
| Whether to copy all branches from the template to the new repository. Defaultsto copying only the default branch of the template. |
| The name of the new repository. |
| The ID of the owner for the new repository. |
| The Node ID of the template repository. |
| Indicates the repository's visibility level. |
CloseDiscussionInput
Autogenerated input type of CloseDiscussion.
Input fields forCloseDiscussionInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the discussion to be closed. |
| The reason why the discussion is being closed. |
CloseIssueInput
Autogenerated input type of CloseIssue.
Input fields forCloseIssueInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the issue that this is a duplicate of. |
| ID of the issue to be closed. |
| The reason the issue is to be closed. |
ClosePullRequestInput
Autogenerated input type of ClosePullRequest.
CodeScanningParametersInput
Choose which tools must provide code scanning results before the reference isupdated. When configured, code scanning must be enabled and have results forboth the commit and the reference being updated.
Input fields forCodeScanningParametersInput
| Name | Description |
|---|---|
| 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 forCodeScanningToolInput
| Name | Description |
|---|---|
| The severity level at which code scanning results that raise alerts block areference update. For more information on alert severity levels, see "About code scanning alerts.". |
| The severity level at which code scanning results that raise security alertsblock a reference update. For more information on security severity levels,see "About code scanning alerts.". |
| The name of a code scanning tool. |
CommitAuthor
Specifies an author for filtering Git commits.
Input fields forCommitAuthor
| Name | Description |
|---|---|
| Email addresses to filter by. Commits authored by any of the specified email addresses will be returned. |
| ID of a User to filter by. If non-null, only commits authored by this userwill be returned. This field takes precedence over emails. |
CommitAuthorEmailPatternParametersInput
Parameters to be used for the commit_author_email_pattern rule.
CommitContributionOrder
Ordering options for commit contribution connections.
Input fields forCommitContributionOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field by which to order commit contributions. |
CommitMessage
A message to include with a new commit.
CommitMessagePatternParametersInput
Parameters to be used for the commit_message_pattern rule.
CommittableBranch
A git ref for a commit to be appended to.
The ref must be a branch, i.e. its fully qualified name must startwithrefs/heads/ (although the input is not required to be fullyqualified).
The Ref may be specified by its global node ID or by therepositoryNameWithOwner andbranchName.
Examples
Specify a branch using a global node ID:
{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }Specify a branch usingrepositoryNameWithOwner andbranchName:
{ "repositoryNameWithOwner": "github/graphql-client", "branchName": "main"}.CommitterEmailPatternParametersInput
Parameters to be used for the committer_email_pattern rule.
ContributionOrder
Ordering options for contribution connections.
Input fields forContributionOrder
| Name | Description |
|---|---|
| The ordering direction. |
ConvertProjectCardNoteToIssueInput
Autogenerated input type of ConvertProjectCardNoteToIssue.
Input fields forConvertProjectCardNoteToIssueInput
| Name | Description |
|---|---|
| The body of the newly created issue. |
| A unique identifier for the client performing the mutation. |
| The ProjectCard ID to convert. |
| The ID of the repository to create the issue in. |
| The title of the newly created issue. Defaults to the card's note text. |
ConvertProjectV2DraftIssueItemToIssueInput
Autogenerated input type of ConvertProjectV2DraftIssueItemToIssue.
ConvertPullRequestToDraftInput
Autogenerated input type of ConvertPullRequestToDraft.
CopyProjectV2Input
Autogenerated input type of CopyProjectV2.
Input fields forCopyProjectV2Input
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Include draft issues in the new project. |
| The owner ID of the new project. |
| The ID of the source Project to copy. |
| The title of the project. |
CreateAttributionInvitationInput
Autogenerated input type of CreateAttributionInvitation.
Input fields forCreateAttributionInvitationInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the owner scoping the reattributable data. |
| The Node ID of the account owning the data to reattribute. |
| The Node ID of the account which may claim the data. |
CreateBranchProtectionRuleInput
Autogenerated input type of CreateBranchProtectionRule.
Input fields forCreateBranchProtectionRuleInput
| Name | Description |
|---|---|
| Can this branch be deleted. |
| Are force pushes allowed on this branch. |
| Is branch creation a protected operation. |
| A list of User, Team, or App IDs allowed to bypass force push targeting matching branches. |
| A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches. |
| A unique identifier for the client performing the mutation. |
| Will new commits pushed to matching branches dismiss pull request review approvals. |
| Can admins override branch protection. |
| Whether users can pull changes from upstream when the branch is locked. Set to |
| Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. |
| The glob-like pattern used to determine matching branches. |
| A list of User, Team, or App IDs allowed to push to matching branches. |
| The global relay id of the repository in which a new branch protection rule should be created in. |
| Whether the most recent push must be approved by someone other than the person who pushed it. |
| Number of approving reviews required to update matching branches. |
| The list of required deployment environments. |
| List of required status check contexts that must pass for commits to be accepted to matching branches. |
| The list of required status checks. |
| Are approving reviews required to update matching branches. |
| Are reviews from code owners required to update matching branches. |
| Are commits required to be signed. |
| Are conversations required to be resolved before merging. |
| Are successful deployments required before merging. |
| Are merge commits prohibited from being pushed to this branch. |
| Are status checks required to update matching branches. |
| Are branches required to be up to date before merging. |
| Is pushing to matching branches restricted. |
| Is dismissal of pull request reviews restricted. |
| 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 forCreateCheckRunInput
| Name | Description |
|---|---|
| Possible further actions the integrator can perform, which a user may trigger. |
| A unique identifier for the client performing the mutation. |
| The time that the check run finished. |
| The final conclusion of the check. |
| The URL of the integrator's site that has the full details of the check. |
| A reference for the run on the integrator's system. |
| The SHA of the head commit. |
| The name of the check. |
| Descriptive details about the run. |
| The node ID of the repository. |
| The time that the check run began. |
| The current status. |
CreateCheckSuiteInput
Autogenerated input type of CreateCheckSuite.
Input fields forCreateCheckSuiteInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The SHA of the head commit. |
| The Node ID of the repository. |
CreateCommitOnBranchInput
Autogenerated input type of CreateCommitOnBranch.
Input fields forCreateCommitOnBranchInput
| Name | Description |
|---|---|
| The Ref to be updated. Must be a branch. |
| A unique identifier for the client performing the mutation. |
| The git commit oid expected at the head of the branch prior to the commit. |
| A description of changes to files in this commit. |
| The commit message the be included with the commit. |
CreateDeploymentInput
Autogenerated input type of CreateDeployment.
Input fields forCreateDeploymentInput
| Name | Description |
|---|---|
| Attempt to automatically merge the default branch into the requested ref, defaults to true. |
| A unique identifier for the client performing the mutation. |
| Short description of the deployment. |
| Name for the target deployment environment. |
| JSON payload with extra information about the deployment. |
| The node ID of the ref to be deployed. |
| The node ID of the repository. |
| The status contexts to verify against commit status checks. To bypass requiredcontexts, pass an empty array. Defaults to all unique contexts. |
| Specifies a task to execute. |
CreateDeploymentStatusInput
Autogenerated input type of CreateDeploymentStatus.
Input fields forCreateDeploymentStatusInput
| Name | Description |
|---|---|
| Adds a new inactive status to all non-transient, non-production environmentdeployments with the same repository and environment name as the createdstatus's deployment. |
| A unique identifier for the client performing the mutation. |
| The node ID of the deployment. |
| A short description of the status. Maximum length of 140 characters. |
| If provided, updates the environment of the deploy. Otherwise, does not modify the environment. |
| Sets the URL for accessing your environment. |
| The log URL to associate with this status. This URL should containoutput to keep the user updated while the task is running or serve ashistorical information for what happened in the deployment. |
| The state of the deployment. |
CreateDiscussionInput
Autogenerated input type of CreateDiscussion.
Input fields forCreateDiscussionInput
| Name | Description |
|---|---|
| The body of the discussion. |
| The id of the discussion category to associate with this discussion. |
| A unique identifier for the client performing the mutation. |
| The id of the repository on which to create the discussion. |
| The title of the discussion. |
CreateEnterpriseOrganizationInput
Autogenerated input type of CreateEnterpriseOrganization.
Input fields forCreateEnterpriseOrganizationInput
| Name | Description |
|---|---|
| The logins for the administrators of the new organization. |
| The email used for sending billing receipts. |
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise owning the new organization. |
| The login of the new organization. |
| The profile name of the new organization. |
CreateEnvironmentInput
Autogenerated input type of CreateEnvironment.
CreateIpAllowListEntryInput
Autogenerated input type of CreateIpAllowListEntry.
Input fields forCreateIpAllowListEntryInput
| Name | Description |
|---|---|
| An IP address or range of addresses in CIDR notation. |
| A unique identifier for the client performing the mutation. |
| Whether the IP allow list entry is active when an IP allow list is enabled. |
| An optional name for the IP allow list entry. |
| The ID of the owner for which to create the new IP allow list entry. |
CreateIssueInput
Autogenerated input type of CreateIssue.
Input fields forCreateIssueInput
| Name | Description |
|---|---|
| The Node ID of assignees for this issue. |
| The body for the issue description. |
| A unique identifier for the client performing the mutation. |
| The name of an issue template in the repository, assigns labels and assignees from the template to the issue. |
| The Node ID of the issue type for this issue. |
| An array of Node IDs of labels for this issue. |
| The Node ID of the milestone for this issue. |
| The Node ID of the parent issue to add this new issue to. |
| An array of Node IDs for projects associated with this issue. |
| The Node ID of the repository. |
| The title for the issue. |
CreateIssueTypeInput
Autogenerated input type of CreateIssueType.
Input fields forCreateIssueTypeInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Color for the issue type. |
| Description of the new issue type. |
| Whether or not the issue type is enabled on the org level. |
| Name of the new issue type. |
| The ID for the organization on which the issue type is created. |
CreateLabelInput
Autogenerated input type of CreateLabel.
Input fields forCreateLabelInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A 6 character hex code, without the leading #, identifying the color of the label. |
| A brief description of the label, such as its purpose. |
| The name of the label. |
| The Node ID of the repository. |
CreateLinkedBranchInput
Autogenerated input type of CreateLinkedBranch.
Input fields forCreateLinkedBranchInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| ID of the issue to link to. |
| The name of the new branch. Defaults to issue number and title. |
| The commit SHA to base the new branch on. |
| ID of the repository to create the branch in. Defaults to the issue repository. |
CreateMigrationSourceInput
Autogenerated input type of CreateMigrationSource.
Input fields forCreateMigrationSourceInput
| Name | Description |
|---|---|
| The migration source access token. |
| A unique identifier for the client performing the mutation. |
| The GitHub personal access token of the user importing to the target repository. |
| The migration source name. |
| The ID of the organization that will own the migration source. |
| The migration source type. |
| The migration source URL, for example |
CreateProjectInput
Autogenerated input type of CreateProject.
Input fields forCreateProjectInput
| Name | Description |
|---|---|
| The description of project. |
| A unique identifier for the client performing the mutation. |
| The name of project. |
| The owner ID to create the project under. |
| A list of repository IDs to create as linked repositories for the project. |
| The name of the GitHub-provided template. |
CreateProjectV2FieldInput
Autogenerated input type of CreateProjectV2Field.
Input fields forCreateProjectV2FieldInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The data type of the field. |
| Configuration for an iteration field. |
| The name of the field. |
| The ID of the Project to create the field in. |
| 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 forCreateProjectV2Input
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The owner ID to create the project under. |
| The repository to link the project to. |
| The team to link the project to. The team will be granted read permissions. |
| The title of the project. |
CreateProjectV2StatusUpdateInput
Autogenerated input type of CreateProjectV2StatusUpdate.
Input fields forCreateProjectV2StatusUpdateInput
| Name | Description |
|---|---|
| The body of the status update. |
| A unique identifier for the client performing the mutation. |
| The ID of the Project to create the status update in. |
| The start date of the status update. |
| The status of the status update. |
| The target date of the status update. |
CreatePullRequestInput
Autogenerated input type of CreatePullRequest.
Input fields forCreatePullRequestInput
| Name | Description |
|---|---|
| The name of the branch you want your changes pulled into. This should be an existing branchon the current repository. You cannot update the base branch on a pull request to pointto another repository. |
| The contents of the pull request. |
| A unique identifier for the client performing the mutation. |
| Indicates whether this pull request should be a draft. |
| The name of the branch where your changes are implemented. For cross-repository pull requestsin the same network, namespace |
| The Node ID of the head repository. |
| Indicates whether maintainers can modify the pull request. |
| The Node ID of the repository. |
| The title of the pull request. |
CreateRefInput
Autogenerated input type of CreateRef.
Input fields forCreateRefInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The fully qualified name of the new Ref (ie: |
| The GitObjectID that the new Ref shall target. Must point to a commit. |
| The Node ID of the Repository to create the Ref in. |
CreateRepositoryInput
Autogenerated input type of CreateRepository.
Input fields forCreateRepositoryInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A short description of the new repository. |
| Indicates if the repository should have the issues feature enabled. |
| Indicates if the repository should have the wiki feature enabled. |
| The URL for a web page about this repository. |
| The name of the new repository. |
| The ID of the owner for the new repository. |
| When an organization is specified as the owner, this ID identifies the teamthat should be granted access to the new repository. |
| Whether this repository should be marked as a template such that anyone whocan access it can create new repositories with the same files and directory structure. |
| Indicates the repository's visibility level. |
CreateRepositoryRulesetInput
Autogenerated input type of CreateRepositoryRuleset.
Input fields forCreateRepositoryRulesetInput
| Name | Description |
|---|---|
| A list of actors that are allowed to bypass rules in this ruleset. |
| A unique identifier for the client performing the mutation. |
| The set of conditions for this ruleset. |
| The enforcement level for this ruleset. |
| The name of the ruleset. |
| The list of rules for this ruleset. |
| The global relay id of the source in which a new ruleset should be created in. |
| The target of the ruleset. |
CreateSponsorsListingInput
Autogenerated input type of CreateSponsorsListing.
Input fields forCreateSponsorsListingInput
| Name | Description |
|---|---|
| The country or region where the sponsorable's bank account is located.Required if fiscalHostLogin is not specified, ignored when fiscalHostLogin is specified. |
| A unique identifier for the client performing the mutation. |
| The email address we should use to contact you about the GitHub Sponsorsprofile being created. This will not be shared publicly. Must be a verifiedemail address already on your GitHub account. Only relevant when thesponsorable is yourself. Defaults to your primary email address on file if omitted. |
| The username of the supported fiscal host's GitHub organization, if you wantto receive sponsorship payouts through a fiscal host rather than directly to abank account. For example, |
| The URL for your profile page on the fiscal host's website, e.g.,https://opencollective.com/babel orhttps://numfocus.org/project/bokeh.Required if fiscalHostLogin is specified. |
| Provide an introduction to serve as the main focus that appears on your GitHubSponsors profile. It's a great opportunity to help potential sponsors learnmore about you, your work, and why their sponsorship is important to you.GitHub-flavored Markdown is supported. |
| The country or region where the sponsorable resides. This is for tax purposes.Required if the sponsorable is yourself, ignored when sponsorableLoginspecifies an organization. |
| The username of the organization to create a GitHub Sponsors profile for, ifdesired. Defaults to creating a GitHub Sponsors profile for the authenticateduser if omitted. |
CreateSponsorsTierInput
Autogenerated input type of CreateSponsorsTier.
Input fields forCreateSponsorsTierInput
| Name | Description |
|---|---|
| The value of the new tier in US dollars. Valid values: 1-12000. |
| A unique identifier for the client performing the mutation. |
| A description of what this tier is, what perks sponsors might receive, what a sponsorship at this tier means for you, etc. |
| Whether sponsorships using this tier should happen monthly/yearly or just once. |
| Whether to make the tier available immediately for sponsors to choose.Defaults to creating a draft tier that will not be publicly visible. |
| Optional ID of the private repository that sponsors at this tier should gainread-only access to. Must be owned by an organization. |
| Optional name of the private repository that sponsors at this tier should gainread-only access to. Must be owned by an organization. Necessary ifrepositoryOwnerLogin is given. Will be ignored if repositoryId is given. |
| Optional login of the organization owner of the private repository thatsponsors at this tier should gain read-only access to. Necessary ifrepositoryName is given. Will be ignored if repositoryId is given. |
| 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. |
| 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. |
| Optional message new sponsors at this tier will receive. |
CreateSponsorshipInput
Autogenerated input type of CreateSponsorship.
Input fields forCreateSponsorshipInput
| Name | Description |
|---|---|
| The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000. |
| A unique identifier for the client performing the mutation. |
| Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified. |
| Specify whether others should be able to see that the sponsor is sponsoringthe sponsorable. Public visibility still does not reveal which tier is used. |
| Whether the sponsor should receive email updates from the sponsorable. |
| The ID of the user or organization who is acting as the sponsor, paying forthe sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, payingfor the sponsorship. Required if sponsorId is not given. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. |
| 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 forCreateSponsorshipsInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Specify whether others should be able to see that the sponsor is sponsoringthe sponsorables. Public visibility still does not reveal the dollar value ofthe sponsorship. |
| Whether the sponsor should receive email updates from the sponsorables. |
| Whether the sponsorships created should continue each billing cycle for thesponsor (monthly or annually), versus lasting only a single month. Defaults toone-time sponsorships. |
| The username of the user or organization who is acting as the sponsor, paying for the sponsorships. |
| The list of maintainers to sponsor and for how much apiece. |
CreateTeamDiscussionCommentInput
Autogenerated input type of CreateTeamDiscussionComment.
Input fields forCreateTeamDiscussionCommentInput
| Name | Description |
|---|---|
| The content of the comment. This field is required. Upcoming Change on 2024-07-01 UTCDescription: |
| A unique identifier for the client performing the mutation. |
| The ID of the discussion to which the comment belongs. This field is required. Upcoming Change on 2024-07-01 UTCDescription: |
CreateTeamDiscussionInput
Autogenerated input type of CreateTeamDiscussion.
Input fields forCreateTeamDiscussionInput
| Name | Description |
|---|---|
| The content of the discussion. This field is required. Upcoming Change on 2024-07-01 UTCDescription: |
| A unique identifier for the client performing the mutation. |
| If true, restricts the visibility of this discussion to team members andorganization owners. If false or not specified, allows any organization memberto view this discussion. Upcoming Change on 2024-07-01 UTCDescription: |
| The ID of the team to which the discussion belongs. This field is required. Upcoming Change on 2024-07-01 UTCDescription: |
| The title of the discussion. This field is required. Upcoming Change on 2024-07-01 UTCDescription: |
CreateUserListInput
Autogenerated input type of CreateUserList.
DeclineTopicSuggestionInput
Autogenerated input type of DeclineTopicSuggestion.
Input fields forDeclineTopicSuggestionInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The name of the suggested topic. Upcoming Change on 2024-04-01 UTCDescription: |
| The reason why the suggested topic is declined. Upcoming Change on 2024-04-01 UTCDescription: |
| The Node ID of the repository. Upcoming Change on 2024-04-01 UTCDescription: |
DeleteBranchProtectionRuleInput
Autogenerated input type of DeleteBranchProtectionRule.
DeleteDeploymentInput
Autogenerated input type of DeleteDeployment.
DeleteDiscussionCommentInput
Autogenerated input type of DeleteDiscussionComment.
DeleteDiscussionInput
Autogenerated input type of DeleteDiscussion.
DeleteEnvironmentInput
Autogenerated input type of DeleteEnvironment.
DeleteIpAllowListEntryInput
Autogenerated input type of DeleteIpAllowListEntry.
DeleteIssueCommentInput
Autogenerated input type of DeleteIssueComment.
DeleteIssueInput
Autogenerated input type of DeleteIssue.
DeleteIssueTypeInput
Autogenerated input type of DeleteIssueType.
DeleteLabelInput
Autogenerated input type of DeleteLabel.
DeleteLinkedBranchInput
Autogenerated input type of DeleteLinkedBranch.
DeletePackageVersionInput
Autogenerated input type of DeletePackageVersion.
DeleteProjectCardInput
Autogenerated input type of DeleteProjectCard.
DeleteProjectColumnInput
Autogenerated input type of DeleteProjectColumn.
DeleteProjectInput
Autogenerated input type of DeleteProject.
DeleteProjectV2FieldInput
Autogenerated input type of DeleteProjectV2Field.
DeleteProjectV2Input
Autogenerated input type of DeleteProjectV2.
DeleteProjectV2ItemInput
Autogenerated input type of DeleteProjectV2Item.
DeleteProjectV2StatusUpdateInput
Autogenerated input type of DeleteProjectV2StatusUpdate.
DeleteProjectV2WorkflowInput
Autogenerated input type of DeleteProjectV2Workflow.
DeletePullRequestReviewCommentInput
Autogenerated input type of DeletePullRequestReviewComment.
DeletePullRequestReviewInput
Autogenerated input type of DeletePullRequestReview.
DeleteRefInput
Autogenerated input type of DeleteRef.
DeleteRepositoryRulesetInput
Autogenerated input type of DeleteRepositoryRuleset.
DeleteTeamDiscussionCommentInput
Autogenerated input type of DeleteTeamDiscussionComment.
DeleteTeamDiscussionInput
Autogenerated input type of DeleteTeamDiscussion.
DeleteUserListInput
Autogenerated input type of DeleteUserList.
DeleteVerifiableDomainInput
Autogenerated input type of DeleteVerifiableDomain.
DeploymentOrder
Ordering options for deployment connections.
Input fields forDeploymentOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order deployments by. |
DequeuePullRequestInput
Autogenerated input type of DequeuePullRequest.
DisablePullRequestAutoMergeInput
Autogenerated input type of DisablePullRequestAutoMerge.
DiscussionOrder
Ways in which lists of discussions can be ordered upon return.
Input fields forDiscussionOrder
| Name | Description |
|---|---|
| The direction in which to order discussions by the specified field. |
| The field by which to order discussions. |
DiscussionPollOptionOrder
Ordering options for discussion poll option connections.
Input fields forDiscussionPollOptionOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order poll options by. |
DismissPullRequestReviewInput
Autogenerated input type of DismissPullRequestReview.
DismissRepositoryVulnerabilityAlertInput
Autogenerated input type of DismissRepositoryVulnerabilityAlert.
Input fields forDismissRepositoryVulnerabilityAlertInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The reason the Dependabot alert is being dismissed. |
| The Dependabot alert ID to dismiss. |
DraftPullRequestReviewComment
Specifies a review comment to be left with a Pull Request Review.
DraftPullRequestReviewThread
Specifies a review comment thread to be left with a Pull Request Review.
Input fields forDraftPullRequestReviewThread
| Name | Description |
|---|---|
| Body of the comment to leave. |
| The line of the blob to which the thread refers. The end of the line range formulti-line comments. Required if not using positioning. |
| Path to the file being commented on. Required if not using positioning. |
| The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. |
| The first line of the range to which the comment refers. |
| The side of the diff on which the start line resides. |
EnablePullRequestAutoMergeInput
Autogenerated input type of EnablePullRequestAutoMerge.
Input fields forEnablePullRequestAutoMergeInput
| Name | Description |
|---|---|
| The email address to associate with this merge. |
| A unique identifier for the client performing the mutation. |
| Commit body to use for the commit when the PR is mergable; if omitted, adefault message will be used. NOTE: when merging with a merge queue any inputvalue for commit message is ignored. |
| Commit headline to use for the commit when the PR is mergable; if omitted, adefault message will be used. NOTE: when merging with a merge queue any inputvalue for commit headline is ignored. |
| The expected head OID of the pull request. |
| The merge method to use. If omitted, defaults to |
| ID of the pull request to enable auto-merge on. |
EnqueuePullRequestInput
Autogenerated input type of EnqueuePullRequest.
Input fields forEnqueuePullRequestInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The expected head OID of the pull request. |
| Add the pull request to the front of the queue. |
| The ID of the pull request to enqueue. |
EnterpriseAdministratorInvitationOrder
Ordering options for enterprise administrator invitation connections.
Input fields forEnterpriseAdministratorInvitationOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order enterprise administrator invitations by. |
EnterpriseMemberInvitationOrder
Ordering options for enterprise administrator invitation connections.
Input fields forEnterpriseMemberInvitationOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order enterprise member invitations by. |
EnterpriseMemberOrder
Ordering options for enterprise member connections.
Input fields forEnterpriseMemberOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order enterprise members by. |
EnterpriseOrder
Ordering options for enterprises.
Input fields forEnterpriseOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order enterprises by. |
EnterpriseServerInstallationOrder
Ordering options for Enterprise Server installation connections.
Input fields forEnterpriseServerInstallationOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order Enterprise Server installations by. |
EnterpriseServerUserAccountEmailOrder
Ordering options for Enterprise Server user account email connections.
Input fields forEnterpriseServerUserAccountEmailOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order emails by. |
EnterpriseServerUserAccountOrder
Ordering options for Enterprise Server user account connections.
Input fields forEnterpriseServerUserAccountOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order user accounts by. |
EnterpriseServerUserAccountsUploadOrder
Ordering options for Enterprise Server user accounts upload connections.
Input fields forEnterpriseServerUserAccountsUploadOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order user accounts uploads by. |
Environments
Ordering options for environments.
Input fields forEnvironments
| Name | Description |
|---|---|
| The direction in which to order environments by the specified field. |
| The field to order environments by. |
FileAddition
A command to add a file at the given path with the given contents as part of acommit. Any existing file at that that path will be replaced.
Input fields forFileAddition
| Name | Description |
|---|---|
| The base64 encoded contents of the file. |
| 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 ofa git commit, modeled as zero or more fileadditions and zero or morefiledeletions.
Both fields are optional; omitting both will produce a commit with nofile changes.
deletions andadditions describe changes to files identifiedby 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 notslash-prefixed.
path values must be unique across alladditions anddeletionsprovided. Any duplication will result in a validation error.
Encoding
File contents must be provided in full for eachFileAddition.
Thecontents of aFileAddition must be encoded using RFC 4648compliant base64, i.e. correct padding is required and no charactersoutside the standard alphabet may be used. Invalid base64encoding will be rejected with a validation error.
The encoded contents may be binary.
For text files, no assumptions are made about the character encoding ofthe file contents (after base64 decoding). No charset transcoding orline-ending normalization will be performed; it is the client'sresponsibility to manage the character encoding of files they provide.However, for maximum compatibility we recommend using UTF-8 encodingand ensuring that all files in a repository use a consistentline-ending convention (\n or\r\n), and that all files endwith a newline.
Modeling file changes
Each of the the five types of conceptual changes that can be made in agit commit can be described using theFileChanges type as follows:
New file addition: create file
hello world\nat pathdocs/README.txt:{ "additions" [ { "path": "docs/README.txt", "contents": base64encode("hello world\n") } ]}Existing file modification: change existing
docs/README.txtto have newcontentnew 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 apath that does not exist on the given branch will abort thecommit and return an error.{ "deletions" [ { "path": "docs/README.txt" } ]}File rename with no changes: rename
docs/README.txtwithprevious contenthello world\nto the same content atnewdocs/README.txt:{ "deletions" [ { "path": "docs/README.txt", } ], "additions" [ { "path": "newdocs/README.txt", "contents": base64encode("hello world\n") } ]}File rename with changes: rename
docs/README.txtwithprevious contenthello world\nto a file at pathnewdocs/README.txtwith contentnew contents\n:{ "deletions" [ { "path": "docs/README.txt", } ], "additions" [ { "path": "newdocs/README.txt", "contents": base64encode("new contents\n") } ]}.
Input fields forFileChanges
| Name | Description |
|---|---|
| File to add or change. |
| Files to delete. |
FileDeletion
A command to delete the file at the given path as part of a commit.
Input fields forFileDeletion
| Name | Description |
|---|---|
| The path to delete. |
FileExtensionRestrictionParametersInput
Prevent commits that include files with specified file extensions from being pushed to the commit graph.
Input fields forFileExtensionRestrictionParametersInput
| Name | Description |
|---|---|
| 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 frombeing pushed to the commit graph. This includes absolute paths that contain file names.
Input fields forFilePathRestrictionParametersInput
| Name | Description |
|---|---|
| The file paths that are restricted from being pushed to the commit graph. |
FollowOrganizationInput
Autogenerated input type of FollowOrganization.
FollowUserInput
Autogenerated input type of FollowUser.
GistOrder
Ordering options for gist connections.
Input fields forGistOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order repositories by. |
GrantEnterpriseOrganizationsMigratorRoleInput
Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.
Input fields forGrantEnterpriseOrganizationsMigratorRoleInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise to which all organizations managed by it will be granted the migrator role. |
| The login of the user to grant the migrator role. |
GrantMigratorRoleInput
Autogenerated input type of GrantMigratorRole.
Input fields forGrantMigratorRoleInput
| Name | Description |
|---|---|
| The user login or Team slug to grant the migrator role. |
| Specifies the type of the actor, can be either USER or TEAM. |
| A unique identifier for the client performing the mutation. |
| The ID of the organization that the user/team belongs to. |
ImportProjectInput
Autogenerated input type of ImportProject.
Input fields forImportProjectInput
| Name | Description |
|---|---|
| The description of Project. |
| A unique identifier for the client performing the mutation. |
| A list of columns containing issues and pull requests. |
| The name of Project. |
| The name of the Organization or User to create the Project under. |
| Whether the Project is public or not. |
InviteEnterpriseAdminInput
Autogenerated input type of InviteEnterpriseAdmin.
Input fields forInviteEnterpriseAdminInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The email of the person to invite as an administrator. |
| The ID of the enterprise to which you want to invite an administrator. |
| The login of a user to invite as an administrator. |
| The role of the administrator. |
InviteEnterpriseMemberInput
Autogenerated input type of InviteEnterpriseMember.
Input fields forInviteEnterpriseMemberInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The email of the person to invite as an unaffiliated member. |
| The ID of the enterprise to which you want to invite an unaffiliated member. |
| The login of a user to invite as an unaffiliated member. |
IpAllowListEntryOrder
Ordering options for IP allow list entry connections.
Input fields forIpAllowListEntryOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order IP allow list entries by. |
IssueCommentOrder
Ways in which lists of issue comments can be ordered upon return.
Input fields forIssueCommentOrder
| Name | Description |
|---|---|
| The direction in which to order issue comments by the specified field. |
| The field in which to order issue comments by. |
IssueFilters
Ways in which to filter lists of issues.
Input fields forIssueFilters
| Name | Description |
|---|---|
| List issues assigned to given name. Pass in |
| List issues created by given name. |
| List issues where the list of label names exist on the issue. |
| List issues where the given name is mentioned in the issue. |
| List issues by given milestone argument. If an string representation of aninteger is passed, it should refer to a milestone by its database ID. Pass in |
| List issues by given milestone argument. If an string representation of aninteger is passed, it should refer to a milestone by its number field. Pass in |
| List issues that have been updated at or after the given date. |
| List issues filtered by the list of states given. |
| List issues filtered by the type given, only supported by searches on repositories. |
| List issues subscribed to by viewer. |
IssueOrder
Ways in which lists of issues can be ordered upon return.
Input fields forIssueOrder
| Name | Description |
|---|---|
| The direction in which to order issues by the specified field. |
| The field in which to order issues by. |
IssueTypeOrder
Ordering options for issue types connections.
Input fields forIssueTypeOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order issue types by. |
LabelOrder
Ways in which lists of labels can be ordered upon return.
Input fields forLabelOrder
| Name | Description |
|---|---|
| The direction in which to order labels by the specified field. |
| The field in which to order labels by. |
LanguageOrder
Ordering options for language connections.
Input fields forLanguageOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order languages by. |
LinkProjectV2ToRepositoryInput
Autogenerated input type of LinkProjectV2ToRepository.
LinkProjectV2ToTeamInput
Autogenerated input type of LinkProjectV2ToTeam.
LinkRepositoryToProjectInput
Autogenerated input type of LinkRepositoryToProject.
LockLockableInput
Autogenerated input type of LockLockable.
Input fields forLockLockableInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A reason for why the item will be locked. |
| ID of the item to be locked. |
MannequinOrder
Ordering options for mannequins.
Input fields forMannequinOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order mannequins by. |
MarkDiscussionCommentAsAnswerInput
Autogenerated input type of MarkDiscussionCommentAsAnswer.
MarkFileAsViewedInput
Autogenerated input type of MarkFileAsViewed.
MarkProjectV2AsTemplateInput
Autogenerated input type of MarkProjectV2AsTemplate.
MarkPullRequestReadyForReviewInput
Autogenerated input type of MarkPullRequestReadyForReview.
MaxFilePathLengthParametersInput
Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
Input fields forMaxFilePathLengthParametersInput
| Name | Description |
|---|---|
| The maximum amount of characters allowed in file paths. |
MaxFileSizeParametersInput
Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
Input fields forMaxFileSizeParametersInput
| Name | Description |
|---|---|
| The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). |
MergeBranchInput
Autogenerated input type of MergeBranch.
Input fields forMergeBranchInput
| Name | Description |
|---|---|
| The email address to associate with this commit. |
| The name of the base branch that the provided head will be merged into. |
| A unique identifier for the client performing the mutation. |
| Message to use for the merge commit. If omitted, a default will be used. |
| The head to merge into the base branch. This can be a branch name or a commit GitObjectID. |
| The Node ID of the Repository containing the base branch that will be modified. |
MergePullRequestInput
Autogenerated input type of MergePullRequest.
Input fields forMergePullRequestInput
| Name | Description |
|---|---|
| The email address to associate with this merge. |
| A unique identifier for the client performing the mutation. |
| Commit body to use for the merge commit; if omitted, a default message will be used. |
| Commit headline to use for the merge commit; if omitted, a default message will be used. |
| OID that the pull request head ref must match to allow merge; if omitted, no check is performed. |
| The merge method to use. If omitted, defaults to 'MERGE'. |
| ID of the pull request to be merged. |
MergeQueueParametersInput
Merges must be performed via a merge queue.
Input fields forMergeQueueParametersInput
| Name | Description |
|---|---|
| Maximum time for a required status check to report a conclusion. After thismuch time has elapsed, checks that have not reported a conclusion will beassumed to have failed. |
| When set to ALLGREEN, the merge commit created by merge queue for each PR inthe group must pass all required checks to merge. When set to HEADGREEN, onlythe commit at the head of the merge group, i.e. the commit containing changesfrom all of the PRs in the group, must pass its required checks to merge. |
| Limit the number of queued pull requests requesting checks and workflow runs at the same time. |
| The maximum number of PRs that will be merged together in a group. |
| Method to use when merging changes from queued pull requests. |
| The minimum number of PRs that will be merged together in a group. |
| The time merge queue should wait after the first PR is added to the queue forthe minimum group size to be met. After this time has elapsed, the minimumgroup size will be ignored and a smaller group will be merged. |
MilestoneOrder
Ordering options for milestone connections.
Input fields forMilestoneOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order milestones by. |
MinimizeCommentInput
Autogenerated input type of MinimizeComment.
Input fields forMinimizeCommentInput
| Name | Description |
|---|---|
| The classification of comment. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the subject to modify. |
MoveProjectCardInput
Autogenerated input type of MoveProjectCard.
Input fields forMoveProjectCardInput
| Name | Description |
|---|---|
| Place the new card after the card with this id. Pass null to place it at the top. |
| The id of the card to move. |
| A unique identifier for the client performing the mutation. |
| The id of the column to move it into. |
MoveProjectColumnInput
Autogenerated input type of MoveProjectColumn.
OrgEnterpriseOwnerOrder
Ordering options for an organization's enterprise owner connections.
Input fields forOrgEnterpriseOwnerOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order enterprise owners by. |
OrganizationOrder
Ordering options for organization connections.
Input fields forOrganizationOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order organizations by. |
PackageFileOrder
Ways in which lists of package files can be ordered upon return.
Input fields forPackageFileOrder
| Name | Description |
|---|---|
| The direction in which to order package files by the specified field. |
| The field in which to order package files by. |
PackageOrder
Ways in which lists of packages can be ordered upon return.
Input fields forPackageOrder
| Name | Description |
|---|---|
| The direction in which to order packages by the specified field. |
| The field in which to order packages by. |
PackageVersionOrder
Ways in which lists of package versions can be ordered upon return.
Input fields forPackageVersionOrder
| Name | Description |
|---|---|
| The direction in which to order package versions by the specified field. |
| The field in which to order package versions by. |
PinEnvironmentInput
Autogenerated input type of PinEnvironment.
Input fields forPinEnvironmentInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the environment to modify. |
| The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned. |
PinIssueInput
Autogenerated input type of PinIssue.
PinnedEnvironmentOrder
Ordering options for pinned environments.
Input fields forPinnedEnvironmentOrder
| Name | Description |
|---|---|
| The direction in which to order pinned environments by the specified field. |
| The field to order pinned environments by. |
ProjectCardImport
An issue or PR and its owning repository to be used in a project card.
ProjectColumnImport
A project column and a list of its issues and PRs.
Input fields forProjectColumnImport
| Name | Description |
|---|---|
| The name of the column. |
| A list of issues and pull requests in the column. |
| The position of the column, starting from 0. |
ProjectOrder
Ways in which lists of projects can be ordered upon return.
Input fields forProjectOrder
| Name | Description |
|---|---|
| The direction in which to order projects by the specified field. |
| The field in which to order projects by. |
ProjectV2Collaborator
A collaborator to update on a project. Only one of the userId or teamId should be provided.
Input fields forProjectV2Collaborator
| Name | Description |
|---|---|
| The role to grant the collaborator. |
| The ID of the team as a collaborator. |
| The ID of the user as a collaborator. |
ProjectV2FieldOrder
Ordering options for project v2 field connections.
Input fields forProjectV2FieldOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order the project v2 fields by. |
ProjectV2FieldValue
The values that can be used to update a field of an item inside a Project. Only 1 value can be updated at a time.
Input fields forProjectV2FieldValue
| Name | Description |
|---|---|
| The ISO 8601 date to set on the field. |
| The id of the iteration to set on the field. |
| The number to set on the field. |
| The id of the single select option to set on the field. |
| The text to set on the field. |
ProjectV2Filters
Ways in which to filter lists of projects.
Input fields forProjectV2Filters
| Name | Description |
|---|---|
| List project v2 filtered by the state given. |
ProjectV2ItemFieldValueOrder
Ordering options for project v2 item field value connections.
Input fields forProjectV2ItemFieldValueOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order the project v2 item field values by. |
ProjectV2ItemOrder
Ordering options for project v2 item connections.
Input fields forProjectV2ItemOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order the project v2 items by. |
ProjectV2Iteration
Represents an iteration.
ProjectV2IterationFieldConfigurationInput
Represents an iteration field configuration.
Input fields forProjectV2IterationFieldConfigurationInput
| Name | Description |
|---|---|
| The duration of each iteration, in days. |
| Zero or more iterations for the field. |
| The start date for the first iteration. |
ProjectV2Order
Ways in which lists of projects can be ordered upon return.
Input fields forProjectV2Order
| Name | Description |
|---|---|
| The direction in which to order projects by the specified field. |
| The field in which to order projects by. |
ProjectV2SingleSelectFieldOptionInput
Represents a single select field option.
ProjectV2StatusOrder
Ways in which project v2 status updates can be ordered.
Input fields forProjectV2StatusOrder
| Name | Description |
|---|---|
| The direction in which to order nodes. |
| The field by which to order nodes. |
ProjectV2ViewOrder
Ordering options for project v2 view connections.
Input fields forProjectV2ViewOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order the project v2 views by. |
ProjectV2WorkflowOrder
Ordering options for project v2 workflows connections.
Input fields forProjectV2WorkflowOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order the project v2 workflows by. |
PropertyTargetDefinitionInput
A property that must match.
Input fields forPropertyTargetDefinitionInput
| Name | Description |
|---|---|
| The name of the property. |
| The values to match for. |
| The source of the property. Choose |
PublishSponsorsTierInput
Autogenerated input type of PublishSponsorsTier.
PullRequestOrder
Ways in which lists of issues can be ordered upon return.
Input fields forPullRequestOrder
| Name | Description |
|---|---|
| The direction in which to order pull requests by the specified field. |
| The field in which to order pull requests by. |
PullRequestParametersInput
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Input fields forPullRequestParametersInput
| Name | Description |
|---|---|
| Array of allowed merge methods. Allowed values include |
| Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review. |
| New, reviewable commits pushed will dismiss previous pull request review approvals. |
| Require an approving review in pull requests that modify files that have a designated code owner. |
| Whether the most recent reviewable push must be approved by someone other than the person who pushed it. |
| The number of approving reviews that are required before a pull request can be merged. |
| All conversations on code must be resolved before a pull request can be merged. |
ReactionOrder
Ways in which lists of reactions can be ordered upon return.
Input fields forReactionOrder
| Name | Description |
|---|---|
| The direction in which to order reactions by the specified field. |
| The field in which to order reactions by. |
RefNameConditionTargetInput
Parameters to be used for the ref_name condition.
Input fields forRefNameConditionTargetInput
| Name | Description |
|---|---|
| Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. |
| Array of ref names or patterns to include. One of these patterns must matchfor the condition to pass. Also accepts |
RefOrder
Ways in which lists of git refs can be ordered upon return.
Input fields forRefOrder
| Name | Description |
|---|---|
| The direction in which to order refs by the specified field. |
| The field in which to order refs by. |
RefUpdate
A ref update.
Input fields forRefUpdate
| Name | Description |
|---|---|
| The value this ref should be updated to. |
| The value this ref needs to point to before the update. |
| Force a non fast-forward update. |
| The fully qualified name of the ref to be update. For example |
RegenerateEnterpriseIdentityProviderRecoveryCodesInput
Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.
RegenerateVerifiableDomainTokenInput
Autogenerated input type of RegenerateVerifiableDomainToken.
RejectDeploymentsInput
Autogenerated input type of RejectDeployments.
Input fields forRejectDeploymentsInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Optional comment for rejecting deployments. |
| The ids of environments to reject deployments. |
| The node ID of the workflow run containing the pending deployments. |
ReleaseOrder
Ways in which lists of releases can be ordered upon return.
Input fields forReleaseOrder
| Name | Description |
|---|---|
| The direction in which to order releases by the specified field. |
| The field in which to order releases by. |
RemoveAssigneesFromAssignableInput
Autogenerated input type of RemoveAssigneesFromAssignable.
RemoveEnterpriseAdminInput
Autogenerated input type of RemoveEnterpriseAdmin.
RemoveEnterpriseIdentityProviderInput
Autogenerated input type of RemoveEnterpriseIdentityProvider.
RemoveEnterpriseMemberInput
Autogenerated input type of RemoveEnterpriseMember.
RemoveEnterpriseOrganizationInput
Autogenerated input type of RemoveEnterpriseOrganization.
Input fields forRemoveEnterpriseOrganizationInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise from which the organization should be removed. |
| The ID of the organization to remove from the enterprise. |
RemoveEnterpriseSupportEntitlementInput
Autogenerated input type of RemoveEnterpriseSupportEntitlement.
RemoveLabelsFromLabelableInput
Autogenerated input type of RemoveLabelsFromLabelable.
RemoveOutsideCollaboratorInput
Autogenerated input type of RemoveOutsideCollaborator.
RemoveReactionInput
Autogenerated input type of RemoveReaction.
Input fields forRemoveReactionInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The name of the emoji reaction to remove. |
| The Node ID of the subject to modify. |
RemoveStarInput
Autogenerated input type of RemoveStar.
RemoveSubIssueInput
Autogenerated input type of RemoveSubIssue.
RemoveUpvoteInput
Autogenerated input type of RemoveUpvote.
ReopenDiscussionInput
Autogenerated input type of ReopenDiscussion.
ReopenIssueInput
Autogenerated input type of ReopenIssue.
ReopenPullRequestInput
Autogenerated input type of ReopenPullRequest.
ReorderEnvironmentInput
Autogenerated input type of ReorderEnvironment.
ReplaceActorsForAssignableInput
Autogenerated input type of ReplaceActorsForAssignable.
RepositoryIdConditionTargetInput
Parameters to be used for the repository_id condition.
Input fields forRepositoryIdConditionTargetInput
| Name | Description |
|---|---|
| One of these repo IDs must match the repo. |
RepositoryInvitationOrder
Ordering options for repository invitation connections.
Input fields forRepositoryInvitationOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order repository invitations by. |
RepositoryMigrationOrder
Ordering options for repository migrations.
Input fields forRepositoryMigrationOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order repository migrations by. |
RepositoryNameConditionTargetInput
Parameters to be used for the repository_name condition.
Input fields forRepositoryNameConditionTargetInput
| Name | Description |
|---|---|
| Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. |
| Array of repository names or patterns to include. One of these patterns mustmatch for the condition to pass. Also accepts |
| Target changes that match these patterns will be prevented except by those with bypass permissions. |
RepositoryOrder
Ordering options for repository connections.
Input fields forRepositoryOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order repositories by. |
RepositoryPropertyConditionTargetInput
Parameters to be used for the repository_property condition.
Input fields forRepositoryPropertyConditionTargetInput
| Name | Description |
|---|---|
| Array of repository properties that must not match. |
| Array of repository properties that must match. |
RepositoryRuleConditionsInput
Specifies the conditions required for a ruleset to evaluate.
Input fields forRepositoryRuleConditionsInput
| Name | Description |
|---|---|
| Configuration for the ref_name condition. |
| Configuration for the repository_id condition. |
| Configuration for the repository_name condition. |
| Configuration for the repository_property condition. |
RepositoryRuleInput
Specifies the attributes for a new or updated rule.
Input fields forRepositoryRuleInput
| Name | Description |
|---|---|
| Optional ID of this rule when updating. |
| The parameters for the rule. |
| The type of rule to create. |
RepositoryRuleOrder
Ordering options for repository rules.
Input fields forRepositoryRuleOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order repository rules by. |
RepositoryRulesetBypassActorInput
Specifies the attributes for a new or updated ruleset bypass actor. Only one ofactor_id,repository_role_database_id,organization_admin, ordeploy_keyshould be specified.
Input fields forRepositoryRulesetBypassActorInput
| Name | Description |
|---|---|
| For Team and Integration bypasses, the Team or Integration ID. |
| The bypass mode for this actor. |
| For deploy key bypasses, true. Can only use ALWAYS as the bypass mode. |
| For enterprise owner bypasses, true. |
| For organization owner bypasses, true. |
| For role bypasses, the role database ID. |
ReprioritizeSubIssueInput
Autogenerated input type of ReprioritizeSubIssue.
Input fields forReprioritizeSubIssueInput
| Name | Description |
|---|---|
| The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). |
| The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). |
| A unique identifier for the client performing the mutation. |
| The id of the parent issue. |
| The id of the sub-issue to reprioritize. |
RequestReviewsInput
Autogenerated input type of RequestReviews.
Input fields forRequestReviewsInput
| Name | Description |
|---|---|
| The Node IDs of the bot to request. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the pull request to modify. |
| The Node IDs of the team to request. |
| Add users to the set rather than replace. |
| The Node IDs of the user to request. |
RequiredDeploymentsParametersInput
Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Input fields forRequiredDeploymentsParametersInput
| Name | Description |
|---|---|
| The environments that must be successfully deployed to before branches can be merged. |
RequiredStatusCheckInput
Specifies the attributes for a new or updated required status check.
Input fields forRequiredStatusCheckInput
| Name | Description |
|---|---|
| The ID of the App that must set the status in order for it to be accepted.Omit this value to use whichever app has recently been setting this status, oruse "any" to allow any app to set the status. |
| Status check context that must pass for commits to be accepted to the matching branch. |
RequiredStatusChecksParametersInput
Choose which status checks must pass before the ref is updated. When enabled,commits must first be pushed to another ref where the checks pass.
Input fields forRequiredStatusChecksParametersInput
| Name | Description |
|---|---|
| Allow repositories and branches to be created if a check would otherwise prohibit it. |
| Status checks that are required. |
| Whether pull requests targeting a matching branch must be tested with thelatest code. This setting will not take effect unless at least one statuscheck is enabled. |
RerequestCheckSuiteInput
Autogenerated input type of RerequestCheckSuite.
ResolveReviewThreadInput
Autogenerated input type of ResolveReviewThread.
RetireSponsorsTierInput
Autogenerated input type of RetireSponsorsTier.
RevertPullRequestInput
Autogenerated input type of RevertPullRequest.
Input fields forRevertPullRequestInput
| Name | Description |
|---|---|
| The description of the revert pull request. |
| A unique identifier for the client performing the mutation. |
| Indicates whether the revert pull request should be a draft. |
| The ID of the pull request to revert. |
| The title of the revert pull request. |
RevokeEnterpriseOrganizationsMigratorRoleInput
Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.
Input fields forRevokeEnterpriseOrganizationsMigratorRoleInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise to which all organizations managed by it will be granted the migrator role. |
| The login of the user to revoke the migrator role. |
RevokeMigratorRoleInput
Autogenerated input type of RevokeMigratorRole.
Input fields forRevokeMigratorRoleInput
| Name | Description |
|---|---|
| The user login or Team slug to revoke the migrator role from. |
| Specifies the type of the actor, can be either USER or TEAM. |
| A unique identifier for the client performing the mutation. |
| The ID of the organization that the user/team belongs to. |
RuleParametersInput
Specifies the parameters for aRepositoryRule object. Only one of the fields should be specified.
Input fields forRuleParametersInput
| Name | Description |
|---|---|
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
| Parameters used for the |
SavedReplyOrder
Ordering options for saved reply connections.
Input fields forSavedReplyOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order saved replies by. |
SecurityAdvisoryIdentifierFilter
An advisory identifier to filter results on.
Input fields forSecurityAdvisoryIdentifierFilter
| Name | Description |
|---|---|
The identifier type. | |
| The identifier string. Supports exact or partial matching. |
SecurityAdvisoryOrder
Ordering options for security advisory connections.
Input fields forSecurityAdvisoryOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order security advisories by. |
SecurityVulnerabilityOrder
Ordering options for security vulnerability connections.
Input fields forSecurityVulnerabilityOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order security vulnerabilities by. |
SetEnterpriseIdentityProviderInput
Autogenerated input type of SetEnterpriseIdentityProvider.
Input fields forSetEnterpriseIdentityProviderInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The digest algorithm used to sign SAML requests for the identity provider. |
| The ID of the enterprise on which to set an identity provider. |
| The x509 certificate used by the identity provider to sign assertions and responses. |
| The Issuer Entity ID for the SAML identity provider. |
| The signature algorithm used to sign SAML requests for the identity provider. |
| The URL endpoint for the identity provider's SAML SSO. |
SetOrganizationInteractionLimitInput
Autogenerated input type of SetOrganizationInteractionLimit.
Input fields forSetOrganizationInteractionLimitInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| When this limit should expire. |
| The limit to set. |
| The ID of the organization to set a limit for. |
SetRepositoryInteractionLimitInput
Autogenerated input type of SetRepositoryInteractionLimit.
Input fields forSetRepositoryInteractionLimitInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| When this limit should expire. |
| The limit to set. |
| The ID of the repository to set a limit for. |
SetUserInteractionLimitInput
Autogenerated input type of SetUserInteractionLimit.
Input fields forSetUserInteractionLimitInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| When this limit should expire. |
| The limit to set. |
| The ID of the user to set a limit for. |
SponsorAndLifetimeValueOrder
Ordering options for connections to get sponsor entities and associated USD amounts for GitHub Sponsors.
Input fields forSponsorAndLifetimeValueOrder
| Name | Description |
|---|---|
| The ordering direction. |
The field to order results by. |
SponsorOrder
Ordering options for connections to get sponsor entities for GitHub Sponsors.
Input fields forSponsorOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order sponsor entities by. |
SponsorableOrder
Ordering options for connections to get sponsorable entities for GitHub Sponsors.
Input fields forSponsorableOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order sponsorable entities by. |
SponsorsActivityOrder
Ordering options for GitHub Sponsors activity connections.
Input fields forSponsorsActivityOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order activity by. |
SponsorsTierOrder
Ordering options for Sponsors tiers connections.
Input fields forSponsorsTierOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order tiers by. |
SponsorshipNewsletterOrder
Ordering options for sponsorship newsletter connections.
Input fields forSponsorshipNewsletterOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order sponsorship newsletters by. |
SponsorshipOrder
Ordering options for sponsorship connections.
Input fields forSponsorshipOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order sponsorship by. |
StarOrder
Ways in which star connections can be ordered.
Input fields forStarOrder
| Name | Description |
|---|---|
| The direction in which to order nodes. |
| The field in which to order nodes by. |
StartOrganizationMigrationInput
Autogenerated input type of StartOrganizationMigration.
Input fields forStartOrganizationMigrationInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The migration source access token. |
| The URL of the organization to migrate. |
| The ID of the enterprise the target organization belongs to. |
| The name of the target organization. |
StartRepositoryMigrationInput
Autogenerated input type of StartRepositoryMigration.
Input fields forStartRepositoryMigrationInput
| Name | Description |
|---|---|
| The migration source access token. |
| A unique identifier for the client performing the mutation. |
| Whether to continue the migration on error. Defaults to |
| The signed URL to access the user-uploaded git archive. |
| The GitHub personal access token of the user importing to the target repository. |
| Whether to lock the source repository. |
| The signed URL to access the user-uploaded metadata archive. |
| The ID of the organization that will own the imported repository. |
| The name of the imported repository. |
| Whether to skip migrating releases for the repository. |
| The ID of the migration source. |
| The URL of the source repository. |
| The visibility of the imported repository. |
StatusCheckConfigurationInput
Required status check.
SubmitPullRequestReviewInput
Autogenerated input type of SubmitPullRequestReview.
Input fields forSubmitPullRequestReviewInput
| Name | Description |
|---|---|
| The text field to set on the Pull Request Review. |
| A unique identifier for the client performing the mutation. |
| The event to send to the Pull Request Review. |
| The Pull Request ID to submit any pending reviews. |
| The Pull Request Review ID to submit. |
TagNamePatternParametersInput
Parameters to be used for the tag_name_pattern rule.
TeamDiscussionCommentOrder
Ways in which team discussion comment connections can be ordered.
Input fields forTeamDiscussionCommentOrder
| Name | Description |
|---|---|
| The direction in which to order nodes. |
| The field by which to order nodes. |
TeamDiscussionOrder
Ways in which team discussion connections can be ordered.
Input fields forTeamDiscussionOrder
| Name | Description |
|---|---|
| The direction in which to order nodes. |
| The field by which to order nodes. |
TeamMemberOrder
Ordering options for team member connections.
Input fields forTeamMemberOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order team members by. |
TeamOrder
Ways in which team connections can be ordered.
Input fields forTeamOrder
| Name | Description |
|---|---|
| The direction in which to order nodes. |
| The field in which to order nodes by. |
TeamRepositoryOrder
Ordering options for team repository connections.
Input fields forTeamRepositoryOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order repositories by. |
TransferEnterpriseOrganizationInput
Autogenerated input type of TransferEnterpriseOrganization.
Input fields forTransferEnterpriseOrganizationInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise where the organization should be transferred. |
| The ID of the organization to transfer. |
TransferIssueInput
Autogenerated input type of TransferIssue.
Input fields forTransferIssueInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Whether to create labels if they don't exist in the target repository (matched by name). |
| The Node ID of the issue to be transferred. |
| The Node ID of the repository the issue should be transferred to. |
UnarchiveProjectV2ItemInput
Autogenerated input type of UnarchiveProjectV2Item.
UnarchiveRepositoryInput
Autogenerated input type of UnarchiveRepository.
UnfollowOrganizationInput
Autogenerated input type of UnfollowOrganization.
UnfollowUserInput
Autogenerated input type of UnfollowUser.
UnlinkProjectV2FromRepositoryInput
Autogenerated input type of UnlinkProjectV2FromRepository.
UnlinkProjectV2FromTeamInput
Autogenerated input type of UnlinkProjectV2FromTeam.
UnlinkRepositoryFromProjectInput
Autogenerated input type of UnlinkRepositoryFromProject.
UnlockLockableInput
Autogenerated input type of UnlockLockable.
UnmarkDiscussionCommentAsAnswerInput
Autogenerated input type of UnmarkDiscussionCommentAsAnswer.
UnmarkFileAsViewedInput
Autogenerated input type of UnmarkFileAsViewed.
UnmarkIssueAsDuplicateInput
Autogenerated input type of UnmarkIssueAsDuplicate.
Input fields forUnmarkIssueAsDuplicateInput
| Name | Description |
|---|---|
| ID of the issue or pull request currently considered canonical/authoritative/original. |
| A unique identifier for the client performing the mutation. |
| ID of the issue or pull request currently marked as a duplicate. |
UnmarkProjectV2AsTemplateInput
Autogenerated input type of UnmarkProjectV2AsTemplate.
UnminimizeCommentInput
Autogenerated input type of UnminimizeComment.
UnpinIssueInput
Autogenerated input type of UnpinIssue.
UnresolveReviewThreadInput
Autogenerated input type of UnresolveReviewThread.
UpdateBranchProtectionRuleInput
Autogenerated input type of UpdateBranchProtectionRule.
Input fields forUpdateBranchProtectionRuleInput
| Name | Description |
|---|---|
| Can this branch be deleted. |
| Are force pushes allowed on this branch. |
| Is branch creation a protected operation. |
| The global relay id of the branch protection rule to be updated. |
| A list of User, Team, or App IDs allowed to bypass force push targeting matching branches. |
| A list of User, Team, or App IDs allowed to bypass pull requests targeting matching branches. |
| A unique identifier for the client performing the mutation. |
| Will new commits pushed to matching branches dismiss pull request review approvals. |
| Can admins override branch protection. |
| Whether users can pull changes from upstream when the branch is locked. Set to |
| Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. |
| The glob-like pattern used to determine matching branches. |
| A list of User, Team, or App IDs allowed to push to matching branches. |
| Whether the most recent push must be approved by someone other than the person who pushed it. |
| Number of approving reviews required to update matching branches. |
| The list of required deployment environments. |
| List of required status check contexts that must pass for commits to be accepted to matching branches. |
| The list of required status checks. |
| Are approving reviews required to update matching branches. |
| Are reviews from code owners required to update matching branches. |
| Are commits required to be signed. |
| Are conversations required to be resolved before merging. |
| Are successful deployments required before merging. |
| Are merge commits prohibited from being pushed to this branch. |
| Are status checks required to update matching branches. |
| Are branches required to be up to date before merging. |
| Is pushing to matching branches restricted. |
| Is dismissal of pull request reviews restricted. |
| A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches. |
UpdateCheckRunInput
Autogenerated input type of UpdateCheckRun.
Input fields forUpdateCheckRunInput
| Name | Description |
|---|---|
| Possible further actions the integrator can perform, which a user may trigger. |
| The node of the check. |
| A unique identifier for the client performing the mutation. |
| The time that the check run finished. |
| The final conclusion of the check. |
| The URL of the integrator's site that has the full details of the check. |
| A reference for the run on the integrator's system. |
| The name of the check. |
| Descriptive details about the run. |
| The node ID of the repository. |
| The time that the check run began. |
| The current status. |
UpdateCheckSuitePreferencesInput
Autogenerated input type of UpdateCheckSuitePreferences.
Input fields forUpdateCheckSuitePreferencesInput
| Name | Description |
|---|---|
| The check suite preferences to modify. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the repository. |
UpdateDiscussionCommentInput
Autogenerated input type of UpdateDiscussionComment.
UpdateDiscussionInput
Autogenerated input type of UpdateDiscussion.
Input fields forUpdateDiscussionInput
| Name | Description |
|---|---|
| The new contents of the discussion body. |
| The Node ID of a discussion category within the same repository to change this discussion to. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion to update. |
| The new discussion title. |
UpdateEnterpriseAdministratorRoleInput
Autogenerated input type of UpdateEnterpriseAdministratorRole.
Input fields forUpdateEnterpriseAdministratorRoleInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the Enterprise which the admin belongs to. |
| The login of a administrator whose role is being changed. |
| The new role for the Enterprise administrator. |
UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput
Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.
Input fields forUpdateEnterpriseAllowPrivateRepositoryForkingSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the allow private repository forking setting. |
| The value for the allow private repository forking policy on the enterprise. |
| The value for the allow private repository forking setting on the enterprise. |
UpdateEnterpriseDefaultRepositoryPermissionSettingInput
Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.
Input fields forUpdateEnterpriseDefaultRepositoryPermissionSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the base repository permission setting. |
| The value for the base repository permission setting on the enterprise. |
UpdateEnterpriseDeployKeySettingInput
Autogenerated input type of UpdateEnterpriseDeployKeySetting.
Input fields forUpdateEnterpriseDeployKeySettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the deploy key setting. |
| The value for the deploy key setting on the enterprise. |
UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput
Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.
Input fields forUpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can change repository visibility setting. |
| The value for the members can change repository visibility setting on the enterprise. |
UpdateEnterpriseMembersCanCreateRepositoriesSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.
Input fields forUpdateEnterpriseMembersCanCreateRepositoriesSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can create repositories setting. |
| Allow members to create internal repositories. Defaults to current value. |
| Allow members to create private repositories. Defaults to current value. |
| Allow members to create public repositories. Defaults to current value. |
| When false, allow member organizations to set their own repository creation member privileges. |
| Value for the members can create repositories setting on the enterprise. Thisor the granular public/private/internal allowed fields (but not both) must be provided. |
UpdateEnterpriseMembersCanDeleteIssuesSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.
Input fields forUpdateEnterpriseMembersCanDeleteIssuesSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can delete issues setting. |
| The value for the members can delete issues setting on the enterprise. |
UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.
Input fields forUpdateEnterpriseMembersCanDeleteRepositoriesSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can delete repositories setting. |
| The value for the members can delete repositories setting on the enterprise. |
UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.
Input fields forUpdateEnterpriseMembersCanInviteCollaboratorsSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can invite collaborators setting. |
| The value for the members can invite collaborators setting on the enterprise. |
UpdateEnterpriseMembersCanMakePurchasesSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.
Input fields forUpdateEnterpriseMembersCanMakePurchasesSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can make purchases setting. |
| The value for the members can make purchases setting on the enterprise. |
UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.
Input fields forUpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can update protected branches setting. |
| The value for the members can update protected branches setting on the enterprise. |
UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.
Input fields forUpdateEnterpriseMembersCanViewDependencyInsightsSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the members can view dependency insights setting. |
| The value for the members can view dependency insights setting on the enterprise. |
UpdateEnterpriseOrganizationProjectsSettingInput
Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.
Input fields forUpdateEnterpriseOrganizationProjectsSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the organization projects setting. |
| The value for the organization projects setting on the enterprise. |
UpdateEnterpriseOwnerOrganizationRoleInput
Autogenerated input type of UpdateEnterpriseOwnerOrganizationRole.
Input fields forUpdateEnterpriseOwnerOrganizationRoleInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the Enterprise which the owner belongs to. |
| The ID of the organization for membership change. |
| The role to assume in the organization. |
UpdateEnterpriseProfileInput
Autogenerated input type of UpdateEnterpriseProfile.
Input fields forUpdateEnterpriseProfileInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The description of the enterprise. |
| The Enterprise ID to update. |
| The location of the enterprise. |
| The name of the enterprise. |
| The URL of the enterprise's website. |
UpdateEnterpriseRepositoryProjectsSettingInput
Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.
Input fields forUpdateEnterpriseRepositoryProjectsSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the repository projects setting. |
| The value for the repository projects setting on the enterprise. |
UpdateEnterpriseTeamDiscussionsSettingInput
Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.
Input fields forUpdateEnterpriseTeamDiscussionsSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the team discussions setting. |
| The value for the team discussions setting on the enterprise. |
UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput
Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting.
Input fields forUpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the two-factor authentication disallowed methods setting. |
| The value for the two-factor authentication disallowed methods setting on the enterprise. |
UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput
Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.
Input fields forUpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the two factor authentication required setting. |
| The value for the two factor authentication required setting on the enterprise. |
UpdateEnvironmentInput
Autogenerated input type of UpdateEnvironment.
Input fields forUpdateEnvironmentInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The node ID of the environment. |
| Whether deployments to this environment can be approved by the user who created the deployment. |
| The ids of users or teams that can approve deployments to this environment. |
| The wait timer in minutes. |
UpdateIpAllowListEnabledSettingInput
Autogenerated input type of UpdateIpAllowListEnabledSetting.
Input fields forUpdateIpAllowListEnabledSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the owner on which to set the IP allow list enabled setting. |
| The value for the IP allow list enabled setting. |
UpdateIpAllowListEntryInput
Autogenerated input type of UpdateIpAllowListEntry.
Input fields forUpdateIpAllowListEntryInput
| Name | Description |
|---|---|
| An IP address or range of addresses in CIDR notation. |
| A unique identifier for the client performing the mutation. |
| The ID of the IP allow list entry to update. |
| Whether the IP allow list entry is active when an IP allow list is enabled. |
| An optional name for the IP allow list entry. |
UpdateIpAllowListForInstalledAppsEnabledSettingInput
Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.
Input fields forUpdateIpAllowListForInstalledAppsEnabledSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the owner. |
| The value for the IP allow list configuration for installed GitHub Apps setting. |
UpdateIssueCommentInput
Autogenerated input type of UpdateIssueComment.
UpdateIssueInput
Autogenerated input type of UpdateIssue.
Input fields forUpdateIssueInput
| Name | Description |
|---|---|
| An array of Node IDs of users for this issue. |
| The body for the issue description. |
| A unique identifier for the client performing the mutation. |
| The ID of the Issue to modify. |
| The ID of the Issue Type for this issue. |
| An array of Node IDs of labels for this issue. |
| The Node ID of the milestone for this issue. |
| An array of Node IDs for projects associated with this issue. |
| The desired issue state. |
| The title for the issue. |
UpdateIssueIssueTypeInput
Autogenerated input type of UpdateIssueIssueType.
UpdateIssueTypeInput
Autogenerated input type of UpdateIssueType.
Input fields forUpdateIssueTypeInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Color for the issue type. |
| The description of the issue type. |
| Whether or not the issue type is enabled for the organization. |
| The ID of the issue type to update. |
| The name of the issue type. |
UpdateLabelInput
Autogenerated input type of UpdateLabel.
Input fields forUpdateLabelInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A 6 character hex code, without the leading #, identifying the updated color of the label. |
| A brief description of the label, such as its purpose. |
| The Node ID of the label to be updated. |
| The updated name of the label. |
UpdateNotificationRestrictionSettingInput
Autogenerated input type of UpdateNotificationRestrictionSetting.
Input fields forUpdateNotificationRestrictionSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the owner on which to set the restrict notifications setting. |
| The value for the restrict notifications setting. |
UpdateOrganizationAllowPrivateRepositoryForkingSettingInput
Autogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting.
Input fields forUpdateOrganizationAllowPrivateRepositoryForkingSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Enable forking of private repositories in the organization?. |
| The ID of the organization on which to set the allow private repository forking setting. |
UpdateOrganizationWebCommitSignoffSettingInput
Autogenerated input type of UpdateOrganizationWebCommitSignoffSetting.
Input fields forUpdateOrganizationWebCommitSignoffSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the organization on which to set the web commit signoff setting. |
| Enable signoff on web-based commits for repositories in the organization?. |
UpdateParametersInput
Only allow users with bypass permission to update matching refs.
Input fields forUpdateParametersInput
| Name | Description |
|---|---|
| Branch can pull changes from its upstream repository. |
UpdatePatreonSponsorabilityInput
Autogenerated input type of UpdatePatreonSponsorability.
Input fields forUpdatePatreonSponsorabilityInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Whether Patreon tiers should be shown on the GitHub Sponsors profile page,allowing potential sponsors to make their payment through Patreon instead of GitHub. |
| The username of the organization with the GitHub Sponsors profile, if any.Defaults to the GitHub Sponsors profile for the authenticated user if omitted. |
UpdateProjectCardInput
Autogenerated input type of UpdateProjectCard.
UpdateProjectColumnInput
Autogenerated input type of UpdateProjectColumn.
UpdateProjectInput
Autogenerated input type of UpdateProject.
Input fields forUpdateProjectInput
| Name | Description |
|---|---|
| The description of project. |
| A unique identifier for the client performing the mutation. |
| The name of project. |
| The Project ID to update. |
| Whether the project is public or not. |
| Whether the project is open or closed. |
UpdateProjectV2CollaboratorsInput
Autogenerated input type of UpdateProjectV2Collaborators.
Input fields forUpdateProjectV2CollaboratorsInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The collaborators to update. |
| The ID of the project to update the collaborators for. |
UpdateProjectV2DraftIssueInput
Autogenerated input type of UpdateProjectV2DraftIssue.
Input fields forUpdateProjectV2DraftIssueInput
| Name | Description |
|---|---|
| The IDs of the assignees of the draft issue. |
| The body of the draft issue. |
| A unique identifier for the client performing the mutation. |
| The ID of the draft issue to update. |
| The title of the draft issue. |
UpdateProjectV2FieldInput
Autogenerated input type of UpdateProjectV2Field.
Input fields forUpdateProjectV2FieldInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the field to update. |
| Configuration for an iteration field. |
| The name to update. |
| Options for a field of type SINGLE_SELECT. If empty, no changes will be madeto the options. If values are present, they will overwrite the existingoptions for the field. |
UpdateProjectV2Input
Autogenerated input type of UpdateProjectV2.
Input fields forUpdateProjectV2Input
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Set the project to closed or open. |
| The ID of the Project to update. |
| Set the project to public or private. |
| Set the readme description of the project. |
| Set the short description of the project. |
| Set the title of the project. |
UpdateProjectV2ItemFieldValueInput
Autogenerated input type of UpdateProjectV2ItemFieldValue.
Input fields forUpdateProjectV2ItemFieldValueInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the field to be updated. |
| The ID of the item to be updated. |
| The ID of the Project. |
| The value which will be set on the field. |
UpdateProjectV2ItemPositionInput
Autogenerated input type of UpdateProjectV2ItemPosition.
Input fields forUpdateProjectV2ItemPositionInput
| Name | Description |
|---|---|
| The ID of the item to position this item after. If omitted or set to null the item will be moved to top. |
| A unique identifier for the client performing the mutation. |
| The ID of the item to be moved. |
| The ID of the Project. |
UpdateProjectV2StatusUpdateInput
Autogenerated input type of UpdateProjectV2StatusUpdate.
Input fields forUpdateProjectV2StatusUpdateInput
| Name | Description |
|---|---|
| The body of the status update. |
| A unique identifier for the client performing the mutation. |
| The start date of the status update. |
| The status of the status update. |
| The ID of the status update to be updated. |
| The target date of the status update. |
UpdatePullRequestBranchInput
Autogenerated input type of UpdatePullRequestBranch.
Input fields forUpdatePullRequestBranchInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The head ref oid for the upstream branch. |
| The Node ID of the pull request. |
| The update branch method to use. If omitted, defaults to 'MERGE'. |
UpdatePullRequestInput
Autogenerated input type of UpdatePullRequest.
Input fields forUpdatePullRequestInput
| Name | Description |
|---|---|
| An array of Node IDs of users for this pull request. |
| The name of the branch you want your changes pulled into. This should be an existing branchon the current repository. |
| The contents of the pull request. |
| A unique identifier for the client performing the mutation. |
| An array of Node IDs of labels for this pull request. |
| Indicates whether maintainers can modify the pull request. |
| The Node ID of the milestone for this pull request. |
| An array of Node IDs for projects associated with this pull request. |
| The Node ID of the pull request. |
| The target state of the pull request. |
| The title of the pull request. |
UpdatePullRequestReviewCommentInput
Autogenerated input type of UpdatePullRequestReviewComment.
UpdatePullRequestReviewInput
Autogenerated input type of UpdatePullRequestReview.
UpdateRefInput
Autogenerated input type of UpdateRef.
Input fields forUpdateRefInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Permit updates of branch Refs that are not fast-forwards?. |
| The GitObjectID that the Ref shall be updated to target. |
| The Node ID of the Ref to be updated. |
UpdateRefsInput
Autogenerated input type of UpdateRefs.
Input fields forUpdateRefsInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A list of ref updates. |
| The Node ID of the repository. |
UpdateRepositoryInput
Autogenerated input type of UpdateRepository.
Input fields forUpdateRepositoryInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A new description for the repository. Pass an empty string to erase the existing description. |
| Indicates if the repository should have the discussions feature enabled. |
| Indicates if the repository should have the issues feature enabled. |
| Indicates if the repository should have the project boards feature enabled. |
| Indicates if the repository displays a Sponsor button for financial contributions. |
| Indicates if the repository should have the wiki feature enabled. |
| The URL for a web page about this repository. Pass an empty string to erase the existing URL. |
| The new name of the repository. |
| The ID of the repository to update. |
| Whether this repository should be marked as a template such that anyone whocan access it can create new repositories with the same files and directory structure. |
UpdateRepositoryRulesetInput
Autogenerated input type of UpdateRepositoryRuleset.
Input fields forUpdateRepositoryRulesetInput
| Name | Description |
|---|---|
| A list of actors that are allowed to bypass rules in this ruleset. |
| A unique identifier for the client performing the mutation. |
| The list of conditions for this ruleset. |
| The enforcement level for this ruleset. |
| The name of the ruleset. |
| The global relay id of the repository ruleset to be updated. |
| The list of rules for this ruleset. |
| The target of the ruleset. |
UpdateRepositoryWebCommitSignoffSettingInput
Autogenerated input type of UpdateRepositoryWebCommitSignoffSetting.
Input fields forUpdateRepositoryWebCommitSignoffSettingInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the repository to update. |
| Indicates if the repository should require signoff on web-based commits. |
UpdateSponsorshipPreferencesInput
Autogenerated input type of UpdateSponsorshipPreferences.
Input fields forUpdateSponsorshipPreferencesInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Specify whether others should be able to see that the sponsor is sponsoringthe sponsorable. Public visibility still does not reveal which tier is used. |
| Whether the sponsor should receive email updates from the sponsorable. |
| The ID of the user or organization who is acting as the sponsor, paying forthe sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, payingfor the sponsorship. Required if sponsorId is not given. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. |
UpdateSubscriptionInput
Autogenerated input type of UpdateSubscription.
Input fields forUpdateSubscriptionInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new state of the subscription. |
| The Node ID of the subscribable object to modify. |
UpdateTeamDiscussionCommentInput
Autogenerated input type of UpdateTeamDiscussionComment.
UpdateTeamDiscussionInput
Autogenerated input type of UpdateTeamDiscussion.
Input fields forUpdateTeamDiscussionInput
| Name | Description |
|---|---|
| The updated text of the discussion. |
| The current version of the body content. If provided, this update operationwill be rejected if the given version does not match the latest version on the server. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion to modify. |
| If provided, sets the pinned state of the updated discussion. |
| The updated title of the discussion. |
UpdateTeamReviewAssignmentInput
Autogenerated input type of UpdateTeamReviewAssignment.
Input fields forUpdateTeamReviewAssignmentInput
| Name | Description |
|---|---|
| The algorithm to use for review assignment. |
| A unique identifier for the client performing the mutation. |
| Count any members whose review has already been requested against the required number of members assigned to review. |
| Turn on or off review assignment. |
| An array of team member IDs to exclude. |
| The Node ID of the team to update review assignments of. |
| Include the members of any child teams when assigning. |
| Notify the entire team of the PR if it is delegated. |
| Remove the team review request when assigning. |
| The number of team members to assign. |
UpdateTeamsRepositoryInput
Autogenerated input type of UpdateTeamsRepository.
Input fields forUpdateTeamsRepositoryInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Permission that should be granted to the teams. |
| Repository ID being granted access to. |
| A list of teams being granted access. Limit: 10. |
UpdateTopicsInput
Autogenerated input type of UpdateTopics.
Input fields forUpdateTopicsInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the repository. |
| An array of topic names. |
UpdateUserListInput
Autogenerated input type of UpdateUserList.
Input fields forUpdateUserListInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| A description of the list. |
| Whether or not the list is private. |
| The ID of the list to update. |
| The name of the list. |
UpdateUserListsForItemInput
Autogenerated input type of UpdateUserListsForItem.
Input fields forUpdateUserListsForItemInput
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The item to add to the list. |
| The lists to which this item should belong. |
| The suggested lists to create and add this item to. |
UserStatusOrder
Ordering options for user status connections.
Input fields forUserStatusOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order user statuses by. |
VerifiableDomainOrder
Ordering options for verifiable domain connections.
Input fields forVerifiableDomainOrder
| Name | Description |
|---|---|
| The ordering direction. |
| The field to order verifiable domains by. |
VerifyVerifiableDomainInput
Autogenerated input type of VerifyVerifiableDomain.
WorkflowFileReferenceInput
A workflow that must run for this rule to pass.
WorkflowRunOrder
Ways in which lists of workflow runs can be ordered upon return.
Input fields forWorkflowRunOrder
| Name | Description |
|---|---|
| The direction in which to order workflow runs by the specified field. |
| The field by which to order workflows. |
WorkflowsParametersInput
Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
Input fields forWorkflowsParametersInput
| Name | Description |
|---|---|
| Allow repositories and branches to be created if a check would otherwise prohibit it. |
| Workflows that must pass for this rule to pass. |