入力オブジェクト

入力オブジェクトについて

入力オブジェクトは、オブジェクトを定義する入力フィールドの集合を含むことから、「構成可能オブジェクト」と呼ぶことができます。

たとえば、 CommitAuthorはemailsというフィールドを取ります。 emailsに値を提供すると、CommitAuthorはそのメールアドレスを含むUserオブジェクトのリストに変換されます。オブジェクトは入力オブジェクトを持つこともあるのに対して、ミューテーションは入力オブジェクトを必要とすることに注意してください。

Autogenerated input type of AddDiscussionComment.

Input fields

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

AddEnterpriseSupportEntitlementInput

Autogenerated input type of AddEnterpriseSupportEntitlement.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

login (String!)

The login of a member who will receive the support entitlement.

AddLabelsToLabelableInput

Autogenerated input type of AddLabelsToLabelable.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!]!)

The ids of the labels to add.

labelableId (ID!)

The id of the labelable object to add labels to.

AddProjectCardInput

Autogenerated input type of AddProjectCard.

Input fields

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

AddProjectColumnInput

Autogenerated input type of AddProjectColumn.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the column.

projectId (ID!)

The Node ID of the project.

AddProjectNextItemInput

Autogenerated input type of AddProjectNextItem.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID!)

The content id of the item (Issue or PullRequest).

projectId (ID!)

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

content (ReactionContent!)

The name of the emoji to react with.

subjectId (ID!)

The Node ID of the subject to modify.

AddStarInput

Autogenerated input type of AddStar.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to star.

AddUpvoteInput

Autogenerated input type of AddUpvote.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

AddVerifiableDomainInput

Autogenerated input type of AddVerifiableDomain.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (URI!)

The URL of the domain.

ownerId (ID!)

The ID of the owner to add the domain to.

ApproveDeploymentsInput

Autogenerated input type of ApproveDeployments.

Input fields

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

Name Description

description (String!)

A short explanation of what this action would do.

identifier (String!)

A reference for the action on the integrator's system.

label (String!)

Name Description

alt (String!)

CommittableBranch

A git ref for a commit to be appended to.

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

The Ref may be specified by its global node ID or by the repository nameWithOwner and branch name.

Examples

Specify a branch using a global node ID:

{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }

Specify a branch using nameWithOwner and branch name:

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

Input fields

Name Description

branchName (String)

The unqualified name of the branch to append the commit to.

id (ID)

The Node ID of the Ref to be updated.

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

ContributionOrder

Ordering options for contribution connections.

Input fields

Name Description

direction (OrderDirection!)

The ordering direction.

ConvertProjectCardNoteToIssueInput

Autogenerated input type of ConvertProjectCardNoteToIssue.

Input fields

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

ConvertPullRequestToDraftInput

Autogenerated input type of ConvertPullRequestToDraft.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to convert to draft.

CreateBranchProtectionRuleInput

Autogenerated input type of CreateBranchProtectionRule.

Input fields

Name	Description
`allowsDeletions` (`Boolean`)	Can this branch be deleted.
`allowsForcePushes` (`Boolean`)	Are force pushes allowed on this branch.
`bypassForcePushActorIds` (`[ID!]`)	A list of User or Team IDs allowed to bypass force push targeting matching branches.
`bypassPullRequestActorIds` (`[ID!]`)	A list of User or Team IDs allowed to bypass pull requests targeting matching branches.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`dismissesStaleReviews` (`Boolean`)	Will new commits pushed to matching branches dismiss pull request review approvals.
`isAdminEnforced` (`Boolean`)	Can admins overwrite branch protection.
`pattern` (`String!`)	The glob-like pattern used to determine matching branches.
`pushActorIds` (`[ID!]`)	A list of User, Team or App IDs allowed to push to matching branches.
`repositoryId` (`ID!`)	The global relay id of the repository in which a new branch protection rule should be created in.
`requiredApprovingReviewCount` (`Int`)	Number of approving reviews required to update matching branches.
`requiredStatusCheckContexts` (`[String!]`)	List of required status check contexts that must pass for commits to be accepted to matching branches.
`requiredStatusChecks` (`[RequiredStatusCheckInput!]`)	The list of required status checks.
`requiresApprovingReviews` (`Boolean`)	Are approving reviews required to update matching branches.
`requiresCodeOwnerReviews` (`Boolean`)	Are reviews from code owners required to update matching branches.
`requiresCommitSignatures` (`Boolean`)	Are commits required to be signed.
`requiresConversationResolution` (`Boolean`)	Are conversations required to be resolved before merging.
`requiresLinearHistory` (`Boolean`)	Are merge commits prohibited from being pushed to this branch.
`requiresStatusChecks` (`Boolean`)	Are status checks required to update matching branches.
`requiresStrictStatusChecks` (`Boolean`)	Are branches required to be up to date before merging.
`restrictsPushes` (`Boolean`)	Is pushing to matching branches restricted.
`restrictsReviewDismissals` (`Boolean`)	Is dismissal of pull request reviews restricted.
`reviewDismissalActorIds` (`[ID!]`)	A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

CreateCheckRunInput

Autogenerated input type of CreateCheckRun.

Input fields

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

CreateCheckSuiteInput

Autogenerated input type of CreateCheckSuite.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

headSha (GitObjectID!)

The SHA of the head commit.

repositoryId (ID!)

The Node ID of the repository.

CreateCommitOnBranchInput

Autogenerated input type of CreateCommitOnBranch.

Input fields

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

CreateDeploymentInput

Autogenerated input type of CreateDeployment.

Preview notice

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

Input fields

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

CreateDeploymentStatusInput

Autogenerated input type of CreateDeploymentStatus.

Preview notice

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

Input fields

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

CreateDiscussionInput

Autogenerated input type of CreateDiscussion.

Input fields

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

CreateEnterpriseOrganizationInput

Autogenerated input type of CreateEnterpriseOrganization.

Input fields

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

CreateEnvironmentInput

Autogenerated input type of CreateEnvironment.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the environment.

repositoryId (ID!)

The node ID of the repository.

CreateIpAllowListEntryInput

Autogenerated input type of CreateIpAllowListEntry.

Input fields

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

CreateIssueInput

Autogenerated input type of CreateIssue.

Input fields

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

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
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`color` (`String!`)	A 6 character hex code, without the leading #, identifying the color of the label.
`description` (`String`)	A brief description of the label, such as its purpose.
`name` (`String!`)	The name of the label.
`repositoryId` (`ID!`)	The Node ID of the repository.

CreateProjectInput

Autogenerated input type of CreateProject.

Input fields

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

CreatePullRequestInput

Autogenerated input type of CreatePullRequest.

Input fields

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

CreateRefInput

Autogenerated input type of CreateRef.

Input fields

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

CreateRepositoryInput

Autogenerated input type of CreateRepository.

Input fields

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

CreateSponsorshipInput

Autogenerated input type of CreateSponsorship.

Input fields

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

CreateTeamDiscussionCommentInput

Autogenerated input type of CreateTeamDiscussionComment.

Input fields

Name Description

body (String!)

The content of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

DeleteLabelInput

Autogenerated input type of DeleteLabel.

Preview notice

The contents of the pull request review dismissal message.

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

DismissRepositoryVulnerabilityAlertInput

Autogenerated input type of DismissRepositoryVulnerabilityAlert.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

dismissReason (DismissReason!)

The reason the Dependabot alert is being dismissed.

repositoryVulnerabilityAlertId (ID!)

The Dependabot alert ID to dismiss.

DraftPullRequestReviewComment

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

Input fields

Name Description

body (String!)

Body of the comment to leave.

path (String!)

Path to the file being commented on.

position (Int!)

FileChanges

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

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

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

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

Encoding

File contents must be provided in full for each FileAddition.

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

The encoded contents may be binary.

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

Modeling file changes

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

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

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

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

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

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

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

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

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

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

Input fields

Name Description

additions ([FileAddition!])

File to add or change.

deletions ([FileDeletion!])

Autogenerated input type of ImportProject.

Input fields

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

InviteEnterpriseAdminInput

Autogenerated input type of InviteEnterpriseAdmin.

Input fields

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

IpAllowListEntryOrder

Ordering options for IP allow list entry connections.

Input fields

Name Description

direction (OrderDirection!)

The ordering direction.

field (IpAllowListEntryOrderField!)

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

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

field (IssueCommentOrderField!)

The field in which to order issue comments by.

IssueFilters

Ways in which to filter lists of issues.

Input fields

Name	Description
`assignee` (`String`)	List issues assigned to given name. Pass in `null` for issues with no assigned user, and `*` for issues assigned to any user.
`createdBy` (`String`)	List issues created by given name.
`labels` (`[String!]`)	List issues where the list of label names exist on the issue.
`mentioned` (`String`)	List issues where the given name is mentioned in the issue.
`milestone` (`String`)	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 `null` for issues with no milestone, and `*` for issues that are assigned to any milestone.
`since` (`DateTime`)	List issues that have been updated at or after the given date.
`states` (`[IssueState!]`)	List issues filtered by the list of states given.
`viewerSubscribed` (`Boolean`)	List issues subscribed to by viewer.

repositoryId (ID!)

The ID of the Repository to link to a Project.

LockLockableInput

Autogenerated input type of LockLockable.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockReason (LockReason)

A reason for why the item will be locked.

lockableId (ID!)

ID of the item to be locked.

MarkDiscussionCommentAsAnswerInput

Autogenerated input type of MarkDiscussionCommentAsAnswer.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the discussion comment to mark as an answer.

MarkFileAsViewedInput

Autogenerated input type of MarkFileAsViewed.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

path (String!)

The path of the file to mark as viewed.

pullRequestId (ID!)

The Node ID of the pull request.

MarkPullRequestReadyForReviewInput

Autogenerated input type of MarkPullRequestReadyForReview.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

Name Description

direction (OrderDirection!)

The ordering direction.

field (MilestoneOrderField!)

The field to order milestones by.

MinimizeCommentInput

Autogenerated input type of MinimizeComment.

Input fields

Name Description

classifier (ReportedContentClassifiers!)

The classification of comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the subject to modify.

MoveProjectCardInput

Autogenerated input type of MoveProjectCard.

Input fields

Name	Description
`afterCardId` (`ID`)	Place the new card after the card with this id. Pass null to place it at the top.
`cardId` (`ID!`)	The id of the card to move.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`columnId` (`ID!`)	The id of the column to move it into.

MoveProjectColumnInput

Autogenerated input type of MoveProjectColumn.

Input fields

Name Description

afterColumnId (ID)

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
`afterOid` (`GitObjectID!`)	The value this ref should be updated to.
`beforeOid` (`GitObjectID`)	The value this ref needs to point to before the update.
`force` (`Boolean`)	Force a non fast-forward update.
`name` (`GitRefname!`)	The fully qualified name of the ref to be update. For example `refs/heads/branch-name`.

RegenerateEnterpriseIdentityProviderRecoveryCodesInput

Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

RegenerateVerifiableDomainTokenInput

Autogenerated input type of RegenerateVerifiableDomainToken.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to regenerate the verification token of.

RejectDeploymentsInput

Autogenerated input type of RejectDeployments.

Input fields

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

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`pullRequestId` (`ID!`)	The Node ID of the pull request to modify.
`teamIds` (`[ID!]`)	The Node IDs of the team to request.
`union` (`Boolean`)	Add users to the set rather than replace.
`userIds` (`[ID!]`)	The Node IDs of the user to request.

RequiredStatusCheckInput

Specifies the attributes for a new or updated required status check.

Input fields

Name Description

appId (ID)

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.

context (String!)

Status check context that must pass for commits to be accepted to the matching branch.

RerequestCheckSuiteInput

Autogenerated input type of RerequestCheckSuite.

Input fields

Name Description

checkSuiteId (ID!)

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`digestMethod` (`SamlDigestAlgorithm!`)	The digest algorithm used to sign SAML requests for the identity provider.
`enterpriseId` (`ID!`)	The ID of the enterprise on which to set an identity provider.
`idpCertificate` (`String!`)	The x509 certificate used by the identity provider to sign assertions and responses.
`issuer` (`String`)	The Issuer Entity ID for the SAML identity provider.
`signatureMethod` (`SamlSignatureAlgorithm!`)	The signature algorithm used to sign SAML requests for the identity provider.
`ssoUrl` (`URI!`)	The URL endpoint for the identity provider's SAML SSO.

SetOrganizationInteractionLimitInput

Autogenerated input type of SetOrganizationInteractionLimit.

Input fields

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`expiry` (`RepositoryInteractionLimitExpiry`)	When this limit should expire.
`limit` (`RepositoryInteractionLimit!`)	The limit to set.
`organizationId` (`ID!`)	The ID of the organization to set a limit for.

SetRepositoryInteractionLimitInput

Autogenerated input type of SetRepositoryInteractionLimit.

Input fields

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`expiry` (`RepositoryInteractionLimitExpiry`)	When this limit should expire.
`limit` (`RepositoryInteractionLimit!`)	The limit to set.
`repositoryId` (`ID!`)	The ID of the repository to set a limit for.

SetUserInteractionLimitInput

Autogenerated input type of SetUserInteractionLimit.

Input fields

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`expiry` (`RepositoryInteractionLimitExpiry`)	When this limit should expire.
`limit` (`RepositoryInteractionLimit!`)	The limit to set.
`userId` (`ID!`)	The ID of the user to set a limit for.

SubmitPullRequestReviewInput

Autogenerated input type of SubmitPullRequestReview.

Input fields

Name	Description
`body` (`String`)	The text field to set on the Pull Request Review.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`event` (`PullRequestReviewEvent!`)	The event to send to the Pull Request Review.
`pullRequestId` (`ID`)	The Pull Request ID to submit any pending reviews.
`pullRequestReviewId` (`ID`)	The Pull Request Review ID to submit.

projectId (ID!)

The ID of the Project linked to the Repository.

repositoryId (ID!)

The ID of the Repository linked to the Project.

UnlockLockableInput

Autogenerated input type of UnlockLockable.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockableId (ID!)

Name Description

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.

UpdateDiscussionCommentInput

Autogenerated input type of UpdateDiscussionComment.

Input fields

Name Description

body (String!)

The new contents of the comment body.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentId (ID!)

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enterpriseId` (`ID!`)	The ID of the enterprise on which to set the members can create repositories setting.
`membersCanCreateInternalRepositories` (`Boolean`)	Allow members to create internal repositories. Defaults to current value.
`membersCanCreatePrivateRepositories` (`Boolean`)	Allow members to create private repositories. Defaults to current value.
`membersCanCreatePublicRepositories` (`Boolean`)	Allow members to create public repositories. Defaults to current value.
`membersCanCreateRepositoriesPolicyEnabled` (`Boolean`)	When false, allow member organizations to set their own repository creation member privileges.
`settingValue` (`EnterpriseMembersCanCreateRepositoriesSettingValue`)	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.

UpdateEnterpriseProfileInput

Autogenerated input type of UpdateEnterpriseProfile.

Input fields

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`description` (`String`)	The description of the enterprise.
`enterpriseId` (`ID!`)	The Enterprise ID to update.
`location` (`String`)	The location of the enterprise.
`name` (`String`)	The name of the enterprise.
`websiteUrl` (`String`)	The URL of the enterprise's website.

UpdateEnvironmentInput

Autogenerated input type of UpdateEnvironment.

Input fields

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`environmentId` (`ID!`)	The node ID of the environment.
`reviewers` (`[ID!]`)	The ids of users or teams that can approve deployments to this environment.
`waitTimer` (`Int`)	The wait timer in minutes.

UpdateIpAllowListEnabledSettingInput

Autogenerated input type of UpdateIpAllowListEnabledSetting.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

UpdateIpAllowListEntryInput

Autogenerated input type of UpdateIpAllowListEntry.

Input fields

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

UpdateIpAllowListForInstalledAppsEnabledSettingInput

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the owner.

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

UpdateIssueCommentInput

Autogenerated input type of UpdateIssueComment.

Input fields

Name Description

body (String!)

The updated text of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the IssueComment to modify.

UpdateIssueInput

Autogenerated input type of UpdateIssue.

Input fields

Name	Description
`assigneeIds` (`[ID!]`)	An array of Node IDs of users for this issue.
`body` (`String`)	The body for the issue description.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The ID of the Issue to modify.
`labelIds` (`[ID!]`)	An array of Node IDs of labels for this issue.
`milestoneId` (`ID`)	The Node ID of the milestone for this issue.
`projectIds` (`[ID!]`)	An array of Node IDs for projects associated with this issue.
`state` (`IssueState`)	The desired issue state.
`title` (`String`)	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
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`color` (`String`)	A 6 character hex code, without the leading #, identifying the updated color of the label.
`description` (`String`)	A brief description of the label, such as its purpose.
`id` (`ID!`)	The Node ID of the label to be updated.
`name` (`String`)	The updated name of the label.

UpdateNotificationRestrictionSettingInput

Autogenerated input type of UpdateNotificationRestrictionSetting.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

UpdateOrganizationAllowPrivateRepositoryForkingSettingInput

Autogenerated input type of UpdateOrganizationAllowPrivateRepositoryForkingSetting.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

forkingEnabled (Boolean!)

Enable forking of private repositories in the organization?.

organizationId (ID!)

The ID of the organization on which to set the allow private repository forking setting.

UpdateProjectCardInput

Autogenerated input type of UpdateProjectCard.

Input fields

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`isArchived` (`Boolean`)	Whether or not the ProjectCard should be archived.
`note` (`String`)	The note of ProjectCard.
`projectCardId` (`ID!`)	The ProjectCard ID to update.

UpdateProjectColumnInput

Autogenerated input type of UpdateProjectColumn.

Input fields

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project column.

projectColumnId (ID!)

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

expectedHeadOid (GitObjectID)

The head ref oid for the upstream branch.

pullRequestId (ID!)

The Node ID of the pull request.

UpdatePullRequestInput

Autogenerated input type of UpdatePullRequest.

Input fields

Name	Description
`assigneeIds` (`[ID!]`)	An array of Node IDs of users for this pull request.
`baseRefName` (`String`)	The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.
`body` (`String`)	The contents of the pull request.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`labelIds` (`[ID!]`)	An array of Node IDs of labels for this pull request.
`maintainerCanModify` (`Boolean`)	Indicates whether maintainers can modify the pull request.
`milestoneId` (`ID`)	The Node ID of the milestone for this pull request.
`projectIds` (`[ID!]`)	An array of Node IDs for projects associated with this pull request.
`pullRequestId` (`ID!`)	The Node ID of the pull request.
`state` (`PullRequestUpdateState`)	The target state of the pull request.
`title` (`String`)	The title of the pull request.

UpdatePullRequestReviewCommentInput

Autogenerated input type of UpdatePullRequestReviewComment.

Input fields

Name Description

body (String!)

The text of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

UpdatePullRequestReviewInput

Autogenerated input type of UpdatePullRequestReview.

Input fields

Name Description

body (String!)

The contents of the pull request review body.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

UpdateRefInput

Autogenerated input type of UpdateRef.

Input fields

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`force` (`Boolean`)	Permit updates of branch Refs that are not fast-forwards?.
`oid` (`GitObjectID!`)	The GitObjectID that the Ref shall be updated to target.
`refId` (`ID!`)	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

clientMutationId (String)

A unique identifier for the client performing the mutation.

refUpdates ([RefUpdate!]!)

A list of ref updates.

repositoryId (ID!)

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

state (SubscriptionState!)

The new state of the subscription.

subscribableId (ID!)

The Node ID of the subscribable object to modify.

UpdateTeamDiscussionCommentInput

Autogenerated input type of UpdateTeamDiscussionComment.

Input fields

Name	Description
`body` (`String!`)	The updated text of the comment.
`bodyVersion` (`String`)	The current version of the body content.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The ID of the comment to modify.

UpdateTeamDiscussionInput

Autogenerated input type of UpdateTeamDiscussion.

Input fields

Name	Description
`body` (`String`)	The updated text of the discussion.
`bodyVersion` (`String`)	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.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`id` (`ID!`)	The Node ID of the discussion to modify.
`pinned` (`Boolean`)	If provided, sets the pinned state of the updated discussion.
`title` (`String`)	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
`algorithm` (`TeamReviewAssignmentAlgorithm`)	The algorithm to use for review assignment.
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`enabled` (`Boolean!`)	Turn on or off review assignment.
`excludedTeamMemberIds` (`[ID!]`)	An array of team member IDs to exclude.
`id` (`ID!`)	The Node ID of the team to update review assignments of.
`notifyTeam` (`Boolean`)	Notify the entire team of the PR if it is delegated.
`teamMemberCount` (`Int`)	The number of team members to assign.

UpdateTopicsInput

Autogenerated input type of UpdateTopics.

Input fields

Name Description

clientMutationId (String)

Name Description

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to verify.

入力オブジェクト

ここには以下の内容があります: