入力オブジェクトについて
入力オブジェクトは、オブジェクトを定義する一連の入力フィールドが含まれているため、"構成可能なオブジェクト" ということができます。
たとえば、CommitAuthor
では emails
というフィールドを受け取ります。 emails
に値を指定すると、そのメール アドレスを含む User
オブジェクトのリストに CommitAuthor
が変換されます。 オブジェクトには入力オブジェクトがある場合があるのに対して、ミューテーションには入力オブジェクトが必要であることに注意してください。
詳しくは、「GraphQLでの呼び出しの作成」を参照してください。
AbortQueuedMigrationsInput
Autogenerated input type of AbortQueuedMigrations.
AddAssigneesToAssignableInput
Autogenerated input type of AddAssigneesToAssignable.
AddCommentInput
Autogenerated input type of AddComment.
AddDiscussionCommentInput
Autogenerated input type of AddDiscussionComment.
AddDiscussionCommentInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
AddEnterpriseAdminInput
Autogenerated input type of AddEnterpriseAdmin.
AddEnterpriseOrganizationMemberInput
Autogenerated input type of AddEnterpriseOrganizationMember.
AddEnterpriseOrganizationMemberInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise which owns the organization. |
| The ID of the organization the users will be added to. |
| The role to assign the users in the organization. |
| The IDs of the enterprise members to add. |
AddLabelsToLabelableInput
Autogenerated input type of AddLabelsToLabelable.
AddProjectCardInput
Autogenerated input type of AddProjectCard.
AddProjectColumnInput
Autogenerated input type of AddProjectColumn.
AddProjectV2DraftIssueInput
Autogenerated input type of AddProjectV2DraftIssue.
AddProjectV2DraftIssueInput
の入力フィールド
名前 | 説明 |
---|---|
| The IDs of the assignees of the draft issue. |
| The body of the draft issue. |
| A unique identifier for the client performing the mutation. |
| The ID of the Project to add the draft issue to. |
| The title of the draft issue. A project item can also be created by providing the URL of an Issue or Pull Request if you have access. |
AddProjectV2ItemByIdInput
Autogenerated input type of AddProjectV2ItemById.
AddPullRequestReviewCommentInput
Autogenerated input type of AddPullRequestReviewComment.
AddPullRequestReviewCommentInput
の入力フィールド
名前 | 説明 |
---|---|
| The text of the comment. This field is required Upcoming Change on 2023-10-01 UTC
Description: |
| A unique identifier for the client performing the mutation. |
| The SHA of the commit to comment on. Upcoming Change on 2023-10-01 UTC
Description: |
| The comment id to reply to. Upcoming Change on 2023-10-01 UTC
Description: |
| The relative path of the file to comment on. Upcoming Change on 2023-10-01 UTC
Description: |
| The line index in the diff to comment on. Upcoming Change on 2023-10-01 UTC
Description: |
| The node ID of the pull request reviewing Upcoming Change on 2023-10-01 UTC
Description: |
| The Node ID of the review to modify. Upcoming Change on 2023-10-01 UTC
Description: |
AddPullRequestReviewInput
Autogenerated input type of AddPullRequestReview.
AddPullRequestReviewInput
の入力フィールド
名前 | 説明 |
---|---|
| The contents of the review body comment. |
| A unique identifier for the client performing the mutation. |
| The review line comments. Upcoming Change on 2023-10-01 UTC
Description: |
| 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.
AddPullRequestReviewThreadInput
の入力フィールド
名前 | 説明 |
---|---|
| Body of the thread's first comment. |
| A unique identifier for the client performing the mutation. |
| The line of the blob to which the thread refers, required for line-level threads. The end of the line range for multi-line comments. |
| Path to the file being commented on. |
| The node ID of the pull request reviewing. |
| The Node ID of the review to modify. |
| The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range. |
| The first line of the range to which the comment refers. |
| The side of the diff on which the start line resides. |
| The level at which the comments in the corresponding thread are targeted, can be a diff line or a file. |
AddReactionInput
Autogenerated input type of AddReaction.
AddReactionInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
AddUpvoteInput
Autogenerated input type of AddUpvote.
AddVerifiableDomainInput
Autogenerated input type of AddVerifiableDomain.
ApproveDeploymentsInput
Autogenerated input type of ApproveDeployments.
ApproveDeploymentsInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| Optional comment for approving deployments. |
| The ids of environments to reject deployments. |
| The node ID of the workflow run containing the pending deployments. |
ApproveVerifiableDomainInput
Autogenerated input type of ApproveVerifiableDomain.
ArchiveProjectV2ItemInput
Autogenerated input type of ArchiveProjectV2Item.
ArchiveRepositoryInput
Autogenerated input type of ArchiveRepository.
AuditLogOrder
Ordering options for Audit Log connections.
AuditLogOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order Audit Logs by. |
ChangeUserStatusInput
Autogenerated input type of ChangeUserStatus.
ChangeUserStatusInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CheckAnnotationData
の入力フィールド
名前 | 説明 |
---|---|
| Represents an annotation's information level. |
| The location of the annotation. |
| A short description of the feedback for these lines of code. |
| The path of the file to add an annotation to. |
| Details about this annotation. |
| The title that represents the annotation. |
CheckAnnotationRange
Information from a check run analysis to specific lines of code.
CheckRunAction
Possible further actions the integrator can perform.
CheckRunFilter
The filters that are available when fetching check runs.
CheckRunFilter
の入力フィールド
名前 | 説明 |
---|---|
| Filters the check runs created by this application ID. |
| Filters the check runs by this name. |
| Filters the check runs by this type. |
| Filters the check runs by these conclusions. |
| Filters the check runs by this status. Superceded by statuses. |
| Filters the check runs by this status. Overrides status. |
CheckRunOutput
Descriptive details about the check run.
CheckRunOutput
の入力フィールド
名前 | 説明 |
---|---|
| The annotations that are made as part of the check run. |
| Images attached to the check run output displayed in the GitHub pull request UI. |
| The summary of the check run (supports Commonmark). |
| The details of the check run (supports Commonmark). |
| A title to provide for this check run. |
CheckRunOutputImage
Images attached to the check run output displayed in the GitHub pull request UI.
CheckSuiteAutoTriggerPreference
The auto-trigger preferences that are available for check suites.
CheckSuiteFilter
The filters that are available when fetching check suites.
ClearLabelsFromLabelableInput
Autogenerated input type of ClearLabelsFromLabelable.
ClearProjectV2ItemFieldValueInput
Autogenerated input type of ClearProjectV2ItemFieldValue.
CloneProjectInput
Autogenerated input type of CloneProject.
CloneProjectInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CloneTemplateRepositoryInput
の入力フィールド
名前 | 説明 |
---|---|
| 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. |
CloseDiscussionInput
Autogenerated input type of CloseDiscussion.
CloseDiscussionInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the discussion to be closed. |
| The reason why the discussion is being closed. |
CloseIssueInput
Autogenerated input type of CloseIssue.
CloseIssueInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CommitAuthor
Specifies an author for filtering Git commits.
CommitContributionOrder
Ordering options for commit contribution connections.
CommitContributionOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field by which to order commit contributions. |
CommitMessage
A message to include with a new commit.
CommittableBranch
A git ref for a commit to be appended to.
The ref must be a branch, i.e. its fully qualified name must start
with refs/heads/
(although the input is not required to be fully
qualified).
The Ref may be specified by its global node ID or by the
repositoryNameWithOwner
and branchName
.
Examples
Specify a branch using a global node ID:
{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }
Specify a branch using repositoryNameWithOwner
and branchName
:
{
"repositoryNameWithOwner": "github/graphql-client",
"branchName": "main"
}.
ContributionOrder
Ordering options for contribution connections.
ContributionOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
ConvertProjectCardNoteToIssueInput
Autogenerated input type of ConvertProjectCardNoteToIssue.
ConvertProjectCardNoteToIssueInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CopyProjectV2Input
Autogenerated input type of CopyProjectV2.
CopyProjectV2Input
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| Include draft issues in the new project. |
| The owner ID of the new project. |
| The ID of the source Project to copy. |
| The title of the project. |
CreateAttributionInvitationInput
Autogenerated input type of CreateAttributionInvitation.
CreateAttributionInvitationInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the owner scoping the reattributable data. |
| The Node ID of the account owning the data to reattribute. |
| The Node ID of the account which may claim the data. |
CreateBranchProtectionRuleInput
Autogenerated input type of CreateBranchProtectionRule.
CreateBranchProtectionRuleInput
の入力フィールド
名前 | 説明 |
---|---|
| 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. |
| Whether users can pull changes from upstream when the branch is locked. Set to
|
| Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. |
| The glob-like pattern used to determine matching branches. |
| A list of User, Team, or App IDs allowed to push to matching branches. |
| The global relay id of the repository in which a new branch protection rule should be created in. |
| Whether the most recent push must be approved by someone other than the person who pushed it. |
| Number of approving reviews required to update matching branches. |
| The list of required deployment environments. |
| List of required status check contexts that must pass for commits to be accepted to matching branches. |
| The list of required status checks. |
| Are approving reviews required to update matching branches. |
| Are reviews from code owners required to update matching branches. |
| Are commits required to be signed. |
| Are conversations required to be resolved before merging. |
| Are successful deployments required before merging. |
| Are merge commits prohibited from being pushed to this branch. |
| Are status checks required to update matching branches. |
| Are branches required to be up to date before merging. |
| Is pushing to matching branches restricted. |
| Is dismissal of pull request reviews restricted. |
| A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches. |
CreateCheckRunInput
Autogenerated input type of CreateCheckRun.
CreateCheckRunInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CreateCheckSuiteInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CreateCommitOnBranchInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
Note
CreateDeploymentInput
is available under the Deployments preview. プレビュー期間中、API は通知なしに変更されることがあります。
CreateDeploymentInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
Note
CreateDeploymentStatusInput
is available under the Deployments preview. プレビュー期間中、API は通知なしに変更されることがあります。
CreateDeploymentStatusInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CreateDiscussionInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CreateEnterpriseOrganizationInput
の入力フィールド
名前 | 説明 |
---|---|
| The logins for the administrators of the new organization. |
| The email used for sending billing receipts. |
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise owning the new organization. |
| The login of the new organization. |
| The profile name of the new organization. |
CreateEnvironmentInput
Autogenerated input type of CreateEnvironment.
CreateIpAllowListEntryInput
Autogenerated input type of CreateIpAllowListEntry.
CreateIpAllowListEntryInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CreateIssueInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
Note
CreateLabelInput
is available under the Labels preview. プレビュー期間中、API は通知なしに変更されることがあります。
CreateLabelInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| A 6 character hex code, without the leading #, identifying the color of the label. |
| A brief description of the label, such as its purpose. |
| The name of the label. |
| The Node ID of the repository. |
CreateLinkedBranchInput
Autogenerated input type of CreateLinkedBranch.
CreateLinkedBranchInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| ID of the issue to link to. |
| The name of the new branch. Defaults to issue number and title. |
| The commit SHA to base the new branch on. |
| ID of the repository to create the branch in. Defaults to the issue repository. |
CreateMigrationSourceInput
Autogenerated input type of CreateMigrationSource.
CreateMigrationSourceInput
の入力フィールド
名前 | 説明 |
---|---|
| The migration source access token. |
| A unique identifier for the client performing the mutation. |
| The GitHub personal access token of the user importing to the target repository. |
| The migration source name. |
| The ID of the organization that will own the migration source. |
| The migration source type. |
| The migration source URL, for example |
CreateProjectInput
Autogenerated input type of CreateProject.
CreateProjectInput
の入力フィールド
名前 | 説明 |
---|---|
| The description of project. |
| A unique identifier for the client performing the mutation. |
| The name of project. |
| The owner ID to create the project under. |
| A list of repository IDs to create as linked repositories for the project. |
| The name of the GitHub-provided template. |
CreateProjectV2FieldInput
Autogenerated input type of CreateProjectV2Field.
CreateProjectV2FieldInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The data type of the field. |
| The name of the field. |
| The ID of the Project to create the field in. |
| Options for a single select field. At least one value is required if data_type is SINGLE_SELECT. |
CreateProjectV2Input
Autogenerated input type of CreateProjectV2.
CreateProjectV2Input
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The owner ID to create the project under. |
| The repository to link the project to. |
| The team to link the project to. The team will be granted read permissions. |
| The title of the project. |
CreatePullRequestInput
Autogenerated input type of CreatePullRequest.
CreatePullRequestInput
の入力フィールド
名前 | 説明 |
---|---|
| 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 |
| The Node ID of the head repository. |
| Indicates whether maintainers can modify the pull request. |
| The Node ID of the repository. |
| The title of the pull request. |
CreateRefInput
Autogenerated input type of CreateRef.
CreateRefInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
CreateRepositoryInput
の入力フィールド
名前 | 説明 |
---|---|
| 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. |
CreateTeamDiscussionCommentInput
Autogenerated input type of CreateTeamDiscussionComment.
CreateTeamDiscussionInput
Autogenerated input type of CreateTeamDiscussion.
CreateTeamDiscussionInput
の入力フィールド
名前 | 説明 |
---|---|
| 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. |
DeleteBranchProtectionRuleInput
Autogenerated input type of DeleteBranchProtectionRule.
DeleteDeploymentInput
Autogenerated input type of DeleteDeployment.
DeleteDiscussionCommentInput
Autogenerated input type of DeleteDiscussionComment.
DeleteDiscussionInput
Autogenerated input type of DeleteDiscussion.
DeleteEnvironmentInput
Autogenerated input type of DeleteEnvironment.
DeleteIpAllowListEntryInput
Autogenerated input type of DeleteIpAllowListEntry.
DeleteIssueCommentInput
Autogenerated input type of DeleteIssueComment.
DeleteIssueInput
Autogenerated input type of DeleteIssue.
DeleteLabelInput
Autogenerated input type of DeleteLabel.
Note
DeleteLabelInput
is available under the Labels preview. プレビュー期間中、API は通知なしに変更されることがあります。
DeleteLinkedBranchInput
Autogenerated input type of DeleteLinkedBranch.
DeletePackageVersionInput
Autogenerated input type of DeletePackageVersion.
DeleteProjectCardInput
Autogenerated input type of DeleteProjectCard.
DeleteProjectColumnInput
Autogenerated input type of DeleteProjectColumn.
DeleteProjectInput
Autogenerated input type of DeleteProject.
DeleteProjectV2FieldInput
Autogenerated input type of DeleteProjectV2Field.
DeleteProjectV2Input
Autogenerated input type of DeleteProjectV2.
DeleteProjectV2ItemInput
Autogenerated input type of DeleteProjectV2Item.
DeleteProjectV2WorkflowInput
Autogenerated input type of DeleteProjectV2Workflow.
DeletePullRequestReviewCommentInput
Autogenerated input type of DeletePullRequestReviewComment.
DeletePullRequestReviewInput
Autogenerated input type of DeletePullRequestReview.
DeleteRefInput
Autogenerated input type of DeleteRef.
DeleteTeamDiscussionCommentInput
Autogenerated input type of DeleteTeamDiscussionComment.
DeleteTeamDiscussionInput
Autogenerated input type of DeleteTeamDiscussion.
DeleteVerifiableDomainInput
Autogenerated input type of DeleteVerifiableDomain.
DeploymentOrder
Ordering options for deployment connections.
DeploymentOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order deployments by. |
DisablePullRequestAutoMergeInput
Autogenerated input type of DisablePullRequestAutoMerge.
DiscussionOrder
Ways in which lists of discussions can be ordered upon return.
DiscussionOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
DiscussionPollOptionOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order poll options by. |
DismissPullRequestReviewInput
Autogenerated input type of DismissPullRequestReview.
DismissRepositoryVulnerabilityAlertInput
Autogenerated input type of DismissRepositoryVulnerabilityAlert.
DismissRepositoryVulnerabilityAlertInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The reason the Dependabot alert is being dismissed. |
| The Dependabot alert ID to dismiss. |
DraftPullRequestReviewComment
Specifies a review comment to be left with a Pull Request Review.
DraftPullRequestReviewThread
Specifies a review comment thread to be left with a Pull Request Review.
DraftPullRequestReviewThread
の入力フィールド
名前 | 説明 |
---|---|
| 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.
EnablePullRequestAutoMergeInput
の入力フィールド
名前 | 説明 |
---|---|
| 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. NOTE: when merging with a merge queue any input value for commit message is ignored. |
| Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used. NOTE: when merging with a merge queue any input value for commit headline is ignored. |
| The expected head OID of the pull request. |
| The merge method to use. If omitted, defaults to |
| ID of the pull request to enable auto-merge on. |
EnterpriseAdministratorInvitationOrder
Ordering options for enterprise administrator invitation connections.
EnterpriseAdministratorInvitationOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
The field to order enterprise administrator invitations by. |
EnterpriseMemberOrder
Ordering options for enterprise member connections.
EnterpriseMemberOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order enterprise members by. |
EnterpriseServerInstallationOrder
Ordering options for Enterprise Server installation connections.
EnterpriseServerInstallationOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
The field to order Enterprise Server installations by. |
EnterpriseServerUserAccountEmailOrder
Ordering options for Enterprise Server user account email connections.
EnterpriseServerUserAccountEmailOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
The field to order emails by. |
EnterpriseServerUserAccountOrder
Ordering options for Enterprise Server user account connections.
EnterpriseServerUserAccountOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
The field to order user accounts by. |
EnterpriseServerUserAccountsUploadOrder
Ordering options for Enterprise Server user accounts upload connections.
EnterpriseServerUserAccountsUploadOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
FileAddition
の入力フィールド
名前 | 説明 |
---|---|
| 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") } ] }.
FileChanges
の入力フィールド
名前 | 説明 |
---|---|
| File to add or change. |
| Files to delete. |
FileDeletion
A command to delete the file at the given path as part of a commit.
FileDeletion
の入力フィールド
名前 | 説明 |
---|---|
| The path to delete. |
FollowOrganizationInput
Autogenerated input type of FollowOrganization.
FollowUserInput
Autogenerated input type of FollowUser.
GistOrder
Ordering options for gist connections.
GistOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order repositories by. |
GrantEnterpriseOrganizationsMigratorRoleInput
Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.
GrantEnterpriseOrganizationsMigratorRoleInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
GrantMigratorRoleInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ImportProjectInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
IpAllowListEntryOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
IssueCommentOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
IssueFilters
の入力フィールド
名前 | 説明 |
---|---|
| 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.
IssueOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
LabelOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
LanguageOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order languages by. |
LinkProjectV2ToRepositoryInput
Autogenerated input type of LinkProjectV2ToRepository.
LinkProjectV2ToTeamInput
Autogenerated input type of LinkProjectV2ToTeam.
LinkRepositoryToProjectInput
Autogenerated input type of LinkRepositoryToProject.
LockLockableInput
Autogenerated input type of LockLockable.
LockLockableInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| A reason for why the item will be locked. |
| ID of the item to be locked. |
MannequinOrder
Ordering options for mannequins.
MannequinOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order mannequins by. |
MarkDiscussionCommentAsAnswerInput
Autogenerated input type of MarkDiscussionCommentAsAnswer.
MarkFileAsViewedInput
Autogenerated input type of MarkFileAsViewed.
MarkProjectV2AsTemplateInput
Autogenerated input type of MarkProjectV2AsTemplate.
MarkPullRequestReadyForReviewInput
Autogenerated input type of MarkPullRequestReadyForReview.
MergeBranchInput
Autogenerated input type of MergeBranch.
MergeBranchInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
MergePullRequestInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
MilestoneOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order milestones by. |
MinimizeCommentInput
Autogenerated input type of MinimizeComment.
MinimizeCommentInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
MoveProjectCardInput
の入力フィールド
名前 | 説明 |
---|---|
| Place the new card after the card with this id. Pass null to place it at the top. |
| The id of the card to move. |
| A unique identifier for the client performing the mutation. |
| The id of the column to move it into. |
MoveProjectColumnInput
Autogenerated input type of MoveProjectColumn.
OrgEnterpriseOwnerOrder
Ordering options for an organization's enterprise owner connections.
OrgEnterpriseOwnerOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order enterprise owners by. |
OrganizationOrder
Ordering options for organization connections.
OrganizationOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order organizations by. |
PackageFileOrder
Ways in which lists of package files can be ordered upon return.
PackageFileOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
PackageOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
PackageVersionOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ProjectCardImport
An issue or PR and its owning repository to be used in a project card.
ProjectColumnImport
A project column and a list of its issues and PRs.
ProjectColumnImport
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ProjectOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order projects by the specified field. |
| The field in which to order projects by. |
ProjectV2Collaborator
A collaborator to update on a project. Only one of the userId or teamId should be provided.
ProjectV2Collaborator
の入力フィールド
名前 | 説明 |
---|---|
| The role to grant the collaborator. |
| The ID of the team as a collaborator. |
| The ID of the user as a collaborator. |
ProjectV2FieldOrder
Ordering options for project v2 field connections.
ProjectV2FieldOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ProjectV2FieldValue
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ProjectV2ItemFieldValueOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
The field to order the project v2 item field values by. |
ProjectV2ItemOrder
Ordering options for project v2 item connections.
ProjectV2ItemOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order the project v2 items by. |
ProjectV2Order
Ways in which lists of projects can be ordered upon return.
ProjectV2Order
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order projects by the specified field. |
| The field in which to order projects by. |
ProjectV2SingleSelectFieldOptionInput
Represents a single select field option.
ProjectV2ViewOrder
Ordering options for project v2 view connections.
ProjectV2ViewOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order the project v2 views by. |
ProjectV2WorkflowOrder
Ordering options for project v2 workflows connections.
ProjectV2WorkflowOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order the project v2 workflows by. |
PullRequestOrder
Ways in which lists of issues can be ordered upon return.
PullRequestOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ReactionOrder
の入力フィールド
名前 | 説明 |
---|---|
| 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.
RefOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order refs by the specified field. |
| The field in which to order refs by. |
RefUpdate
A ref update.
Note
RefUpdate
is available under the Update refs preview update multiple refs in a single operation preview. プレビュー期間中、API は通知なしに変更されることがあります。
RefUpdate
の入力フィールド
名前 | 説明 |
---|---|
| 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 |
RegenerateVerifiableDomainTokenInput
Autogenerated input type of RegenerateVerifiableDomainToken.
RejectDeploymentsInput
Autogenerated input type of RejectDeployments.
RejectDeploymentsInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ReleaseOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order releases by the specified field. |
| The field in which to order releases by. |
RemoveAssigneesFromAssignableInput
Autogenerated input type of RemoveAssigneesFromAssignable.
RemoveEnterpriseAdminInput
Autogenerated input type of RemoveEnterpriseAdmin.
RemoveLabelsFromLabelableInput
Autogenerated input type of RemoveLabelsFromLabelable.
RemoveOutsideCollaboratorInput
Autogenerated input type of RemoveOutsideCollaborator.
RemoveReactionInput
Autogenerated input type of RemoveReaction.
RemoveReactionInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
RemoveUpvoteInput
Autogenerated input type of RemoveUpvote.
ReopenDiscussionInput
Autogenerated input type of ReopenDiscussion.
ReopenIssueInput
Autogenerated input type of ReopenIssue.
ReopenPullRequestInput
Autogenerated input type of ReopenPullRequest.
RepositoryInvitationOrder
Ordering options for repository invitation connections.
RepositoryInvitationOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order repository invitations by. |
RepositoryMigrationOrder
Ordering options for repository migrations.
RepositoryMigrationOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order repository migrations by. |
RepositoryOrder
Ordering options for repository connections.
RepositoryOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order repositories by. |
RequestReviewsInput
Autogenerated input type of RequestReviews.
RequestReviewsInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
RequiredStatusCheckInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
ResolveReviewThreadInput
Autogenerated input type of ResolveReviewThread.
RevertPullRequestInput
Autogenerated input type of RevertPullRequest.
RevertPullRequestInput
の入力フィールド
名前 | 説明 |
---|---|
| The description of the revert pull request. |
| A unique identifier for the client performing the mutation. |
| Indicates whether the revert pull request should be a draft. |
| The ID of the pull request to revert. |
| The title of the revert pull request. |
RevokeEnterpriseOrganizationsMigratorRoleInput
Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.
RevokeEnterpriseOrganizationsMigratorRoleInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
RevokeMigratorRoleInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
SavedReplyOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order saved replies by. |
StarOrder
Ways in which star connections can be ordered.
StarOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order nodes. |
| The field in which to order nodes by. |
StartOrganizationMigrationInput
Autogenerated input type of StartOrganizationMigration.
StartOrganizationMigrationInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The migration source access token. |
| The URL of the organization to migrate. |
| The ID of the enterprise the target organization belongs to. |
| The name of the target organization. |
StartRepositoryMigrationInput
Autogenerated input type of StartRepositoryMigration.
StartRepositoryMigrationInput
の入力フィールド
名前 | 説明 |
---|---|
| The migration source access token. |
| A unique identifier for the client performing the mutation. |
| Whether to continue the migration on error. Defaults to |
| The signed URL to access the user-uploaded git archive. |
| The GitHub personal access token of the user importing to the target repository. |
| Whether to lock the source repository. |
| The signed URL to access the user-uploaded metadata archive. |
| The ID of the organization that will own the imported repository. |
| The name of the imported repository. |
| Whether to skip migrating releases for the repository. |
| The ID of the migration source. |
| The URL of the source repository. |
| The visibility of the imported repository. |
SubmitPullRequestReviewInput
Autogenerated input type of SubmitPullRequestReview.
SubmitPullRequestReviewInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
TeamDiscussionCommentOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order nodes. |
| The field by which to order nodes. |
TeamDiscussionOrder
Ways in which team discussion connections can be ordered.
TeamDiscussionOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order nodes. |
| The field by which to order nodes. |
TeamMemberOrder
Ordering options for team member connections.
TeamMemberOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order team members by. |
TeamOrder
Ways in which team connections can be ordered.
TeamOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order nodes. |
| The field in which to order nodes by. |
TeamRepositoryOrder
Ordering options for team repository connections.
TeamRepositoryOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order repositories by. |
TransferIssueInput
Autogenerated input type of TransferIssue.
TransferIssueInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| Whether to create labels if they don't exist in the target repository (matched by name). |
| The Node ID of the issue to be transferred. |
| The Node ID of the repository the issue should be transferred to. |
UnarchiveProjectV2ItemInput
Autogenerated input type of UnarchiveProjectV2Item.
UnarchiveRepositoryInput
Autogenerated input type of UnarchiveRepository.
UnfollowOrganizationInput
Autogenerated input type of UnfollowOrganization.
UnfollowUserInput
Autogenerated input type of UnfollowUser.
UnlinkProjectV2FromRepositoryInput
Autogenerated input type of UnlinkProjectV2FromRepository.
UnlinkProjectV2FromTeamInput
Autogenerated input type of UnlinkProjectV2FromTeam.
UnlinkRepositoryFromProjectInput
Autogenerated input type of UnlinkRepositoryFromProject.
UnlockLockableInput
Autogenerated input type of UnlockLockable.
UnmarkDiscussionCommentAsAnswerInput
Autogenerated input type of UnmarkDiscussionCommentAsAnswer.
UnmarkFileAsViewedInput
Autogenerated input type of UnmarkFileAsViewed.
UnmarkIssueAsDuplicateInput
Autogenerated input type of UnmarkIssueAsDuplicate.
UnmarkIssueAsDuplicateInput
の入力フィールド
名前 | 説明 |
---|---|
| ID of the issue or pull request currently considered canonical/authoritative/original. |
| A unique identifier for the client performing the mutation. |
| ID of the issue or pull request currently marked as a duplicate. |
UnmarkProjectV2AsTemplateInput
Autogenerated input type of UnmarkProjectV2AsTemplate.
UnminimizeCommentInput
Autogenerated input type of UnminimizeComment.
UnpinIssueInput
Autogenerated input type of UnpinIssue.
UnresolveReviewThreadInput
Autogenerated input type of UnresolveReviewThread.
UpdateBranchProtectionRuleInput
Autogenerated input type of UpdateBranchProtectionRule.
UpdateBranchProtectionRuleInput
の入力フィールド
名前 | 説明 |
---|---|
| 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. |
| Whether users can pull changes from upstream when the branch is locked. Set to
|
| Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. |
| The glob-like pattern used to determine matching branches. |
| A list of User, Team, or App IDs allowed to push to matching branches. |
| Whether the most recent push must be approved by someone other than the person who pushed it. |
| Number of approving reviews required to update matching branches. |
| The list of required deployment environments. |
| List of required status check contexts that must pass for commits to be accepted to matching branches. |
| The list of required status checks. |
| Are approving reviews required to update matching branches. |
| Are reviews from code owners required to update matching branches. |
| Are commits required to be signed. |
| Are conversations required to be resolved before merging. |
| Are successful deployments required before merging. |
| Are merge commits prohibited from being pushed to this branch. |
| Are status checks required to update matching branches. |
| Are branches required to be up to date before merging. |
| Is pushing to matching branches restricted. |
| Is dismissal of pull request reviews restricted. |
| A list of User, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches. |
UpdateCheckRunInput
Autogenerated input type of UpdateCheckRun.
UpdateCheckRunInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateCheckSuitePreferencesInput
の入力フィールド
名前 | 説明 |
---|---|
| The check suite preferences to modify. |
| A unique identifier for the client performing the mutation. |
| The Node ID of the repository. |
UpdateDiscussionCommentInput
Autogenerated input type of UpdateDiscussionComment.
UpdateDiscussionInput
Autogenerated input type of UpdateDiscussion.
UpdateDiscussionInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the enterprise on which to set the allow private repository forking setting. |
| The value for the allow private repository forking policy on the enterprise. |
| The value for the allow private repository forking setting on the enterprise. |
UpdateEnterpriseDefaultRepositoryPermissionSettingInput
Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.
UpdateEnterpriseDefaultRepositoryPermissionSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanCreateRepositoriesSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanDeleteIssuesSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanMakePurchasesSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseOrganizationProjectsSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseOwnerOrganizationRoleInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseProfileInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseRepositoryProjectsSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseTeamDiscussionsSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateEnvironmentInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateIpAllowListEnabledSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateIpAllowListEntryInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateIpAllowListForInstalledAppsEnabledSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the owner. |
| The value for the IP allow list configuration for installed GitHub Apps setting. |
UpdateIssueCommentInput
Autogenerated input type of UpdateIssueComment.
UpdateIssueInput
Autogenerated input type of UpdateIssue.
UpdateIssueInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
Note
UpdateLabelInput
is available under the Labels preview. プレビュー期間中、API は通知なしに変更されることがあります。
UpdateLabelInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateNotificationRestrictionSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateOrganizationAllowPrivateRepositoryForkingSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| Enable forking of private repositories in the organization?. |
| The ID of the organization on which to set the allow private repository forking setting. |
UpdateOrganizationWebCommitSignoffSettingInput
Autogenerated input type of UpdateOrganizationWebCommitSignoffSetting.
UpdateOrganizationWebCommitSignoffSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the organization on which to set the web commit signoff setting. |
| Enable signoff on web-based commits for repositories in the organization?. |
UpdateProjectCardInput
Autogenerated input type of UpdateProjectCard.
UpdateProjectColumnInput
Autogenerated input type of UpdateProjectColumn.
UpdateProjectInput
Autogenerated input type of UpdateProject.
UpdateProjectInput
の入力フィールド
名前 | 説明 |
---|---|
| The description of project. |
| A unique identifier for the client performing the mutation. |
| The name of project. |
| The Project ID to update. |
| Whether the project is public or not. |
| Whether the project is open or closed. |
UpdateProjectV2CollaboratorsInput
Autogenerated input type of UpdateProjectV2Collaborators.
UpdateProjectV2CollaboratorsInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The collaborators to update. |
| The ID of the project to update the collaborators for. |
UpdateProjectV2DraftIssueInput
Autogenerated input type of UpdateProjectV2DraftIssue.
UpdateProjectV2DraftIssueInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateProjectV2Input
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateProjectV2ItemFieldValueInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateProjectV2ItemPositionInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdatePullRequestBranchInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdatePullRequestInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdatePullRequestReviewInput
Autogenerated input type of UpdatePullRequestReview.
UpdateRefInput
Autogenerated input type of UpdateRef.
UpdateRefInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
Note
UpdateRefsInput
is available under the Update refs preview update multiple refs in a single operation preview. プレビュー期間中、API は通知なしに変更されることがあります。
UpdateRefsInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateRepositoryInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| A new description for the repository. Pass an empty string to erase the existing description. |
| Indicates if the repository should have the discussions feature enabled. |
| Indicates if the repository should have the issues feature enabled. |
| Indicates if the repository should have the project boards feature enabled. |
| Indicates if the repository 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. |
UpdateRepositoryWebCommitSignoffSettingInput
Autogenerated input type of UpdateRepositoryWebCommitSignoffSetting.
UpdateRepositoryWebCommitSignoffSettingInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the repository to update. |
| Indicates if the repository should require signoff on web-based commits. |
UpdateSubscriptionInput
Autogenerated input type of UpdateSubscription.
UpdateSubscriptionInput
の入力フィールド
名前 | 説明 |
---|---|
| A unique identifier for the client performing the mutation. |
| The new state of the subscription. |
| The Node ID of the subscribable object to modify. |
UpdateTeamDiscussionCommentInput
Autogenerated input type of UpdateTeamDiscussionComment.
UpdateTeamDiscussionInput
Autogenerated input type of UpdateTeamDiscussion.
UpdateTeamDiscussionInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
Note
UpdateTeamReviewAssignmentInput
is available under the Team review assignments preview. プレビュー期間中、API は通知なしに変更されることがあります。
UpdateTeamReviewAssignmentInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateTeamsRepositoryInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UpdateTopicsInput
の入力フィールド
名前 | 説明 |
---|---|
| 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.
UserStatusOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order user statuses by. |
VerifiableDomainOrder
Ordering options for verifiable domain connections.
VerifiableDomainOrder
の入力フィールド
名前 | 説明 |
---|---|
| The ordering direction. |
| The field to order verifiable domains by. |
VerifyVerifiableDomainInput
Autogenerated input type of VerifyVerifiableDomain.
WorkflowRunOrder
Ways in which lists of workflow runs can be ordered upon return.
WorkflowRunOrder
の入力フィールド
名前 | 説明 |
---|---|
| The direction in which to order workflow runs by the specified field. |
| The field by which to order workflows. |