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."
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. |
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. |
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. |
AuditLogOrder
Ordering options for Audit Log connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order Audit Logs by. |
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. |
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. |
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. |
CommitContributionOrder
Ordering options for commit contribution connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field by which to order commit contributions. |
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"
}.
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. |
CreateBranchProtectionRuleInput
Autogenerated input type of CreateBranchProtectionRule.
Input fields
Name | Description |
---|---|
| Can this branch be deleted. |
| Are force pushes allowed on this branch. |
| 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. |
| 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 or Team 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. |
CreateContentAttachmentInput
Autogenerated input type of CreateContentAttachment.
Input fields
Name | Description |
---|---|
| The body of the content attachment, which may contain markdown. |
| A unique identifier for the client performing the mutation. |
| The node ID of the content_reference. |
| The title of the content attachment. |
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. |
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. |
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. |
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. |
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. |
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.
DeploymentOrder
Ordering options for deployment connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order deployments by. |
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. |
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. |
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. |
GistOrder
Ordering options for gist connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order repositories by. |
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. |
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 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. |
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. |
MergeBranchInput
Autogenerated input type of MergeBranch.
Input fields
Name | Description |
---|---|
| 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. |
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. |
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. |
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 |
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. |
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. |
RepositoryInvitationOrder
Ordering options for repository invitation connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order repository invitations 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. |
SavedReplyOrder
Ordering options for saved reply connections.
Input fields
Name | Description |
---|---|
| The ordering direction. |
| The field to order saved replies 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. |
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. |
UpdateBranchProtectionRuleInput
Autogenerated input type of UpdateBranchProtectionRule.
Input fields
Name | Description |
---|---|
| Can this branch be deleted. |
| Are force pushes allowed on this branch. |
| The global relay id of the branch protection rule to be updated. |
| 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. |
| 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 or Team 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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |