About input objects
Input objects can be described as "composable objects" because they include a set of input fields that define the object.
For example, CommitAuthor
takes a field called emails
. Providing a value for emails
transforms CommitAuthor
into a list of User
objects containing that email address. Note that objects may have input objects, whereas mutations require input objects.
For more information, see "About mutations."
AbortQueuedMigrationsInput
Autogenerated input type of AbortQueuedMigrations.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the organization that is running the migrations. |
AcceptEnterpriseAdministratorInvitationInput
Autogenerated input type of AcceptEnterpriseAdministratorInvitation.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The id of the invitation being accepted. |
AcceptTopicSuggestionInput
Autogenerated input type of AcceptTopicSuggestion.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The name of the suggested topic. |
| The Node ID of the repository. |
AddAssigneesToAssignableInput
Autogenerated input type of AddAssigneesToAssignable.
Input fields
Name | Description |
---|---|
| The id of the assignable object to add assignees to. |
| The id of users to add as assignees. |
| A unique identifier for the client performing the mutation. |
AddCommentInput
Autogenerated input type of AddComment.
Input fields
Name | Description |
---|---|
| The contents of the comment. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the subject to modify. |
AddDiscussionCommentInput
Autogenerated input type of AddDiscussionComment.
Input fields
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.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion poll option to vote for. |
AddEnterpriseSupportEntitlementInput
Autogenerated input type of AddEnterpriseSupportEntitlement.
Input fields
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 member who will receive the support entitlement. |
AddLabelsToLabelableInput
Autogenerated input type of AddLabelsToLabelable.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ids of the labels to add. |
| The id of the labelable object to add labels to. |
AddProjectCardInput
Autogenerated input type of AddProjectCard.
Input fields
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.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The name of the column. |
| The Node ID of the project. |
AddProjectDraftIssueInput
Autogenerated input type of AddProjectDraftIssue.
Input fields
Name | Description |
---|---|
| The IDs of the assignees of the draft issue. Upcoming Change on 2022-10-01 UTC
Description: |
| The body of the draft issue. Upcoming Change on 2022-10-01 UTC
Description: |
| A unique identifier for the client performing the mutation. |
| The ID of the Project to add the draft issue to. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
| The title of the draft issue. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
AddProjectNextItemInput
Autogenerated input type of AddProjectNextItem.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The content id of the item (Issue or PullRequest). This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
| The ID of the Project to add the item to. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
AddProjectV2DraftIssueInput
Autogenerated input type of AddProjectV2DraftIssue.
Input fields
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. |
AddProjectV2ItemByIdInput
Autogenerated input type of AddProjectV2ItemById.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The id of the Issue or Pull Request to add. |
| The ID of the Project to add the item to. |
AddPullRequestReviewCommentInput
Autogenerated input type of AddPullRequestReviewComment.
Input fields
Name | Description |
---|---|
| The text of the comment. |
| A unique identifier for the client performing the mutation. |
| The SHA of the commit to comment on. |
| The comment id to reply to. |
| The relative path of the file to comment on. |
| The line index in the diff to comment on. |
| The node ID of the pull request reviewing. |
| The Node ID of the review to modify. |
AddPullRequestReviewInput
Autogenerated input type of AddPullRequestReview.
Input fields
Name | Description |
---|---|
| The contents of the review body comment. |
| A unique identifier for the client performing the mutation. |
| The review line comments. |
| 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
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. 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. |
AddReactionInput
Autogenerated input type of AddReaction.
Input fields
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.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Starrable ID to star. |
AddUpvoteInput
Autogenerated input type of AddUpvote.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion or comment to upvote. |
AddVerifiableDomainInput
Autogenerated input type of AddVerifiableDomain.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The URL of the domain. |
| The ID of the owner to add the domain to. |
ApproveDeploymentsInput
Autogenerated input type of ApproveDeployments.
Input fields
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.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the verifiable domain to approve. |
ArchiveRepositoryInput
Autogenerated input type of ArchiveRepository.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the repository to mark as archived. |
AuditLogOrder
Ordering options for Audit Log connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order Audit Logs by. |
CancelEnterpriseAdminInvitationInput
Autogenerated input type of CancelEnterpriseAdminInvitation.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the pending enterprise administrator invitation. |
CancelSponsorshipInput
Autogenerated input type of CancelSponsorship.
Input fields
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 for the sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, paying for 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
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. If omitted, the status will be publicly visible. |
CheckAnnotationData
Information from a check run analysis to specific lines of code.
Input fields
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.
Input fields
Name | Description |
---|---|
| The ending column of the range. |
| The ending line of the range. |
| The starting column of the range. |
| The starting line of the range. |
CheckRunAction
Possible further actions the integrator can perform.
Input fields
Name | Description |
---|---|
| A short explanation of what this action would do. |
| A reference for the action on the integrator's system. |
| The text to be displayed on a button in the web UI. |
CheckRunFilter
The filters that are available when fetching check runs.
Input fields
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 this status. |
CheckRunOutput
Descriptive details about the check run.
Input fields
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.
Input fields
Name | Description |
---|---|
| The alternative text for the image. |
| A short image description. |
| The full URL of the image. |
CheckSuiteAutoTriggerPreference
The auto-trigger preferences that are available for check suites.
Input fields
Name | Description |
---|---|
| The node ID of the application that owns the check suite. |
| Set to |
CheckSuiteFilter
The filters that are available when fetching check suites.
Input fields
Name | Description |
---|---|
| Filters the check suites created by this application ID. |
| Filters the check suites by this name. |
ClearLabelsFromLabelableInput
Autogenerated input type of ClearLabelsFromLabelable.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The id of the labelable object to clear the labels from. |
CloneProjectInput
Autogenerated input type of CloneProject.
Input fields
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
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. Defaults to 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. |
CloseIssueInput
Autogenerated input type of CloseIssue.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the issue to be closed. |
| The reason the issue is to be closed. |
ClosePullRequestInput
Autogenerated input type of ClosePullRequest.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to be closed. |
CommitAuthor
Specifies an author for filtering Git commits.
Input fields
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 user will be returned. This field takes precedence over emails. |
CommitContributionOrder
Ordering options for commit contribution connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field by which to order commit contributions. |
CommitMessage
A message to include with a new commit.
Input fields
Name | Description |
---|---|
| The body of the message. |
| The headline of the message. |
CommittableBranch
A git ref for a commit to be appended to.
The ref must be a branch, i.e. its fully qualified name must start
with refs/heads/
(although the input is not required to be fully
qualified).
The Ref may be specified by its global node ID or by the repository nameWithOwner and branch name.
Examples
Specify a branch using a global node ID:
{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }
Specify a branch using nameWithOwner and branch name:
{
"nameWithOwner": "github/graphql-client",
"branchName": "main"
}.
Input fields
Name | Description |
---|---|
| The unqualified name of the branch to append the commit to. |
| The Node ID of the Ref to be updated. |
| The nameWithOwner of the repository to commit to. |
ContributionOrder
Ordering options for contribution connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
ConvertProjectCardNoteToIssueInput
Autogenerated input type of ConvertProjectCardNoteToIssue.
Input fields
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. |
ConvertPullRequestToDraftInput
Autogenerated input type of ConvertPullRequestToDraft.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to convert to draft. |
CreateBranchProtectionRuleInput
Autogenerated input type of CreateBranchProtectionRule.
Input fields
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 overwrite branch protection. |
| 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. |
| Number of approving reviews required to update matching branches. |
| 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 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
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
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
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.
Preview notice
CreateDeploymentInput
is available under the Deployments preview. During the preview period, the API may change without notice.
Input fields
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 required contexts, pass an empty array. Defaults to all unique contexts. |
| Specifies a task to execute. |
CreateDeploymentStatusInput
Autogenerated input type of CreateDeploymentStatus.
Preview notice
CreateDeploymentStatusInput
is available under the Deployments preview. During the preview period, the API may change without notice.
Input fields
Name | Description |
---|---|
| Adds a new inactive status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. |
| 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 contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. |
| The state of the deployment. |
CreateDiscussionInput
Autogenerated input type of CreateDiscussion.
Input fields
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
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.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The name of the environment. |
| The node ID of the repository. |
CreateIpAllowListEntryInput
Autogenerated input type of CreateIpAllowListEntry.
Input fields
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
Name | Description |
---|---|
| The Node ID for the user assignee 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. |
| 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 Node ID of the repository. |
| The title for the issue. |
CreateLabelInput
Autogenerated input type of CreateLabel.
Preview notice
CreateLabelInput
is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
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. |
CreateMigrationSourceInput
Autogenerated input type of CreateMigrationSource.
Input fields
Name | Description |
---|---|
| The Octoshift 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 Octoshift migration source name. |
| The ID of the organization that will own the Octoshift migration source. |
| The Octoshift migration source type. |
| The Octoshift migration source URL. |
CreateProjectInput
Autogenerated input type of CreateProject.
Input fields
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. |
CreateProjectV2Input
Autogenerated input type of CreateProjectV2.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The owner ID to create the project under. |
| The title of the project. |
CreatePullRequestInput
Autogenerated input type of CreatePullRequest.
Input fields
Name | Description |
---|---|
| The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. |
| 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 requests
in the same network, namespace |
| 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
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
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 team that should be granted access to the new repository. |
| Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure. |
| Indicates the repository's visibility level. |
CreateSponsorsTierInput
Autogenerated input type of CreateSponsorsTier.
Input fields
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 gain read-only access to. Must be owned by an organization. |
| Optional name of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. Necessary if repositoryOwnerLogin is given. Will be ignored if repositoryId is given. |
| Optional login of the organization owner of the private repository that sponsors at this tier should gain read-only access to. Necessary if repositoryName is given. Will be ignored if repositoryId is given. |
| 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
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 sponsoring the 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 for the sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, paying for 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. |
CreateTeamDiscussionCommentInput
Autogenerated input type of CreateTeamDiscussionComment.
Input fields
Name | Description |
---|---|
| The content of the comment. |
| A unique identifier for the client performing the mutation. |
| The ID of the discussion to which the comment belongs. |
CreateTeamDiscussionInput
Autogenerated input type of CreateTeamDiscussion.
Input fields
Name | Description |
---|---|
| The content of the discussion. |
| A unique identifier for the client performing the mutation. |
| If true, restricts the visibility of this discussion to team members and organization admins. If false or not specified, allows any organization member to view this discussion. |
| The ID of the team to which the discussion belongs. |
| The title of the discussion. |
DeclineTopicSuggestionInput
Autogenerated input type of DeclineTopicSuggestion.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The name of the suggested topic. |
| The reason why the suggested topic is declined. |
| The Node ID of the repository. |
DeleteBranchProtectionRuleInput
Autogenerated input type of DeleteBranchProtectionRule.
Input fields
Name | Description |
---|---|
| The global relay id of the branch protection rule to be deleted. |
| A unique identifier for the client performing the mutation. |
DeleteDeploymentInput
Autogenerated input type of DeleteDeployment.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the deployment to be deleted. |
DeleteDiscussionCommentInput
Autogenerated input type of DeleteDiscussionComment.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node id of the discussion comment to delete. |
DeleteDiscussionInput
Autogenerated input type of DeleteDiscussion.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The id of the discussion to delete. |
DeleteEnvironmentInput
Autogenerated input type of DeleteEnvironment.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the environment to be deleted. |
DeleteIpAllowListEntryInput
Autogenerated input type of DeleteIpAllowListEntry.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the IP allow list entry to delete. |
DeleteIssueCommentInput
Autogenerated input type of DeleteIssueComment.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the comment to delete. |
DeleteIssueInput
Autogenerated input type of DeleteIssue.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the issue to delete. |
DeleteLabelInput
Autogenerated input type of DeleteLabel.
Preview notice
DeleteLabelInput
is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the label to be deleted. |
DeletePackageVersionInput
Autogenerated input type of DeletePackageVersion.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the package version to be deleted. |
DeleteProjectCardInput
Autogenerated input type of DeleteProjectCard.
Input fields
Name | Description |
---|---|
| The id of the card to delete. |
| A unique identifier for the client performing the mutation. |
DeleteProjectColumnInput
Autogenerated input type of DeleteProjectColumn.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The id of the column to delete. |
DeleteProjectInput
Autogenerated input type of DeleteProject.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Project ID to update. |
DeleteProjectNextItemInput
Autogenerated input type of DeleteProjectNextItem.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the item to be removed. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
| The ID of the Project from which the item should be removed. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
DeleteProjectV2ItemInput
Autogenerated input type of DeleteProjectV2Item.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the item to be removed. |
| The ID of the Project from which the item should be removed. |
DeletePullRequestReviewCommentInput
Autogenerated input type of DeletePullRequestReviewComment.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the comment to delete. |
DeletePullRequestReviewInput
Autogenerated input type of DeletePullRequestReview.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the pull request review to delete. |
DeleteRefInput
Autogenerated input type of DeleteRef.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the Ref to be deleted. |
DeleteTeamDiscussionCommentInput
Autogenerated input type of DeleteTeamDiscussionComment.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the comment to delete. |
DeleteTeamDiscussionInput
Autogenerated input type of DeleteTeamDiscussion.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The discussion ID to delete. |
DeleteVerifiableDomainInput
Autogenerated input type of DeleteVerifiableDomain.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the verifiable domain to delete. |
DeploymentOrder
Ordering options for deployment connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order deployments by. |
DisablePullRequestAutoMergeInput
Autogenerated input type of DisablePullRequestAutoMerge.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to disable auto merge on. |
DiscussionOrder
Ways in which lists of discussions can be ordered upon return.
Input fields
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
Name | Description |
---|---|
| The ordering direction. |
| The field to order poll options by. |
DismissPullRequestReviewInput
Autogenerated input type of DismissPullRequestReview.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The contents of the pull request review dismissal message. |
| The Node ID of the pull request review to modify. |
DismissRepositoryVulnerabilityAlertInput
Autogenerated input type of DismissRepositoryVulnerabilityAlert.
Input fields
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.
Input fields
Name | Description |
---|---|
| Body of the comment to leave. |
| Path to the file being commented on. |
| Position in the file to leave a comment on. |
DraftPullRequestReviewThread
Specifies a review comment thread to be left with a Pull Request Review.
Input fields
Name | Description |
---|---|
| Body of the comment to leave. |
| The line of the blob to which the thread refers. The end of the line range for multi-line comments. |
| Path to the file being commented on. |
| 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
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, a default message will be used. |
| Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used. |
| The merge method to use. If omitted, defaults to 'MERGE'. |
| ID of the pull request to enable auto-merge on. |
EnterpriseAdministratorInvitationOrder
Ordering options for enterprise administrator invitation connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
The field to order enterprise administrator invitations by. |
EnterpriseMemberOrder
Ordering options for enterprise member connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order enterprise members by. |
EnterpriseServerInstallationOrder
Ordering options for Enterprise Server installation connections.
Input fields
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
Name | Description |
---|---|
| The ordering direction. |
The field to order emails by. |
EnterpriseServerUserAccountOrder
Ordering options for Enterprise Server user account connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
The field to order user accounts by. |
EnterpriseServerUserAccountsUploadOrder
Ordering options for Enterprise Server user accounts upload connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
The field to order user accounts uploads by. |
FileAddition
A command to add a file at the given path with the given contents as part of a commit. Any existing file at that that path will be replaced.
Input fields
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 of
a git commit, modeled as zero or more file additions
and zero or more
file deletions
.
Both fields are optional; omitting both will produce a commit with no file changes.
deletions
and additions
describe changes to files identified
by their path in the git tree using unix-style path separators, i.e.
/
. The root of a git tree is an empty string, so paths are not
slash-prefixed.
path
values must be unique across all additions
and deletions
provided. Any duplication will result in a validation error.
Encoding
File contents must be provided in full for each FileAddition
.
The contents
of a FileAddition
must be encoded using RFC 4648
compliant base64, i.e. correct padding is required and no characters
outside the standard alphabet may be used. Invalid base64
encoding will be rejected with a validation error.
The encoded contents may be binary.
For text files, no assumptions are made about the character encoding of
the file contents (after base64 decoding). No charset transcoding or
line-ending normalization will be performed; it is the client's
responsibility to manage the character encoding of files they provide.
However, for maximum compatibility we recommend using UTF-8 encoding
and ensuring that all files in a repository use a consistent
line-ending convention (\n
or \r\n
), and that all files end
with a newline.
Modeling file changes
Each of the the five types of conceptual changes that can be made in a
git commit can be described using the FileChanges
type as follows:
-
New file addition: create file
hello world\n
at pathdocs/README.txt
:{ "additions" [ { "path": "docs/README.txt", "contents": base64encode("hello world\n") } ] }
-
Existing file modification: change existing
docs/README.txt
to have new contentnew content here\n
:{ "additions" [ { "path": "docs/README.txt", "contents": base64encode("new content here\n") } ] }
-
Existing file deletion: remove existing file
docs/README.txt
. Note that the path is required to exist -- specifying a path that does not exist on the given branch will abort the commit and return an error.{ "deletions" [ { "path": "docs/README.txt" } ] }
-
File rename with no changes: rename
docs/README.txt
with previous contenthello world\n
to 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.txt
with previous contenthello world\n
to a file at pathnewdocs/README.txt
with contentnew contents\n
:{ "deletions" [ { "path": "docs/README.txt", } ], "additions" [ { "path": "newdocs/README.txt", "contents": base64encode("new contents\n") } ] }.
Input fields
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
Name | Description |
---|---|
| The path to delete. |
FollowOrganizationInput
Autogenerated input type of FollowOrganization.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the organization to follow. |
FollowUserInput
Autogenerated input type of FollowUser.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the user to follow. |
GistOrder
Ordering options for gist connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order repositories by. |
GrantEnterpriseOrganizationsMigratorRoleInput
Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.
Input fields
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
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
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
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. |
IpAllowListEntryOrder
Ordering options for IP allow list entry connections.
Input fields
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
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
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 an
integer 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 an
integer 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 subscribed to by viewer. |
IssueOrder
Ways in which lists of issues can be ordered upon return.
Input fields
Name | Description |
---|---|
| The direction in which to order issues by the specified field. |
| The field in which to order issues by. |
LabelOrder
Ways in which lists of labels can be ordered upon return.
Input fields
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
Name | Description |
---|---|
| The ordering direction. |
| The field to order languages by. |
LinkRepositoryToProjectInput
Autogenerated input type of LinkRepositoryToProject.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the Project to link to a Repository. |
| The ID of the Repository to link to a Project. |
LockLockableInput
Autogenerated input type of LockLockable.
Input fields
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. |
MarkDiscussionCommentAsAnswerInput
Autogenerated input type of MarkDiscussionCommentAsAnswer.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion comment to mark as an answer. |
MarkFileAsViewedInput
Autogenerated input type of MarkFileAsViewed.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The path of the file to mark as viewed. |
| The Node ID of the pull request. |
MarkPullRequestReadyForReviewInput
Autogenerated input type of MarkPullRequestReadyForReview.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to be marked as ready for review. |
MergeBranchInput
Autogenerated input type of MergeBranch.
Input fields
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
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. |
MilestoneOrder
Ordering options for milestone connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order milestones by. |
MinimizeCommentInput
Autogenerated input type of MinimizeComment.
Input fields
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
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.
Input fields
Name | Description |
---|---|
| Place the new column after the column with this id. Pass null to place it at the front. |
| A unique identifier for the client performing the mutation. |
| The id of the column to move. |
OrgEnterpriseOwnerOrder
Ordering options for an organization's enterprise owner connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order enterprise owners by. |
OrganizationOrder
Ordering options for organization connections.
Input fields
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
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
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
Name | Description |
---|---|
| The direction in which to order package versions by the specified field. |
| The field in which to order package versions by. |
PinIssueInput
Autogenerated input type of PinIssue.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the issue to be pinned. |
ProjectCardImport
An issue or PR and its owning repository to be used in a project card.
Input fields
Name | Description |
---|---|
| The issue or pull request number. |
| Repository name with owner (owner/repository). |
ProjectColumnImport
A project column and a list of its issues and PRs.
Input fields
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
Name | Description |
---|---|
| The direction in which to order projects by the specified field. |
| The field in which to order projects by. |
ProjectV2FieldOrder
Ordering options for project v2 field connections.
Input fields
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
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. |
ProjectV2ItemFieldValueOrder
Ordering options for project v2 item field value connections.
Input fields
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
Name | Description |
---|---|
| The ordering direction. |
| The field to order the project v2 items by. |
ProjectV2Order
Ways in which lists of projects can be ordered upon return.
Input fields
Name | Description |
---|---|
| The direction in which to order projects by the specified field. |
| The field in which to order projects by. |
ProjectV2ViewOrder
Ordering options for project v2 view connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order the project v2 views by. |
PullRequestOrder
Ways in which lists of issues can be ordered upon return.
Input fields
Name | Description |
---|---|
| The direction in which to order pull requests by the specified field. |
| The field in which to order pull requests by. |
ReactionOrder
Ways in which lists of reactions can be ordered upon return.
Input fields
Name | Description |
---|---|
| The direction in which to order reactions by the specified field. |
| The field in which to order reactions by. |
RefOrder
Ways in which lists of git refs can be ordered upon return.
Input fields
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.
Preview notice
RefUpdate
is available under the Update refs preview. During the preview period, the API may change without notice.
Input fields
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.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set an identity provider. |
RegenerateVerifiableDomainTokenInput
Autogenerated input type of RegenerateVerifiableDomainToken.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the verifiable domain to regenerate the verification token of. |
RejectDeploymentsInput
Autogenerated input type of RejectDeployments.
Input fields
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
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.
Input fields
Name | Description |
---|---|
| The id of the assignable object to remove assignees from. |
| The id of users to remove as assignees. |
| A unique identifier for the client performing the mutation. |
RemoveEnterpriseAdminInput
Autogenerated input type of RemoveEnterpriseAdmin.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Enterprise ID from which to remove the administrator. |
| The login of the user to remove as an administrator. |
RemoveEnterpriseIdentityProviderInput
Autogenerated input type of RemoveEnterpriseIdentityProvider.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise from which to remove the identity provider. |
RemoveEnterpriseOrganizationInput
Autogenerated input type of RemoveEnterpriseOrganization.
Input fields
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.
Input fields
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 member who will lose the support entitlement. |
RemoveLabelsFromLabelableInput
Autogenerated input type of RemoveLabelsFromLabelable.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ids of labels to remove. |
| The id of the Labelable to remove labels from. |
RemoveOutsideCollaboratorInput
Autogenerated input type of RemoveOutsideCollaborator.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the organization to remove the outside collaborator from. |
| The ID of the outside collaborator to remove. |
RemoveReactionInput
Autogenerated input type of RemoveReaction.
Input fields
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.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Starrable ID to unstar. |
RemoveUpvoteInput
Autogenerated input type of RemoveUpvote.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion or comment to remove upvote. |
ReopenIssueInput
Autogenerated input type of ReopenIssue.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the issue to be opened. |
ReopenPullRequestInput
Autogenerated input type of ReopenPullRequest.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the pull request to be reopened. |
RepositoryInvitationOrder
Ordering options for repository invitation connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order repository invitations by. |
RepositoryMigrationOrder
Ordering options for repository migrations.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order repository migrations by. |
RepositoryOrder
Ordering options for repository connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order repositories by. |
RequestReviewsInput
Autogenerated input type of RequestReviews.
Input fields
Name | Description |
---|---|
| 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. |
RequiredStatusCheckInput
Specifies the attributes for a new or updated required status check.
Input fields
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, or use "any" to allow any app to set the status. |
| Status check context that must pass for commits to be accepted to the matching branch. |
RerequestCheckSuiteInput
Autogenerated input type of RerequestCheckSuite.
Input fields
Name | Description |
---|---|
| The Node ID of the check suite. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the repository. |
ResolveReviewThreadInput
Autogenerated input type of ResolveReviewThread.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the thread to resolve. |
RevokeEnterpriseOrganizationsMigratorRoleInput
Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.
Input fields
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
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. |
SavedReplyOrder
Ordering options for saved reply connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order saved replies by. |
SecurityAdvisoryIdentifierFilter
An advisory identifier to filter results on.
Input fields
Name | Description |
---|---|
The identifier type. | |
| The identifier string. Supports exact or partial matching. |
SecurityAdvisoryOrder
Ordering options for security advisory connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order security advisories by. |
SecurityVulnerabilityOrder
Ordering options for security vulnerability connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order security vulnerabilities by. |
SetEnterpriseIdentityProviderInput
Autogenerated input type of SetEnterpriseIdentityProvider.
Input fields
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
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
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
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. |
SponsorOrder
Ordering options for connections to get sponsor entities for GitHub Sponsors.
Input fields
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
Name | Description |
---|---|
| The ordering direction. |
| The field to order sponsorable entities by. |
SponsorsActivityOrder
Ordering options for GitHub Sponsors activity connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order activity by. |
SponsorsTierOrder
Ordering options for Sponsors tiers connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order tiers by. |
SponsorshipNewsletterOrder
Ordering options for sponsorship newsletter connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order sponsorship newsletters by. |
SponsorshipOrder
Ordering options for sponsorship connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order sponsorship by. |
StarOrder
Ways in which star connections can be ordered.
Input fields
Name | Description |
---|---|
| The direction in which to order nodes. |
| The field in which to order nodes by. |
StartRepositoryMigrationInput
Autogenerated input type of StartRepositoryMigration.
Input fields
Name | Description |
---|---|
| The Octoshift migration source access token. |
| A unique identifier for the client performing the mutation. |
| Whether to continue the migration on error. |
| The signed URL to access the user-uploaded git archive. |
| The GitHub personal access token of the user importing to the target 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 Octoshift migration source. |
| The Octoshift migration source repository URL. |
SubmitPullRequestReviewInput
Autogenerated input type of SubmitPullRequestReview.
Input fields
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. |
TeamDiscussionCommentOrder
Ways in which team discussion comment connections can be ordered.
Input fields
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
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
Name | Description |
---|---|
| The ordering direction. |
| The field to order team members by. |
TeamOrder
Ways in which team connections can be ordered.
Input fields
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
Name | Description |
---|---|
| The ordering direction. |
| The field to order repositories by. |
TransferIssueInput
Autogenerated input type of TransferIssue.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the issue to be transferred. |
| The Node ID of the repository the issue should be transferred to. |
UnarchiveRepositoryInput
Autogenerated input type of UnarchiveRepository.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the repository to unarchive. |
UnfollowOrganizationInput
Autogenerated input type of UnfollowOrganization.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the organization to unfollow. |
UnfollowUserInput
Autogenerated input type of UnfollowUser.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the user to unfollow. |
UnlinkRepositoryFromProjectInput
Autogenerated input type of UnlinkRepositoryFromProject.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the Project linked to the Repository. |
| The ID of the Repository linked to the Project. |
UnlockLockableInput
Autogenerated input type of UnlockLockable.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the item to be unlocked. |
UnmarkDiscussionCommentAsAnswerInput
Autogenerated input type of UnmarkDiscussionCommentAsAnswer.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion comment to unmark as an answer. |
UnmarkFileAsViewedInput
Autogenerated input type of UnmarkFileAsViewed.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The path of the file to mark as unviewed. |
| The Node ID of the pull request. |
UnmarkIssueAsDuplicateInput
Autogenerated input type of UnmarkIssueAsDuplicate.
Input fields
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. |
UnminimizeCommentInput
Autogenerated input type of UnminimizeComment.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the subject to modify. |
UnpinIssueInput
Autogenerated input type of UnpinIssue.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the issue to be unpinned. |
UnresolveReviewThreadInput
Autogenerated input type of UnresolveReviewThread.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the thread to unresolve. |
UpdateBranchProtectionRuleInput
Autogenerated input type of UpdateBranchProtectionRule.
Input fields
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 overwrite branch protection. |
| The glob-like pattern used to determine matching branches. |
| A list of User, Team, or App IDs allowed to push to matching branches. |
| Number of approving reviews required to update matching branches. |
| 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 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
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
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.
Input fields
Name | Description |
---|---|
| The new contents of the comment body. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the discussion comment to update. |
UpdateDiscussionInput
Autogenerated input type of UpdateDiscussion.
Input fields
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
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
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 setting on the enterprise. |
UpdateEnterpriseDefaultRepositoryPermissionSettingInput
Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.
Input fields
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. |
UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput
Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.
Input fields
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
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. This or the granular public/private/internal allowed fields (but not both) must be provided. |
UpdateEnterpriseMembersCanDeleteIssuesSettingInput
Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.
Input fields
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
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
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
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
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
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
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
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
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
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
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. |
UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput
Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.
Input fields
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
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The node ID of the environment. |
| 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
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
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
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.
Input fields
Name | Description |
---|---|
| The updated text of the comment. |
| A unique identifier for the client performing the mutation. |
| The ID of the IssueComment to modify. |
UpdateIssueInput
Autogenerated input type of UpdateIssue.
Input fields
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. |
| 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. |
UpdateLabelInput
Autogenerated input type of UpdateLabel.
Preview notice
UpdateLabelInput
is available under the Labels preview. During the preview period, the API may change without notice.
Input fields
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
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
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. |
UpdateProjectCardInput
Autogenerated input type of UpdateProjectCard.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| Whether or not the ProjectCard should be archived. |
| The note of ProjectCard. |
| The ProjectCard ID to update. |
UpdateProjectColumnInput
Autogenerated input type of UpdateProjectColumn.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The name of project column. |
| The ProjectColumn ID to update. |
UpdateProjectDraftIssueInput
Autogenerated input type of UpdateProjectDraftIssue.
Input fields
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. |
UpdateProjectInput
Autogenerated input type of UpdateProject.
Input fields
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. |
UpdateProjectNextInput
Autogenerated input type of UpdateProjectNext.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| Set the project to closed or open. Upcoming Change on 2022-10-01 UTC
Description: |
| Set the readme description of the project. Upcoming Change on 2022-10-01 UTC
Description: |
| The ID of the Project to update. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
| Set the project to public or private. Upcoming Change on 2022-10-01 UTC
Description: |
| Set the short description of the project. Upcoming Change on 2022-10-01 UTC
Description: |
| Set the title of the project. Upcoming Change on 2022-10-01 UTC
Description: |
UpdateProjectNextItemFieldInput
Autogenerated input type of UpdateProjectNextItemField.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The id of the field to be updated. Upcoming Change on 2022-10-01 UTC
Description: |
| The id of the item to be updated. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
| The ID of the Project. This field is required. |
| The value which will be set on the field. This field is required. Upcoming Change on 2022-10-01 UTC
Description: |
UpdateProjectV2DraftIssueInput
Autogenerated input type of UpdateProjectV2DraftIssue.
Input fields
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. |
UpdateProjectV2Input
Autogenerated input type of UpdateProjectV2.
Input fields
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
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
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. |
UpdatePullRequestBranchInput
Autogenerated input type of UpdatePullRequestBranch.
Input fields
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. |
UpdatePullRequestInput
Autogenerated input type of UpdatePullRequest.
Input fields
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 branch on 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.
Input fields
Name | Description |
---|---|
| The text of the comment. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the comment to modify. |
UpdatePullRequestReviewInput
Autogenerated input type of UpdatePullRequestReview.
Input fields
Name | Description |
---|---|
| The contents of the pull request review body. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the pull request review to modify. |
UpdateRefInput
Autogenerated input type of UpdateRef.
Input fields
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.
Preview notice
UpdateRefsInput
is available under the Update refs preview. During the preview period, the API may change without notice.
Input fields
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
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 issues feature enabled. |
| Indicates if the repository should have the project boards feature enabled. |
| 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 who can access it can create new repositories with the same files and directory structure. |
UpdateSponsorshipPreferencesInput
Autogenerated input type of UpdateSponsorshipPreferences.
Input fields
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used. |
| Whether the sponsor should receive email updates from the sponsorable. |
| The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, paying for 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
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.
Input fields
Name | Description |
---|---|
| The updated text of the comment. |
| The current version of the body content. |
| A unique identifier for the client performing the mutation. |
| The ID of the comment to modify. |
UpdateTeamDiscussionInput
Autogenerated input type of UpdateTeamDiscussion.
Input fields
Name | Description |
---|---|
| The updated text of the discussion. |
| The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. |
| 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.
Preview notice
UpdateTeamReviewAssignmentInput
is available under the Team review assignments preview. During the preview period, the API may change without notice.
Input fields
Name | Description |
---|---|
| The algorithm to use for review assignment. |
| A unique identifier for the client performing the mutation. |
| 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. |
| Notify the entire team of the PR if it is delegated. |
| The number of team members to assign. |
UpdateTeamsRepositoryInput
Autogenerated input type of UpdateTeamsRepository.
Input fields
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
Name | Description |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the repository. |
| An array of topic names. |
UserStatusOrder
Ordering options for user status connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order user statuses by. |
VerifiableDomainOrder
Ordering options for verifiable domain connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order verifiable domains by. |
VerifyVerifiableDomainInput
Autogenerated input type of VerifyVerifiableDomain.