输入对象

输入对象可描述为“可组合对象”，因为它们包含一组用于定义对象的输入字段。

本文内容

关于输入对象

输入对象可描述为“可组合对象”，因为它们包含一组用于定义对象的输入字段。

例如，CommitAuthor 采用 emails 字段。 为 emails 提供一个值后，可将 CommitAuthor 转换成包含电子邮件地址的 User 对象列表。 注意，对象可能包含输入对象，然而，变更需要输入对象 。

有关详细信息，请参阅“使用 GraphQL 建立调用”。

AbortQueuedMigrationsInput

Autogenerated input type of AbortQueuedMigrations.

输入 AbortQueuedMigrationsInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the organization that is running the migrations.

AbortRepositoryMigrationInput

Autogenerated input type of AbortRepositoryMigration.

输入 AbortRepositoryMigrationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationId (ID!)

The ID of the migration to be aborted.

AcceptEnterpriseAdministratorInvitationInput

Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

输入 AcceptEnterpriseAdministratorInvitationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitationId (ID!)

The id of the invitation being accepted.

AcceptEnterpriseMemberInvitationInput

Autogenerated input type of AcceptEnterpriseMemberInvitation.

输入 AcceptEnterpriseMemberInvitationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitationId (ID!)

The id of the invitation being accepted.

AcceptTopicSuggestionInput

Autogenerated input type of AcceptTopicSuggestion.

输入 AcceptTopicSuggestionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String)

The name of the suggested topic.

Upcoming Change on 2024-04-01 UTC Description: name will be removed. Reason: Suggested topics are no longer supported.

repositoryId (ID)

The Node ID of the repository.

Upcoming Change on 2024-04-01 UTC Description: repositoryId will be removed. Reason: Suggested topics are no longer supported.

AddAssigneesToAssignableInput

Autogenerated input type of AddAssigneesToAssignable.

输入 AddAssigneesToAssignableInput 字段

名称说明

assignableId (ID!)

The id of the assignable object to add assignees to.

assigneeIds ([ID!]!)

The id of users to add as assignees.

clientMutationId (String)

A unique identifier for the client performing the mutation.

AddCommentInput

Autogenerated input type of AddComment.

输入 AddCommentInput 字段

名称说明

body (String!)

The contents of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the subject to modify.

AddDiscussionCommentInput

Autogenerated input type of AddDiscussionComment.

输入 AddDiscussionCommentInput 字段

名称说明

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.

AddDiscussionPollVoteInput

Autogenerated input type of AddDiscussionPollVote.

输入 AddDiscussionPollVoteInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOptionId (ID!)

The Node ID of the discussion poll option to vote for.

AddEnterpriseOrganizationMemberInput

Autogenerated input type of AddEnterpriseOrganizationMember.

输入 AddEnterpriseOrganizationMemberInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise which owns the organization.

organizationId (ID!)

The ID of the organization the users will be added to.

role (OrganizationMemberRole)

The role to assign the users in the organization.

userIds ([ID!]!)

The IDs of the enterprise members to add.

AddEnterpriseSupportEntitlementInput

Autogenerated input type of AddEnterpriseSupportEntitlement.

输入 AddEnterpriseSupportEntitlementInput 字段

名称说明

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.

输入 AddLabelsToLabelableInput 字段

名称说明

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.

输入 AddProjectCardInput 字段

名称说明

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.

输入 AddProjectColumnInput 字段

名称说明

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.

AddProjectV2DraftIssueInput

Autogenerated input type of AddProjectV2DraftIssue.

输入 AddProjectV2DraftIssueInput 字段

名称说明

assigneeIds ([ID!])

The IDs of the assignees of the draft issue.

body (String)

The body of the draft issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to add the draft issue to.

title (String!)

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.

输入 AddProjectV2ItemByIdInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID!)

The id of the Issue or Pull Request to add.

projectId (ID!)

The ID of the Project to add the item to.

AddPullRequestReviewCommentInput

Autogenerated input type of AddPullRequestReviewComment.

输入 AddPullRequestReviewCommentInput 字段

名称说明

body (String)

The text of the comment. This field is required

Upcoming Change on 2023-10-01 UTC Description: body will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitOID (GitObjectID)

The SHA of the commit to comment on.

Upcoming Change on 2023-10-01 UTC Description: commitOID will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

inReplyTo (ID)

The comment id to reply to.

Upcoming Change on 2023-10-01 UTC Description: inReplyTo will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

path (String)

The relative path of the file to comment on.

Upcoming Change on 2023-10-01 UTC Description: path will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

position (Int)

The line index in the diff to comment on.

Upcoming Change on 2023-10-01 UTC Description: position will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestId (ID)

The node ID of the pull request reviewing

Upcoming Change on 2023-10-01 UTC Description: pullRequestId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestReviewId (ID)

The Node ID of the review to modify.

Upcoming Change on 2023-10-01 UTC Description: pullRequestReviewId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

AddPullRequestReviewInput

Autogenerated input type of AddPullRequestReview.

输入 AddPullRequestReviewInput 字段

名称说明

body (String)

The contents of the review body comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

comments ([DraftPullRequestReviewComment])

The review line comments.

Upcoming Change on 2023-10-01 UTC Description: comments will be removed. use the threads argument instead Reason: We are deprecating comment fields that use diff-relative positioning.

commitOID (GitObjectID)

The commit OID the review pertains to.

event (PullRequestReviewEvent)

The event to perform on the pull request review.

pullRequestId (ID!)

The Node ID of the pull request to modify.

threads ([DraftPullRequestReviewThread])

The review line comment threads.

AddPullRequestReviewThreadInput

Autogenerated input type of AddPullRequestReviewThread.

输入 AddPullRequestReviewThreadInput 字段

名称说明

body (String!)

Body of the thread's first comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

line (Int)

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 (String!)

Path to the file being commented on.

pullRequestId (ID)

The node ID of the pull request reviewing.

pullRequestReviewId (ID)

The Node ID of the review to modify.

side (DiffSide)

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.

startLine (Int)

The first line of the range to which the comment refers.

startSide (DiffSide)

The side of the diff on which the start line resides.

subjectType (PullRequestReviewThreadSubjectType)

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

AddPullRequestReviewThreadReplyInput

Autogenerated input type of AddPullRequestReviewThreadReply.

输入 AddPullRequestReviewThreadReplyInput 字段

名称说明

body (String!)

The text of the reply.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID)

The Node ID of the pending review to which the reply will belong.

pullRequestReviewThreadId (ID!)

The Node ID of the thread to which this reply is being written.

AddReactionInput

Autogenerated input type of AddReaction.

输入 AddReactionInput 字段

名称说明

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.

输入 AddStarInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to star.

AddSubIssueInput

Autogenerated input type of AddSubIssue.

输入 AddSubIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The id of the issue.

replaceParent (Boolean)

Option to replace parent issue if one already exists.

subIssueId (ID)

The id of the sub-issue.

subIssueUrl (String)

The url of the sub-issue.

AddUpvoteInput

Autogenerated input type of AddUpvote.

输入 AddUpvoteInput 字段

名称说明

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.

输入 AddVerifiableDomainInput 字段

名称说明

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.

输入 ApproveDeploymentsInput 字段

名称说明

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.

ApproveVerifiableDomainInput

Autogenerated input type of ApproveVerifiableDomain.

输入 ApproveVerifiableDomainInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to approve.

ArchiveProjectV2ItemInput

Autogenerated input type of ArchiveProjectV2Item.

输入 ArchiveProjectV2ItemInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the ProjectV2Item to archive.

projectId (ID!)

The ID of the Project to archive the item from.

ArchiveRepositoryInput

Autogenerated input type of ArchiveRepository.

输入 ArchiveRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to mark as archived.

AuditLogOrder

Ordering options for Audit Log connections.

输入 AuditLogOrder 字段

名称说明

direction (OrderDirection)

The ordering direction.

field (AuditLogOrderField)

The field to order Audit Logs by.

BranchNamePatternParametersInput

Parameters to be used for the branch_name_pattern rule.

输入 BranchNamePatternParametersInput 字段

名称说明

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

BulkSponsorship

Information about a sponsorship to make for a user or organization with a GitHub Sponsors profile, as part of sponsoring many users or organizations at once.

输入 BulkSponsorship 字段

名称说明

amount (Int!)

The amount to pay to the sponsorable in US dollars. Valid values: 1-12000.

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.

CancelEnterpriseAdminInvitationInput

Autogenerated input type of CancelEnterpriseAdminInvitation.

输入 CancelEnterpriseAdminInvitationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitationId (ID!)

The Node ID of the pending enterprise administrator invitation.

CancelEnterpriseMemberInvitationInput

Autogenerated input type of CancelEnterpriseMemberInvitation.

输入 CancelEnterpriseMemberInvitationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitationId (ID!)

The Node ID of the pending enterprise member invitation.

CancelSponsorshipInput

Autogenerated input type of CancelSponsorship.

输入 CancelSponsorshipInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

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.

ChangeUserStatusInput

Autogenerated input type of ChangeUserStatus.

输入 ChangeUserStatusInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

expiresAt (DateTime)

If set, the user status will not be shown after this date.

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

message (String)

A short description of your current status.

organizationId (ID)

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 字段

名称说明

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

location (CheckAnnotationRange!)

The location of the annotation.

message (String!)

A short description of the feedback for these lines of code.

path (String!)

The path of the file to add an annotation to.

rawDetails (String)

Details about this annotation.

title (String)

The title that represents the annotation.

CheckAnnotationRange

Information from a check run analysis to specific lines of code.

输入 CheckAnnotationRange 字段

名称说明

endColumn (Int)

The ending column of the range.

endLine (Int!)

The ending line of the range.

startColumn (Int)

The starting column of the range.

startLine (Int!)

The starting line of the range.

CheckRunAction

Possible further actions the integrator can perform.

输入 CheckRunAction 字段

名称说明

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!)

The text to be displayed on a button in the web UI.

CheckRunFilter

The filters that are available when fetching check runs.

输入 CheckRunFilter 字段

名称说明

appId (Int)

Filters the check runs created by this application ID.

checkName (String)

Filters the check runs by this name.

checkType (CheckRunType)

Filters the check runs by this type.

conclusions ([CheckConclusionState!])

Filters the check runs by these conclusions.

status (CheckStatusState)

Filters the check runs by this status. Superceded by statuses.

statuses ([CheckStatusState!])

Filters the check runs by this status. Overrides status.

CheckRunOutput

Descriptive details about the check run.

输入 CheckRunOutput 字段

名称说明

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

summary (String!)

The summary of the check run (supports Commonmark).

text (String)

The details of the check run (supports Commonmark).

title (String!)

A title to provide for this check run.

CheckRunOutputImage

Images attached to the check run output displayed in the GitHub pull request UI.

输入 CheckRunOutputImage 字段

名称说明

alt (String!)

The alternative text for the image.

caption (String)

A short image description.

imageUrl (URI!)

The full URL of the image.

CheckSuiteAutoTriggerPreference

The auto-trigger preferences that are available for check suites.

输入 CheckSuiteAutoTriggerPreference 字段

名称说明

appId (ID!)

The node ID of the application that owns the check suite.

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

CheckSuiteFilter

The filters that are available when fetching check suites.

输入 CheckSuiteFilter 字段

名称说明

appId (Int)

Filters the check suites created by this application ID.

checkName (String)

Filters the check suites by this name.

ClearLabelsFromLabelableInput

Autogenerated input type of ClearLabelsFromLabelable.

输入 ClearLabelsFromLabelableInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelableId (ID!)

The id of the labelable object to clear the labels from.

ClearProjectV2ItemFieldValueInput

Autogenerated input type of ClearProjectV2ItemFieldValue.

输入 ClearProjectV2ItemFieldValueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to be cleared.

itemId (ID!)

The ID of the item to be cleared.

projectId (ID!)

The ID of the Project.

CloneProjectInput

Autogenerated input type of CloneProject.

输入 CloneProjectInput 字段

名称说明

body (String)

The description of the project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

name (String!)

The name of the project.

public (Boolean)

The visibility of the project, defaults to false (private).

sourceId (ID!)

The source project to clone.

targetOwnerId (ID!)

The owner ID to create the project under.

CloneTemplateRepositoryInput

Autogenerated input type of CloneTemplateRepository.

输入 CloneTemplateRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A short description of the new repository.

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults to copying only the default branch of the template.

name (String!)

The name of the new repository.

ownerId (ID!)

The ID of the owner for the new repository.

repositoryId (ID!)

The Node ID of the template repository.

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

CloseDiscussionInput

Autogenerated input type of CloseDiscussion.

输入 CloseDiscussionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

ID of the discussion to be closed.

reason (DiscussionCloseReason)

The reason why the discussion is being closed.

CloseIssueInput

Autogenerated input type of CloseIssue.

输入 CloseIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

ID of the issue to be closed.

stateReason (IssueClosedStateReason)

The reason the issue is to be closed.

ClosePullRequestInput

Autogenerated input type of ClosePullRequest.

输入 ClosePullRequestInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be closed.

CodeScanningParametersInput

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

输入 CodeScanningParametersInput 字段

名称说明

codeScanningTools ([CodeScanningToolInput!]!)

Tools that must provide code scanning results for this rule to pass.

CodeScanningToolInput

A tool that must provide code scanning results for this rule to pass.

输入 CodeScanningToolInput 字段

名称说明

alertsThreshold (String!)

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts.".

securityAlertsThreshold (String!)

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts.".

tool (String!)

The name of a code scanning tool.

CommitAuthor

Specifies an author for filtering Git commits.

输入 CommitAuthor 字段

名称说明

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user will be returned. This field takes precedence over emails.

CommitAuthorEmailPatternParametersInput

Parameters to be used for the commit_author_email_pattern rule.

输入 CommitAuthorEmailPatternParametersInput 字段

名称说明

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

CommitContributionOrder

Ordering options for commit contribution connections.

输入 CommitContributionOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (CommitContributionOrderField!)

The field by which to order commit contributions.

CommitMessage

A message to include with a new commit.

输入 CommitMessage 字段

名称说明

body (String)

The body of the message.

headline (String!)

The headline of the message.

CommitMessagePatternParametersInput

Parameters to be used for the commit_message_pattern rule.

输入 CommitMessagePatternParametersInput 字段

名称说明

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

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"
}.

输入 CommittableBranch 字段

名称说明

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.

CommitterEmailPatternParametersInput

Parameters to be used for the committer_email_pattern rule.

输入 CommitterEmailPatternParametersInput 字段

名称说明

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

ContributionOrder

Ordering options for contribution connections.

输入 ContributionOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

ConvertProjectCardNoteToIssueInput

Autogenerated input type of ConvertProjectCardNoteToIssue.

输入 ConvertProjectCardNoteToIssueInput 字段

名称说明

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.

ConvertProjectV2DraftIssueItemToIssueInput

Autogenerated input type of ConvertProjectV2DraftIssueItemToIssue.

输入 ConvertProjectV2DraftIssueItemToIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the draft issue ProjectV2Item to convert.

repositoryId (ID!)

The ID of the repository to create the issue in.

ConvertPullRequestToDraftInput

Autogenerated input type of ConvertPullRequestToDraft.

输入 ConvertPullRequestToDraftInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to convert to draft.

CopyProjectV2Input

Autogenerated input type of CopyProjectV2.

输入 CopyProjectV2Input 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeDraftIssues (Boolean)

Include draft issues in the new project.

ownerId (ID!)

The owner ID of the new project.

projectId (ID!)

The ID of the source Project to copy.

title (String!)

The title of the project.

CreateAttributionInvitationInput

Autogenerated input type of CreateAttributionInvitation.

输入 CreateAttributionInvitationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The Node ID of the owner scoping the reattributable data.

sourceId (ID!)

The Node ID of the account owning the data to reattribute.

targetId (ID!)

The Node ID of the account which may claim the data.

CreateBranchProtectionRuleInput

Autogenerated input type of CreateBranchProtectionRule.

输入 CreateBranchProtectionRuleInput 字段

名称说明

allowsDeletions (Boolean)

Can this branch be deleted.

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

blocksCreations (Boolean)

Is branch creation a protected operation.

bypassForcePushActorIds ([ID!])

A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.

bypassPullRequestActorIds ([ID!])

A list of User, Team, or App 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 override branch protection.

lockAllowsFetchAndMerge (Boolean)

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing.

lockBranch (Boolean)

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

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.

requireLastPushApproval (Boolean)

Whether the most recent push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments ([String!])

The list of required deployment environments.

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.

requiresDeployments (Boolean)

Are successful deployments required 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, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

CreateCheckRunInput

Autogenerated input type of CreateCheckRun.

输入 CreateCheckRunInput 字段

名称说明

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.

输入 CreateCheckSuiteInput 字段

名称说明

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.

输入 CreateCommitOnBranchInput 字段

名称说明

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.

输入 CreateDeploymentInput 字段

名称说明

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.

输入 CreateDeploymentStatusInput 字段

名称说明

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.

输入 CreateDiscussionInput 字段

名称说明

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.

输入 CreateEnterpriseOrganizationInput 字段

名称说明

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.

输入 CreateEnvironmentInput 字段

名称说明

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.

输入 CreateIpAllowListEntryInput 字段

名称说明

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.

输入 CreateIssueInput 字段

名称说明

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.

parentIssueId (ID)

The Node ID of the parent issue to add this new issue to.

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.

输入 CreateLabelInput 字段

名称说明

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.

CreateLinkedBranchInput

Autogenerated input type of CreateLinkedBranch.

输入 CreateLinkedBranchInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

ID of the issue to link to.

name (String)

The name of the new branch. Defaults to issue number and title.

oid (GitObjectID!)

The commit SHA to base the new branch on.

repositoryId (ID)

ID of the repository to create the branch in. Defaults to the issue repository.

CreateMigrationSourceInput

Autogenerated input type of CreateMigrationSource.

输入 CreateMigrationSourceInput 字段

名称说明

accessToken (String)

The migration source access token.

clientMutationId (String)

A unique identifier for the client performing the mutation.

githubPat (String)

The GitHub personal access token of the user importing to the target repository.

name (String!)

The migration source name.

ownerId (ID!)

The ID of the organization that will own the migration source.

type (MigrationSourceType!)

The migration source type.

url (String)

The migration source URL, for example https://github.com or https://monalisa.ghe.com.

CreateProjectInput

Autogenerated input type of CreateProject.

输入 CreateProjectInput 字段

名称说明

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.

CreateProjectV2FieldInput

Autogenerated input type of CreateProjectV2Field.

输入 CreateProjectV2FieldInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

dataType (ProjectV2CustomFieldType!)

The data type of the field.

name (String!)

The name of the field.

projectId (ID!)

The ID of the Project to create the field in.

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

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 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The owner ID to create the project under.

repositoryId (ID)

The repository to link the project to.

teamId (ID)

The team to link the project to. The team will be granted read permissions.

title (String!)

The title of the project.

CreateProjectV2StatusUpdateInput

Autogenerated input type of CreateProjectV2StatusUpdate.

输入 CreateProjectV2StatusUpdateInput 字段

名称说明

body (String)

The body of the status update.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to create the status update in.

startDate (Date)

The start date of the status update.

status (ProjectV2StatusUpdateStatus)

The status of the status update.

targetDate (Date)

The target date of the status update.

CreatePullRequestInput

Autogenerated input type of CreatePullRequest.

输入 CreatePullRequestInput 字段

名称说明

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.

headRepositoryId (ID)

The Node ID of the head repository.

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.

输入 CreateRefInput 字段

名称说明

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.

输入 CreateRepositoryInput 字段

名称说明

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.

CreateRepositoryRulesetInput

Autogenerated input type of CreateRepositoryRuleset.

输入 CreateRepositoryRulesetInput 字段

名称说明

bypassActors ([RepositoryRulesetBypassActorInput!])

A list of actors that are allowed to bypass rules in this ruleset.

clientMutationId (String)

A unique identifier for the client performing the mutation.

conditions (RepositoryRuleConditionsInput!)

The set of conditions for this ruleset.

enforcement (RuleEnforcement!)

The enforcement level for this ruleset.

name (String!)

The name of the ruleset.

rules ([RepositoryRuleInput!])

The list of rules for this ruleset.

sourceId (ID!)

The global relay id of the source in which a new ruleset should be created in.

target (RepositoryRulesetTarget)

The target of the ruleset.

CreateSponsorsListingInput

Autogenerated input type of CreateSponsorsListing.

输入 CreateSponsorsListingInput 字段

名称说明

billingCountryOrRegionCode (SponsorsCountryOrRegionCode)

The country or region where the sponsorable's bank account is located. Required if fiscalHostLogin is not specified, ignored when fiscalHostLogin is specified.

clientMutationId (String)

A unique identifier for the client performing the mutation.

contactEmail (String)

The email address we should use to contact you about the GitHub Sponsors profile being created. This will not be shared publicly. Must be a verified email address already on your GitHub account. Only relevant when the sponsorable is yourself. Defaults to your primary email address on file if omitted.

fiscalHostLogin (String)

The username of the supported fiscal host's GitHub organization, if you want to receive sponsorship payouts through a fiscal host rather than directly to a bank account. For example,Open-Source-Collectivefor Open Source Collective or 'numfocus' for numFOCUS. Case insensitive. See https://docs.github.com/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts for more information.

fiscallyHostedProjectProfileUrl (String)

The URL for your profile page on the fiscal host's website, e.g., https://opencollective.com/babel or https://numfocus.org/project/bokeh. Required if fiscalHostLogin is specified.

fullDescription (String)

Provide an introduction to serve as the main focus that appears on your GitHub Sponsors profile. It's a great opportunity to help potential sponsors learn more about you, your work, and why their sponsorship is important to you. GitHub-flavored Markdown is supported.

residenceCountryOrRegionCode (SponsorsCountryOrRegionCode)

The country or region where the sponsorable resides. This is for tax purposes. Required if the sponsorable is yourself, ignored when sponsorableLogin specifies an organization.

sponsorableLogin (String)

The username of the organization to create a GitHub Sponsors profile for, if desired. Defaults to creating a GitHub Sponsors profile for the authenticated user if omitted.

CreateSponsorsTierInput

Autogenerated input type of CreateSponsorsTier.

输入 CreateSponsorsTierInput 字段

名称说明

amount (Int!)

The value of the new tier in US dollars. Valid values: 1-12000.

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String!)

A description of what this tier is, what perks sponsors might receive, what a sponsorship at this tier means for you, etc.

isRecurring (Boolean)

Whether sponsorships using this tier should happen monthly/yearly or just once.

publish (Boolean)

Whether to make the tier available immediately for sponsors to choose. Defaults to creating a draft tier that will not be publicly visible.

repositoryId (ID)

Optional ID of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization.

repositoryName (String)

Optional name of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. Necessary if repositoryOwnerLogin is given. Will be ignored if repositoryId is given.

repositoryOwnerLogin (String)

Optional login of the organization owner of the private repository that sponsors at this tier should gain read-only access to. Necessary if repositoryName is given. Will be ignored if repositoryId is given.

sponsorableId (ID)

The ID of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableLogin is not given.

sponsorableLogin (String)

The username of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableId is not given.

welcomeMessage (String)

Optional message new sponsors at this tier will receive.

CreateSponsorshipInput

Autogenerated input type of CreateSponsorship.

输入 CreateSponsorshipInput 字段

名称说明

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.

CreateSponsorshipsInput

Autogenerated input type of CreateSponsorships.

输入 CreateSponsorshipsInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

privacyLevel (SponsorshipPrivacy)

Specify whether others should be able to see that the sponsor is sponsoring the sponsorables. Public visibility still does not reveal the dollar value of the sponsorship.

receiveEmails (Boolean)

Whether the sponsor should receive email updates from the sponsorables.

recurring (Boolean)

Whether the sponsorships created should continue each billing cycle for the sponsor (monthly or annually), versus lasting only a single month. Defaults to one-time sponsorships.

sponsorLogin (String!)

The username of the user or organization who is acting as the sponsor, paying for the sponsorships.

sponsorships ([BulkSponsorship!]!)

The list of maintainers to sponsor and for how much apiece.

CreateTeamDiscussionCommentInput

Autogenerated input type of CreateTeamDiscussionComment.

输入 CreateTeamDiscussionCommentInput 字段

名称说明

body (String)

The content of the comment. This field is required.

Upcoming Change on 2024-07-01 UTC Description: body will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID)

The ID of the discussion to which the comment belongs. This field is required.

Upcoming Change on 2024-07-01 UTC Description: discussionId will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

CreateTeamDiscussionInput

Autogenerated input type of CreateTeamDiscussion.

输入 CreateTeamDiscussionInput 字段

名称说明

body (String)

The content of the discussion. This field is required.

Upcoming Change on 2024-07-01 UTC Description: body will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

clientMutationId (String)

A unique identifier for the client performing the mutation.

private (Boolean)

If true, restricts the visibility of this discussion to team members and organization owners. If false or not specified, allows any organization member to view this discussion.

Upcoming Change on 2024-07-01 UTC Description: private will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

teamId (ID)

The ID of the team to which the discussion belongs. This field is required.

Upcoming Change on 2024-07-01 UTC Description: teamId will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

title (String)

The title of the discussion. This field is required.

Upcoming Change on 2024-07-01 UTC Description: title will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Reason: The Team Discussions feature is deprecated in favor of Organization Discussions.

CreateUserListInput

Autogenerated input type of CreateUserList.

输入 CreateUserListInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A description of the list.

isPrivate (Boolean)

Whether or not the list is private.

name (String!)

The name of the new list.

DeclineTopicSuggestionInput

Autogenerated input type of DeclineTopicSuggestion.

输入 DeclineTopicSuggestionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String)

The name of the suggested topic.

Upcoming Change on 2024-04-01 UTC Description: name will be removed. Reason: Suggested topics are no longer supported.

reason (TopicSuggestionDeclineReason)

The reason why the suggested topic is declined.

Upcoming Change on 2024-04-01 UTC Description: reason will be removed. Reason: Suggested topics are no longer supported.

repositoryId (ID)

The Node ID of the repository.

Upcoming Change on 2024-04-01 UTC Description: repositoryId will be removed. Reason: Suggested topics are no longer supported.

DeleteBranchProtectionRuleInput

Autogenerated input type of DeleteBranchProtectionRule.

输入 DeleteBranchProtectionRuleInput 字段

名称说明

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

clientMutationId (String)

A unique identifier for the client performing the mutation.

DeleteDeploymentInput

Autogenerated input type of DeleteDeployment.

输入 DeleteDeploymentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the deployment to be deleted.

DeleteDiscussionCommentInput

Autogenerated input type of DeleteDiscussionComment.

输入 DeleteDiscussionCommentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node id of the discussion comment to delete.

DeleteDiscussionInput

Autogenerated input type of DeleteDiscussion.

输入 DeleteDiscussionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The id of the discussion to delete.

DeleteEnvironmentInput

Autogenerated input type of DeleteEnvironment.

输入 DeleteEnvironmentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the environment to be deleted.

DeleteIpAllowListEntryInput

Autogenerated input type of DeleteIpAllowListEntry.

输入 DeleteIpAllowListEntryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

DeleteIssueCommentInput

Autogenerated input type of DeleteIssueComment.

输入 DeleteIssueCommentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to delete.

DeleteIssueInput

Autogenerated input type of DeleteIssue.

输入 DeleteIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The ID of the issue to delete.

DeleteLabelInput

Autogenerated input type of DeleteLabel.

输入 DeleteLabelInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the label to be deleted.

DeleteLinkedBranchInput

Autogenerated input type of DeleteLinkedBranch.

输入 DeleteLinkedBranchInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

linkedBranchId (ID!)

The ID of the linked branch.

DeletePackageVersionInput

Autogenerated input type of DeletePackageVersion.

输入 DeletePackageVersionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

packageVersionId (ID!)

The ID of the package version to be deleted.

DeleteProjectCardInput

Autogenerated input type of DeleteProjectCard.

输入 DeleteProjectCardInput 字段

名称说明

cardId (ID!)

The id of the card to delete.

clientMutationId (String)

A unique identifier for the client performing the mutation.

DeleteProjectColumnInput

Autogenerated input type of DeleteProjectColumn.

输入 DeleteProjectColumnInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to delete.

DeleteProjectInput

Autogenerated input type of DeleteProject.

输入 DeleteProjectInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The Project ID to update.

DeleteProjectV2FieldInput

Autogenerated input type of DeleteProjectV2Field.

输入 DeleteProjectV2FieldInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to delete.

DeleteProjectV2Input

Autogenerated input type of DeleteProjectV2.

输入 DeleteProjectV2Input 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to delete.

DeleteProjectV2ItemInput

Autogenerated input type of DeleteProjectV2Item.

输入 DeleteProjectV2ItemInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the item to be removed.

projectId (ID!)

The ID of the Project from which the item should be removed.

DeleteProjectV2StatusUpdateInput

Autogenerated input type of DeleteProjectV2StatusUpdate.

输入 DeleteProjectV2StatusUpdateInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

statusUpdateId (ID!)

The ID of the status update to be removed.

DeleteProjectV2WorkflowInput

Autogenerated input type of DeleteProjectV2Workflow.

输入 DeleteProjectV2WorkflowInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

workflowId (ID!)

The ID of the workflow to be removed.

DeletePullRequestReviewCommentInput

Autogenerated input type of DeletePullRequestReviewComment.

输入 DeletePullRequestReviewCommentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to delete.

DeletePullRequestReviewInput

Autogenerated input type of DeletePullRequestReview.

输入 DeletePullRequestReviewInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

DeleteRefInput

Autogenerated input type of DeleteRef.

输入 DeleteRefInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

refId (ID!)

The Node ID of the Ref to be deleted.

DeleteRepositoryRulesetInput

Autogenerated input type of DeleteRepositoryRuleset.

输入 DeleteRepositoryRulesetInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryRulesetId (ID!)

The global relay id of the repository ruleset to be deleted.

DeleteTeamDiscussionCommentInput

Autogenerated input type of DeleteTeamDiscussionComment.

输入 DeleteTeamDiscussionCommentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the comment to delete.

DeleteTeamDiscussionInput

Autogenerated input type of DeleteTeamDiscussion.

输入 DeleteTeamDiscussionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The discussion ID to delete.

DeleteUserListInput

Autogenerated input type of DeleteUserList.

输入 DeleteUserListInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

listId (ID!)

The ID of the list to delete.

DeleteVerifiableDomainInput

Autogenerated input type of DeleteVerifiableDomain.

输入 DeleteVerifiableDomainInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to delete.

DeploymentOrder

Ordering options for deployment connections.

输入 DeploymentOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (DeploymentOrderField!)

The field to order deployments by.

DequeuePullRequestInput

Autogenerated input type of DequeuePullRequest.

输入 DequeuePullRequestInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the pull request to be dequeued.

DisablePullRequestAutoMergeInput

Autogenerated input type of DisablePullRequestAutoMerge.

输入 DisablePullRequestAutoMergeInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

DiscussionOrder

Ways in which lists of discussions can be ordered upon return.

输入 DiscussionOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

field (DiscussionOrderField!)

The field by which to order discussions.

DiscussionPollOptionOrder

Ordering options for discussion poll option connections.

输入 DiscussionPollOptionOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (DiscussionPollOptionOrderField!)

The field to order poll options by.

DismissPullRequestReviewInput

Autogenerated input type of DismissPullRequestReview.

输入 DismissPullRequestReviewInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String!)

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.

输入 DismissRepositoryVulnerabilityAlertInput 字段

名称说明

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.

输入 DraftPullRequestReviewComment 字段

名称说明

body (String!)

Body of the comment to leave.

path (String!)

Path to the file being commented on.

position (Int!)

Position in the file to leave a comment on.

DraftPullRequestReviewThread

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

输入 DraftPullRequestReviewThread 字段

名称说明

body (String!)

Body of the comment to leave.

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

path (String!)

Path to the file being commented on.

side (DiffSide)

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.

startLine (Int)

The first line of the range to which the comment refers.

startSide (DiffSide)

The side of the diff on which the start line resides.

EnablePullRequestAutoMergeInput

Autogenerated input type of EnablePullRequestAutoMerge.

输入 EnablePullRequestAutoMergeInput 字段

名称说明

authorEmail (String)

The email address to associate with this merge.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitBody (String)

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.

commitHeadline (String)

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.

expectedHeadOid (GitObjectID)

The expected head OID of the pull request.

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to MERGE. NOTE: when merging with a merge queue any input value for merge method is ignored.

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

EnqueuePullRequestInput

Autogenerated input type of EnqueuePullRequest.

输入 EnqueuePullRequestInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

expectedHeadOid (GitObjectID)

The expected head OID of the pull request.

jump (Boolean)

Add the pull request to the front of the queue.

pullRequestId (ID!)

The ID of the pull request to enqueue.

EnterpriseAdministratorInvitationOrder

Ordering options for enterprise administrator invitation connections.

输入 EnterpriseAdministratorInvitationOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

EnterpriseMemberInvitationOrder

Ordering options for enterprise administrator invitation connections.

输入 EnterpriseMemberInvitationOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseMemberInvitationOrderField!)

The field to order enterprise member invitations by.

EnterpriseMemberOrder

Ordering options for enterprise member connections.

输入 EnterpriseMemberOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

EnterpriseOrder

Ordering options for enterprises.

输入 EnterpriseOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseOrderField!)

The field to order enterprises by.

EnterpriseServerInstallationOrder

Ordering options for Enterprise Server installation connections.

输入 EnterpriseServerInstallationOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerInstallationOrderField!)

The field to order Enterprise Server installations by.

EnterpriseServerUserAccountEmailOrder

Ordering options for Enterprise Server user account email connections.

输入 EnterpriseServerUserAccountEmailOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

EnterpriseServerUserAccountOrder

Ordering options for Enterprise Server user account connections.

输入 EnterpriseServerUserAccountOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

EnterpriseServerUserAccountsUploadOrder

Ordering options for Enterprise Server user accounts upload connections.

输入 EnterpriseServerUserAccountsUploadOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

Environments

Ordering options for environments.

输入 Environments 字段

名称说明

direction (OrderDirection!)

The direction in which to order environments by the specified field.

field (EnvironmentOrderField!)

The field to order environments 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 字段

名称说明

contents (Base64String!)

The base64 encoded contents of the file.

path (String!)

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:

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

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

  2. 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")
    }
  ]
}

  3. 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"
    }
  ]
}

  4. 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")
    }
  ]
}

  5. 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")
    }
  ]
}.

输入 FileChanges 字段

名称说明

additions ([FileAddition!])

File to add or change.

deletions ([FileDeletion!])

Files to delete.

FileDeletion

A command to delete the file at the given path as part of a commit.

输入 FileDeletion 字段

名称说明

path (String!)

The path to delete.

FileExtensionRestrictionParametersInput

Prevent commits that include files with specified file extensions from being pushed to the commit graph.

输入 FileExtensionRestrictionParametersInput 字段

名称说明

restrictedFileExtensions ([String!]!)

The file extensions that are restricted from being pushed to the commit graph.

FilePathRestrictionParametersInput

Prevent commits that include changes in specified file paths from being pushed to the commit graph.

输入 FilePathRestrictionParametersInput 字段

名称说明

restrictedFilePaths ([String!]!)

The file paths that are restricted from being pushed to the commit graph.

FollowOrganizationInput

Autogenerated input type of FollowOrganization.

输入 FollowOrganizationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

ID of the organization to follow.

FollowUserInput

Autogenerated input type of FollowUser.

输入 FollowUserInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

userId (ID!)

ID of the user to follow.

GistOrder

Ordering options for gist connections.

输入 GistOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (GistOrderField!)

The field to order repositories by.

GrantEnterpriseOrganizationsMigratorRoleInput

Autogenerated input type of GrantEnterpriseOrganizationsMigratorRole.

输入 GrantEnterpriseOrganizationsMigratorRoleInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise to which all organizations managed by it will be granted the migrator role.

login (String!)

The login of the user to grant the migrator role.

GrantMigratorRoleInput

Autogenerated input type of GrantMigratorRole.

输入 GrantMigratorRoleInput 字段

名称说明

actor (String!)

The user login or Team slug to grant the migrator role.

actorType (ActorType!)

Specifies the type of the actor, can be either USER or TEAM.

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization that the user/team belongs to.

ImportProjectInput

Autogenerated input type of ImportProject.

输入 ImportProjectInput 字段

名称说明

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.

输入 InviteEnterpriseAdminInput 字段

名称说明

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.

InviteEnterpriseMemberInput

Autogenerated input type of InviteEnterpriseMember.

输入 InviteEnterpriseMemberInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

email (String)

The email of the person to invite as an unaffiliated member.

enterpriseId (ID!)

The ID of the enterprise to which you want to invite an unaffiliated member.

invitee (String)

The login of a user to invite as an unaffiliated member.

IpAllowListEntryOrder

Ordering options for IP allow list entry connections.

输入 IpAllowListEntryOrder 字段

名称说明

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.

输入 IssueCommentOrder 字段

名称说明

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.

输入 IssueFilters 字段

名称说明

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 database ID. Pass in null for issues with no milestone, and * for issues that are assigned to any milestone.

milestoneNumber (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.

IssueOrder

Ways in which lists of issues can be ordered upon return.

输入 IssueOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order issues by the specified field.

field (IssueOrderField!)

The field in which to order issues by.

LabelOrder

Ways in which lists of labels can be ordered upon return.

输入 LabelOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order labels by the specified field.

field (LabelOrderField!)

The field in which to order labels by.

LanguageOrder

Ordering options for language connections.

输入 LanguageOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (LanguageOrderField!)

The field to order languages by.

LinkProjectV2ToRepositoryInput

Autogenerated input type of LinkProjectV2ToRepository.

输入 LinkProjectV2ToRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to link to the repository.

repositoryId (ID!)

The ID of the repository to link to the project.

LinkProjectV2ToTeamInput

Autogenerated input type of LinkProjectV2ToTeam.

输入 LinkProjectV2ToTeamInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to link to the team.

teamId (ID!)

The ID of the team to link to the project.

LinkRepositoryToProjectInput

Autogenerated input type of LinkRepositoryToProject.

输入 LinkRepositoryToProjectInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to link to a Repository.

repositoryId (ID!)

The ID of the Repository to link to a Project.

LockLockableInput

Autogenerated input type of LockLockable.

输入 LockLockableInput 字段

名称说明

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.

MannequinOrder

Ordering options for mannequins.

输入 MannequinOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (MannequinOrderField!)

The field to order mannequins by.

MarkDiscussionCommentAsAnswerInput

Autogenerated input type of MarkDiscussionCommentAsAnswer.

输入 MarkDiscussionCommentAsAnswerInput 字段

名称说明

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.

输入 MarkFileAsViewedInput 字段

名称说明

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.

MarkNotificationAsDoneInput

Autogenerated input type of MarkNotificationAsDone.

输入 MarkNotificationAsDoneInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The NotificationThread id.

MarkProjectV2AsTemplateInput

Autogenerated input type of MarkProjectV2AsTemplate.

输入 MarkProjectV2AsTemplateInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to mark as a template.

MarkPullRequestReadyForReviewInput

Autogenerated input type of MarkPullRequestReadyForReview.

输入 MarkPullRequestReadyForReviewInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

MaxFilePathLengthParametersInput

Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.

输入 MaxFilePathLengthParametersInput 字段

名称说明

maxFilePathLength (Int!)

The maximum amount of characters allowed in file paths.

MaxFileSizeParametersInput

Prevent commits that exceed a specified file size limit from being pushed to the commit.

输入 MaxFileSizeParametersInput 字段

名称说明

maxFileSize (Int!)

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

MergeBranchInput

Autogenerated input type of MergeBranch.

输入 MergeBranchInput 字段

名称说明

authorEmail (String)

The email address to associate with this commit.

base (String!)

The name of the base branch that the provided head will be merged into.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

MergePullRequestInput

Autogenerated input type of MergePullRequest.

输入 MergePullRequestInput 字段

名称说明

authorEmail (String)

The email address to associate with this merge.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

pullRequestId (ID!)

ID of the pull request to be merged.

MergeQueueParametersInput

Merges must be performed via a merge queue.

输入 MergeQueueParametersInput 字段

名称说明

checkResponseTimeoutMinutes (Int!)

Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed.

groupingStrategy (MergeQueueGroupingStrategy!)

When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.

maxEntriesToBuild (Int!)

Limit the number of queued pull requests requesting checks and workflow runs at the same time.

maxEntriesToMerge (Int!)

The maximum number of PRs that will be merged together in a group.

mergeMethod (MergeQueueMergeMethod!)

Method to use when merging changes from queued pull requests.

minEntriesToMerge (Int!)

The minimum number of PRs that will be merged together in a group.

minEntriesToMergeWaitMinutes (Int!)

The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

MilestoneOrder

Ordering options for milestone connections.

输入 MilestoneOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (MilestoneOrderField!)

The field to order milestones by.

MinimizeCommentInput

Autogenerated input type of MinimizeComment.

输入 MinimizeCommentInput 字段

名称说明

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.

输入 MoveProjectCardInput 字段

名称说明

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.

输入 MoveProjectColumnInput 字段

名称说明

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to move.

OrgEnterpriseOwnerOrder

Ordering options for an organization's enterprise owner connections.

输入 OrgEnterpriseOwnerOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (OrgEnterpriseOwnerOrderField!)

The field to order enterprise owners by.

OrganizationOrder

Ordering options for organization connections.

输入 OrganizationOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (OrganizationOrderField!)

The field to order organizations by.

PackageFileOrder

Ways in which lists of package files can be ordered upon return.

输入 PackageFileOrder 字段

名称说明

direction (OrderDirection)

The direction in which to order package files by the specified field.

field (PackageFileOrderField)

The field in which to order package files by.

PackageOrder

Ways in which lists of packages can be ordered upon return.

输入 PackageOrder 字段

名称说明

direction (OrderDirection)

The direction in which to order packages by the specified field.

field (PackageOrderField)

The field in which to order packages by.

PackageVersionOrder

Ways in which lists of package versions can be ordered upon return.

输入 PackageVersionOrder 字段

名称说明

direction (OrderDirection)

The direction in which to order package versions by the specified field.

field (PackageVersionOrderField)

The field in which to order package versions by.

PinEnvironmentInput

Autogenerated input type of PinEnvironment.

输入 PinEnvironmentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

environmentId (ID!)

The ID of the environment to modify.

pinned (Boolean!)

The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.

PinIssueInput

Autogenerated input type of PinIssue.

输入 PinIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The ID of the issue to be pinned.

PinnedEnvironmentOrder

Ordering options for pinned environments.

输入 PinnedEnvironmentOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order pinned environments by the specified field.

field (PinnedEnvironmentOrderField!)

The field to order pinned environments by.

ProjectCardImport

An issue or PR and its owning repository to be used in a project card.

输入 ProjectCardImport 字段

名称说明

number (Int!)

The issue or pull request number.

repository (String!)

Repository name with owner (owner/repository).

ProjectColumnImport

A project column and a list of its issues and PRs.

输入 ProjectColumnImport 字段

名称说明

columnName (String!)

The name of the column.

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

position (Int!)

The position of the column, starting from 0.

ProjectOrder

Ways in which lists of projects can be ordered upon return.

输入 ProjectOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order projects by the specified field.

field (ProjectOrderField!)

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 字段

名称说明

role (ProjectV2Roles!)

The role to grant the collaborator.

teamId (ID)

The ID of the team as a collaborator.

userId (ID)

The ID of the user as a collaborator.

ProjectV2FieldOrder

Ordering options for project v2 field connections.

输入 ProjectV2FieldOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2FieldOrderField!)

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 字段

名称说明

date (Date)

The ISO 8601 date to set on the field.

iterationId (String)

The id of the iteration to set on the field.

number (Float)

The number to set on the field.

singleSelectOptionId (String)

The id of the single select option to set on the field.

text (String)

The text to set on the field.

ProjectV2Filters

Ways in which to filter lists of projects.

输入 ProjectV2Filters 字段

名称说明

state (ProjectV2State)

List project v2 filtered by the state given.

ProjectV2ItemFieldValueOrder

Ordering options for project v2 item field value connections.

输入 ProjectV2ItemFieldValueOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ItemFieldValueOrderField!)

The field to order the project v2 item field values by.

ProjectV2ItemOrder

Ordering options for project v2 item connections.

输入 ProjectV2ItemOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ItemOrderField!)

The field to order the project v2 items by.

ProjectV2Order

Ways in which lists of projects can be ordered upon return.

输入 ProjectV2Order 字段

名称说明

direction (OrderDirection!)

The direction in which to order projects by the specified field.

field (ProjectV2OrderField!)

The field in which to order projects by.

ProjectV2SingleSelectFieldOptionInput

Represents a single select field option.

输入 ProjectV2SingleSelectFieldOptionInput 字段

名称说明

color (ProjectV2SingleSelectFieldOptionColor!)

The display color of the option.

description (String!)

The description text of the option.

name (String!)

The name of the option.

ProjectV2StatusOrder

Ways in which project v2 status updates can be ordered.

输入 ProjectV2StatusOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order nodes.

field (ProjectV2StatusUpdateOrderField!)

The field by which to order nodes.

ProjectV2ViewOrder

Ordering options for project v2 view connections.

输入 ProjectV2ViewOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ViewOrderField!)

The field to order the project v2 views by.

ProjectV2WorkflowOrder

Ordering options for project v2 workflows connections.

输入 ProjectV2WorkflowOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2WorkflowsOrderField!)

The field to order the project v2 workflows by.

PropertyTargetDefinitionInput

A property that must match.

输入 PropertyTargetDefinitionInput 字段

名称说明

name (String!)

The name of the property.

propertyValues ([String!]!)

The values to match for.

source (String)

The source of the property. Choosecustomor 'system'. Defaults to 'custom' if not specified.

PublishSponsorsTierInput

Autogenerated input type of PublishSponsorsTier.

输入 PublishSponsorsTierInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

tierId (ID!)

The ID of the draft tier to publish.

PullRequestOrder

Ways in which lists of issues can be ordered upon return.

输入 PullRequestOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

field (PullRequestOrderField!)

The field in which to order pull requests by.

PullRequestParametersInput

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

输入 PullRequestParametersInput 字段

名称说明

dismissStaleReviewsOnPush (Boolean!)

New, reviewable commits pushed will dismiss previous pull request review approvals.

requireCodeOwnerReview (Boolean!)

Require an approving review in pull requests that modify files that have a designated code owner.

requireLastPushApproval (Boolean!)

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int!)

The number of approving reviews that are required before a pull request can be merged.

requiredReviewThreadResolution (Boolean!)

All conversations on code must be resolved before a pull request can be merged.

ReactionOrder

Ways in which lists of reactions can be ordered upon return.

输入 ReactionOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

field (ReactionOrderField!)

The field in which to order reactions by.

RefNameConditionTargetInput

Parameters to be used for the ref_name condition.

输入 RefNameConditionTargetInput 字段

名称说明

exclude ([String!]!)

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

include ([String!]!)

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

RefOrder

Ways in which lists of git refs can be ordered upon return.

输入 RefOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order refs by the specified field.

field (RefOrderField!)

The field in which to order refs by.

RefUpdate

A ref update.

输入 RefUpdate 字段

名称说明

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.

输入 RegenerateEnterpriseIdentityProviderRecoveryCodesInput 字段

名称说明

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.

输入 RegenerateVerifiableDomainTokenInput 字段

名称说明

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.

输入 RejectDeploymentsInput 字段

名称说明

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.

ReleaseOrder

Ways in which lists of releases can be ordered upon return.

输入 ReleaseOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order releases by the specified field.

field (ReleaseOrderField!)

The field in which to order releases by.

RemoveAssigneesFromAssignableInput

Autogenerated input type of RemoveAssigneesFromAssignable.

输入 RemoveAssigneesFromAssignableInput 字段

名称说明

assignableId (ID!)

The id of the assignable object to remove assignees from.

assigneeIds ([ID!]!)

The id of users to remove as assignees.

clientMutationId (String)

A unique identifier for the client performing the mutation.

RemoveEnterpriseAdminInput

Autogenerated input type of RemoveEnterpriseAdmin.

输入 RemoveEnterpriseAdminInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

login (String!)

The login of the user to remove as an administrator.

RemoveEnterpriseIdentityProviderInput

Autogenerated input type of RemoveEnterpriseIdentityProvider.

输入 RemoveEnterpriseIdentityProviderInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise from which to remove the identity provider.

RemoveEnterpriseMemberInput

Autogenerated input type of RemoveEnterpriseMember.

输入 RemoveEnterpriseMemberInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise from which the user should be removed.

userId (ID!)

The ID of the user to remove from the enterprise.

RemoveEnterpriseOrganizationInput

Autogenerated input type of RemoveEnterpriseOrganization.

输入 RemoveEnterpriseOrganizationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise from which the organization should be removed.

organizationId (ID!)

The ID of the organization to remove from the enterprise.

RemoveEnterpriseSupportEntitlementInput

Autogenerated input type of RemoveEnterpriseSupportEntitlement.

输入 RemoveEnterpriseSupportEntitlementInput 字段

名称说明

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 lose the support entitlement.

RemoveLabelsFromLabelableInput

Autogenerated input type of RemoveLabelsFromLabelable.

输入 RemoveLabelsFromLabelableInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!]!)

The ids of labels to remove.

labelableId (ID!)

The id of the Labelable to remove labels from.

RemoveOutsideCollaboratorInput

Autogenerated input type of RemoveOutsideCollaborator.

输入 RemoveOutsideCollaboratorInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

userId (ID!)

The ID of the outside collaborator to remove.

RemoveReactionInput

Autogenerated input type of RemoveReaction.

输入 RemoveReactionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

content (ReactionContent!)

The name of the emoji reaction to remove.

subjectId (ID!)

The Node ID of the subject to modify.

RemoveStarInput

Autogenerated input type of RemoveStar.

输入 RemoveStarInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to unstar.

RemoveSubIssueInput

Autogenerated input type of RemoveSubIssue.

输入 RemoveSubIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The id of the issue.

subIssueId (ID!)

The id of the sub-issue.

RemoveUpvoteInput

Autogenerated input type of RemoveUpvote.

输入 RemoveUpvoteInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

ReopenDiscussionInput

Autogenerated input type of ReopenDiscussion.

输入 ReopenDiscussionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

ID of the discussion to be reopened.

ReopenIssueInput

Autogenerated input type of ReopenIssue.

输入 ReopenIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

ID of the issue to be opened.

ReopenPullRequestInput

Autogenerated input type of ReopenPullRequest.

输入 ReopenPullRequestInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestId (ID!)

ID of the pull request to be reopened.

ReorderEnvironmentInput

Autogenerated input type of ReorderEnvironment.

输入 ReorderEnvironmentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

environmentId (ID!)

The ID of the environment to modify.

position (Int!)

The desired position of the environment.

RepositoryIdConditionTargetInput

Parameters to be used for the repository_id condition.

输入 RepositoryIdConditionTargetInput 字段

名称说明

repositoryIds ([ID!]!)

One of these repo IDs must match the repo.

RepositoryInvitationOrder

Ordering options for repository invitation connections.

输入 RepositoryInvitationOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

RepositoryMigrationOrder

Ordering options for repository migrations.

输入 RepositoryMigrationOrder 字段

名称说明

direction (RepositoryMigrationOrderDirection!)

The ordering direction.

field (RepositoryMigrationOrderField!)

The field to order repository migrations by.

RepositoryNameConditionTargetInput

Parameters to be used for the repository_name condition.

输入 RepositoryNameConditionTargetInput 字段

名称说明

exclude ([String!]!)

Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

include ([String!]!)

Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.

protected (Boolean)

Target changes that match these patterns will be prevented except by those with bypass permissions.

RepositoryOrder

Ordering options for repository connections.

输入 RepositoryOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (RepositoryOrderField!)

The field to order repositories by.

RepositoryPropertyConditionTargetInput

Parameters to be used for the repository_property condition.

输入 RepositoryPropertyConditionTargetInput 字段

名称说明

exclude ([PropertyTargetDefinitionInput!]!)

Array of repository properties that must not match.

include ([PropertyTargetDefinitionInput!]!)

Array of repository properties that must match.

RepositoryRuleConditionsInput

Specifies the conditions required for a ruleset to evaluate.

输入 RepositoryRuleConditionsInput 字段

名称说明

refName (RefNameConditionTargetInput)

Configuration for the ref_name condition.

repositoryId (RepositoryIdConditionTargetInput)

Configuration for the repository_id condition.

repositoryName (RepositoryNameConditionTargetInput)

Configuration for the repository_name condition.

repositoryProperty (RepositoryPropertyConditionTargetInput)

Configuration for the repository_property condition.

RepositoryRuleInput

Specifies the attributes for a new or updated rule.

输入 RepositoryRuleInput 字段

名称说明

id (ID)

Optional ID of this rule when updating.

parameters (RuleParametersInput)

The parameters for the rule.

type (RepositoryRuleType!)

The type of rule to create.

RepositoryRuleOrder

Ordering options for repository rules.

输入 RepositoryRuleOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (RepositoryRuleOrderField!)

The field to order repository rules by.

RepositoryRulesetBypassActorInput

Specifies the attributes for a new or updated ruleset bypass actor. Only one of actor_id, repository_role_database_id, organization_admin, or deploy_key should be specified.

输入 RepositoryRulesetBypassActorInput 字段

名称说明

actorId (ID)

For Team and Integration bypasses, the Team or Integration ID.

bypassMode (RepositoryRulesetBypassActorBypassMode!)

The bypass mode for this actor.

deployKey (Boolean)

For deploy key bypasses, true. Can only use ALWAYS as the bypass mode.

enterpriseOwner (Boolean)

For enterprise owner bypasses, true.

organizationAdmin (Boolean)

For organization owner bypasses, true.

repositoryRoleDatabaseId (Int)

For role bypasses, the role database ID.

ReprioritizeSubIssueInput

Autogenerated input type of ReprioritizeSubIssue.

输入 ReprioritizeSubIssueInput 字段

名称说明

afterId (ID)

The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified).

beforeId (ID)

The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified).

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The id of the parent issue.

subIssueId (ID!)

The id of the sub-issue to reprioritize.

RequestReviewsInput

Autogenerated input type of RequestReviews.

输入 RequestReviewsInput 字段

名称说明

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.

RequiredDeploymentsParametersInput

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

输入 RequiredDeploymentsParametersInput 字段

名称说明

requiredDeploymentEnvironments ([String!]!)

The environments that must be successfully deployed to before branches can be merged.

RequiredStatusCheckInput

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

输入 RequiredStatusCheckInput 字段

名称说明

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.

RequiredStatusChecksParametersInput

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

输入 RequiredStatusChecksParametersInput 字段

名称说明

doNotEnforceOnCreate (Boolean)

Allow repositories and branches to be created if a check would otherwise prohibit it.

requiredStatusChecks ([StatusCheckConfigurationInput!]!)

Status checks that are required.

strictRequiredStatusChecksPolicy (Boolean!)

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

RerequestCheckSuiteInput

Autogenerated input type of RerequestCheckSuite.

输入 RerequestCheckSuiteInput 字段

名称说明

checkSuiteId (ID!)

The Node ID of the check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.

ResolveReviewThreadInput

Autogenerated input type of ResolveReviewThread.

输入 ResolveReviewThreadInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to resolve.

RetireSponsorsTierInput

Autogenerated input type of RetireSponsorsTier.

输入 RetireSponsorsTierInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

tierId (ID!)

The ID of the published tier to retire.

RevertPullRequestInput

Autogenerated input type of RevertPullRequest.

输入 RevertPullRequestInput 字段

名称说明

body (String)

The description of the revert pull request.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draft (Boolean)

Indicates whether the revert pull request should be a draft.

pullRequestId (ID!)

The ID of the pull request to revert.

title (String)

The title of the revert pull request.

RevokeEnterpriseOrganizationsMigratorRoleInput

Autogenerated input type of RevokeEnterpriseOrganizationsMigratorRole.

输入 RevokeEnterpriseOrganizationsMigratorRoleInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise to which all organizations managed by it will be granted the migrator role.

login (String!)

The login of the user to revoke the migrator role.

RevokeMigratorRoleInput

Autogenerated input type of RevokeMigratorRole.

输入 RevokeMigratorRoleInput 字段

名称说明

actor (String!)

The user login or Team slug to revoke the migrator role from.

actorType (ActorType!)

Specifies the type of the actor, can be either USER or TEAM.

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization that the user/team belongs to.

RuleParametersInput

Specifies the parameters for a RepositoryRule object. Only one of the fields should be specified.

输入 RuleParametersInput 字段

名称说明

branchNamePattern (BranchNamePatternParametersInput)

Parameters used for the branch_name_pattern rule type.

codeScanning (CodeScanningParametersInput)

Parameters used for the code_scanning rule type.

commitAuthorEmailPattern (CommitAuthorEmailPatternParametersInput)

Parameters used for the commit_author_email_pattern rule type.

commitMessagePattern (CommitMessagePatternParametersInput)

Parameters used for the commit_message_pattern rule type.

committerEmailPattern (CommitterEmailPatternParametersInput)

Parameters used for the committer_email_pattern rule type.

fileExtensionRestriction (FileExtensionRestrictionParametersInput)

Parameters used for the file_extension_restriction rule type.

filePathRestriction (FilePathRestrictionParametersInput)

Parameters used for the file_path_restriction rule type.

maxFilePathLength (MaxFilePathLengthParametersInput)

Parameters used for the max_file_path_length rule type.

maxFileSize (MaxFileSizeParametersInput)

Parameters used for the max_file_size rule type.

mergeQueue (MergeQueueParametersInput)

Parameters used for the merge_queue rule type.

pullRequest (PullRequestParametersInput)

Parameters used for the pull_request rule type.

requiredDeployments (RequiredDeploymentsParametersInput)

Parameters used for the required_deployments rule type.

requiredStatusChecks (RequiredStatusChecksParametersInput)

Parameters used for the required_status_checks rule type.

tagNamePattern (TagNamePatternParametersInput)

Parameters used for the tag_name_pattern rule type.

update (UpdateParametersInput)

Parameters used for the update rule type.

workflows (WorkflowsParametersInput)

Parameters used for the workflows rule type.

SavedReplyOrder

Ordering options for saved reply connections.

输入 SavedReplyOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SavedReplyOrderField!)

The field to order saved replies by.

SecurityAdvisoryIdentifierFilter

An advisory identifier to filter results on.

输入 SecurityAdvisoryIdentifierFilter 字段

名称说明

type (SecurityAdvisoryIdentifierType!)

The identifier type.

value (String!)

The identifier string. Supports exact or partial matching.

SecurityAdvisoryOrder

Ordering options for security advisory connections.

输入 SecurityAdvisoryOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SecurityAdvisoryOrderField!)

The field to order security advisories by.

SecurityVulnerabilityOrder

Ordering options for security vulnerability connections.

输入 SecurityVulnerabilityOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SecurityVulnerabilityOrderField!)

The field to order security vulnerabilities by.

SetEnterpriseIdentityProviderInput

Autogenerated input type of SetEnterpriseIdentityProvider.

输入 SetEnterpriseIdentityProviderInput 字段

名称说明

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.

输入 SetOrganizationInteractionLimitInput 字段

名称说明

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.

输入 SetRepositoryInteractionLimitInput 字段

名称说明

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.

输入 SetUserInteractionLimitInput 字段

名称说明

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.

SponsorAndLifetimeValueOrder

Ordering options for connections to get sponsor entities and associated USD amounts for GitHub Sponsors.

输入 SponsorAndLifetimeValueOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SponsorAndLifetimeValueOrderField!)

The field to order results by.

SponsorOrder

Ordering options for connections to get sponsor entities for GitHub Sponsors.

输入 SponsorOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SponsorOrderField!)

The field to order sponsor entities by.

SponsorableOrder

Ordering options for connections to get sponsorable entities for GitHub Sponsors.

输入 SponsorableOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SponsorableOrderField!)

The field to order sponsorable entities by.

SponsorsActivityOrder

Ordering options for GitHub Sponsors activity connections.

输入 SponsorsActivityOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SponsorsActivityOrderField!)

The field to order activity by.

SponsorsTierOrder

Ordering options for Sponsors tiers connections.

输入 SponsorsTierOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SponsorsTierOrderField!)

The field to order tiers by.

SponsorshipNewsletterOrder

Ordering options for sponsorship newsletter connections.

输入 SponsorshipNewsletterOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SponsorshipNewsletterOrderField!)

The field to order sponsorship newsletters by.

SponsorshipOrder

Ordering options for sponsorship connections.

输入 SponsorshipOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (SponsorshipOrderField!)

The field to order sponsorship by.

StarOrder

Ways in which star connections can be ordered.

输入 StarOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order nodes.

field (StarOrderField!)

The field in which to order nodes by.

StartOrganizationMigrationInput

Autogenerated input type of StartOrganizationMigration.

输入 StartOrganizationMigrationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

sourceAccessToken (String!)

The migration source access token.

sourceOrgUrl (URI!)

The URL of the organization to migrate.

targetEnterpriseId (ID!)

The ID of the enterprise the target organization belongs to.

targetOrgName (String!)

The name of the target organization.

StartRepositoryMigrationInput

Autogenerated input type of StartRepositoryMigration.

输入 StartRepositoryMigrationInput 字段

名称说明

accessToken (String)

The migration source access token.

clientMutationId (String)

A unique identifier for the client performing the mutation.

continueOnError (Boolean)

Whether to continue the migration on error. Defaults to true.

gitArchiveUrl (String)

The signed URL to access the user-uploaded git archive.

githubPat (String)

The GitHub personal access token of the user importing to the target repository.

lockSource (Boolean)

Whether to lock the source repository.

metadataArchiveUrl (String)

The signed URL to access the user-uploaded metadata archive.

ownerId (ID!)

The ID of the organization that will own the imported repository.

repositoryName (String!)

The name of the imported repository.

skipReleases (Boolean)

Whether to skip migrating releases for the repository.

sourceId (ID!)

The ID of the migration source.

sourceRepositoryUrl (URI!)

The URL of the source repository.

targetRepoVisibility (String)

The visibility of the imported repository.

StatusCheckConfigurationInput

Required status check.

输入 StatusCheckConfigurationInput 字段

名称说明

context (String!)

The status check context name that must be present on the commit.

integrationId (Int)

The optional integration ID that this status check must originate from.

SubmitPullRequestReviewInput

Autogenerated input type of SubmitPullRequestReview.

输入 SubmitPullRequestReviewInput 字段

名称说明

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.

TagNamePatternParametersInput

Parameters to be used for the tag_name_pattern rule.

输入 TagNamePatternParametersInput 字段

名称说明

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

TeamDiscussionCommentOrder

Ways in which team discussion comment connections can be ordered.

输入 TeamDiscussionCommentOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order nodes.

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

TeamDiscussionOrder

Ways in which team discussion connections can be ordered.

输入 TeamDiscussionOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order nodes.

field (TeamDiscussionOrderField!)

The field by which to order nodes.

TeamMemberOrder

Ordering options for team member connections.

输入 TeamMemberOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (TeamMemberOrderField!)

The field to order team members by.

TeamOrder

Ways in which team connections can be ordered.

输入 TeamOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order nodes.

field (TeamOrderField!)

The field in which to order nodes by.

TeamRepositoryOrder

Ordering options for team repository connections.

输入 TeamRepositoryOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (TeamRepositoryOrderField!)

The field to order repositories by.

TransferEnterpriseOrganizationInput

Autogenerated input type of TransferEnterpriseOrganization.

输入 TransferEnterpriseOrganizationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

destinationEnterpriseId (ID!)

The ID of the enterprise where the organization should be transferred.

organizationId (ID!)

The ID of the organization to transfer.

TransferIssueInput

Autogenerated input type of TransferIssue.

输入 TransferIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

createLabelsIfMissing (Boolean)

Whether to create labels if they don't exist in the target repository (matched by name).

issueId (ID!)

The Node ID of the issue to be transferred.

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

UnarchiveProjectV2ItemInput

Autogenerated input type of UnarchiveProjectV2Item.

输入 UnarchiveProjectV2ItemInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the ProjectV2Item to unarchive.

projectId (ID!)

The ID of the Project to archive the item from.

UnarchiveRepositoryInput

Autogenerated input type of UnarchiveRepository.

输入 UnarchiveRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to unarchive.

UnfollowOrganizationInput

Autogenerated input type of UnfollowOrganization.

输入 UnfollowOrganizationInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

ID of the organization to unfollow.

UnfollowUserInput

Autogenerated input type of UnfollowUser.

输入 UnfollowUserInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

userId (ID!)

ID of the user to unfollow.

UnlinkProjectV2FromRepositoryInput

Autogenerated input type of UnlinkProjectV2FromRepository.

输入 UnlinkProjectV2FromRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to unlink from the repository.

repositoryId (ID!)

The ID of the repository to unlink from the project.

UnlinkProjectV2FromTeamInput

Autogenerated input type of UnlinkProjectV2FromTeam.

输入 UnlinkProjectV2FromTeamInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to unlink from the team.

teamId (ID!)

The ID of the team to unlink from the project.

UnlinkRepositoryFromProjectInput

Autogenerated input type of UnlinkRepositoryFromProject.

输入 UnlinkRepositoryFromProjectInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

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.

输入 UnlockLockableInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

lockableId (ID!)

ID of the item to be unlocked.

UnmarkDiscussionCommentAsAnswerInput

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

输入 UnmarkDiscussionCommentAsAnswerInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

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

UnmarkFileAsViewedInput

Autogenerated input type of UnmarkFileAsViewed.

输入 UnmarkFileAsViewedInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

path (String!)

The path of the file to mark as unviewed.

pullRequestId (ID!)

The Node ID of the pull request.

UnmarkIssueAsDuplicateInput

Autogenerated input type of UnmarkIssueAsDuplicate.

输入 UnmarkIssueAsDuplicateInput 字段

名称说明

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

clientMutationId (String)

A unique identifier for the client performing the mutation.

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

UnmarkProjectV2AsTemplateInput

Autogenerated input type of UnmarkProjectV2AsTemplate.

输入 UnmarkProjectV2AsTemplateInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to unmark as a template.

UnminimizeCommentInput

Autogenerated input type of UnminimizeComment.

输入 UnminimizeCommentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the subject to modify.

UnpinIssueInput

Autogenerated input type of UnpinIssue.

输入 UnpinIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueId (ID!)

The ID of the issue to be unpinned.

UnresolveReviewThreadInput

Autogenerated input type of UnresolveReviewThread.

输入 UnresolveReviewThreadInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

threadId (ID!)

The ID of the thread to unresolve.

UnsubscribeFromNotificationsInput

Autogenerated input type of UnsubscribeFromNotifications.

输入 UnsubscribeFromNotificationsInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ids ([ID!]!)

The NotificationThread IDs of the objects to unsubscribe from.

UpdateBranchProtectionRuleInput

Autogenerated input type of UpdateBranchProtectionRule.

输入 UpdateBranchProtectionRuleInput 字段

名称说明

allowsDeletions (Boolean)

Can this branch be deleted.

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

blocksCreations (Boolean)

Is branch creation a protected operation.

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

bypassForcePushActorIds ([ID!])

A list of User, Team, or App IDs allowed to bypass force push targeting matching branches.

bypassPullRequestActorIds ([ID!])

A list of User, Team, or App 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 override branch protection.

lockAllowsFetchAndMerge (Boolean)

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing.

lockBranch (Boolean)

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

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.

requireLastPushApproval (Boolean)

Whether the most recent push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredDeploymentEnvironments ([String!])

The list of required deployment environments.

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.

requiresDeployments (Boolean)

Are successful deployments required 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, Team, or App IDs allowed to dismiss reviews on pull requests targeting matching branches.

UpdateCheckRunInput

Autogenerated input type of UpdateCheckRun.

输入 UpdateCheckRunInput 字段

名称说明

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

checkRunId (ID!)

The node of the check.

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.

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.

UpdateCheckSuitePreferencesInput

Autogenerated input type of UpdateCheckSuitePreferences.

输入 UpdateCheckSuitePreferencesInput 字段

名称说明

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.

输入 UpdateDiscussionCommentInput 字段

名称说明

body (String!)

The new contents of the comment body.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commentId (ID!)

The Node ID of the discussion comment to update.

UpdateDiscussionInput

Autogenerated input type of UpdateDiscussion.

输入 UpdateDiscussionInput 字段

名称说明

body (String)

The new contents of the discussion body.

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

The Node ID of the discussion to update.

title (String)

The new discussion title.

UpdateEnterpriseAdministratorRoleInput

Autogenerated input type of UpdateEnterpriseAdministratorRole.

输入 UpdateEnterpriseAdministratorRoleInput 字段

名称说明

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 administrator whose role is being changed.

role (EnterpriseAdministratorRole!)

The new role for the Enterprise administrator.

UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

输入 UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

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

policyValue (EnterpriseAllowPrivateRepositoryForkingPolicyValue)

The value for the allow private repository forking policy on the enterprise.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

UpdateEnterpriseDefaultRepositoryPermissionSettingInput

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

输入 UpdateEnterpriseDefaultRepositoryPermissionSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

UpdateEnterpriseDeployKeySettingInput

Autogenerated input type of UpdateEnterpriseDeployKeySetting.

输入 UpdateEnterpriseDeployKeySettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the deploy key setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the deploy key setting on the enterprise.

UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

输入 UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput 字段

名称说明

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 change repository visibility setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

UpdateEnterpriseMembersCanCreateRepositoriesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

输入 UpdateEnterpriseMembersCanCreateRepositoriesSettingInput 字段

名称说明

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.

UpdateEnterpriseMembersCanDeleteIssuesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

输入 UpdateEnterpriseMembersCanDeleteIssuesSettingInput 字段

名称说明

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 delete issues setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

输入 UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput 字段

名称说明

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 delete repositories setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

输入 UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput 字段

名称说明

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 invite collaborators setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

UpdateEnterpriseMembersCanMakePurchasesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

输入 UpdateEnterpriseMembersCanMakePurchasesSettingInput 字段

名称说明

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 make purchases setting.

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

输入 UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput 字段

名称说明

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 update protected branches setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

输入 UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput 字段

名称说明

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 view dependency insights setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

UpdateEnterpriseOrganizationProjectsSettingInput

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

输入 UpdateEnterpriseOrganizationProjectsSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

UpdateEnterpriseOwnerOrganizationRoleInput

Autogenerated input type of UpdateEnterpriseOwnerOrganizationRole.

输入 UpdateEnterpriseOwnerOrganizationRoleInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the Enterprise which the owner belongs to.

organizationId (ID!)

The ID of the organization for membership change.

organizationRole (RoleInOrganization!)

The role to assume in the organization.

UpdateEnterpriseProfileInput

Autogenerated input type of UpdateEnterpriseProfile.

输入 UpdateEnterpriseProfileInput 字段

名称说明

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.

UpdateEnterpriseRepositoryProjectsSettingInput

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

输入 UpdateEnterpriseRepositoryProjectsSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

UpdateEnterpriseTeamDiscussionsSettingInput

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

输入 UpdateEnterpriseTeamDiscussionsSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting.

输入 UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the two-factor authentication disallowed methods setting.

settingValue (EnterpriseDisallowedMethodsSettingValue!)

The value for the two-factor authentication disallowed methods setting on the enterprise.

UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

输入 UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

UpdateEnvironmentInput

Autogenerated input type of UpdateEnvironment.

输入 UpdateEnvironmentInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

environmentId (ID!)

The node ID of the environment.

preventSelfReview (Boolean)

Whether deployments to this environment can be approved by the user who created the deployment.

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.

输入 UpdateIpAllowListEnabledSettingInput 字段

名称说明

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.

输入 UpdateIpAllowListEntryInput 字段

名称说明

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.

输入 UpdateIpAllowListForInstalledAppsEnabledSettingInput 字段

名称说明

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.

输入 UpdateIssueCommentInput 字段

名称说明

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.

输入 UpdateIssueInput 字段

名称说明

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.

输入 UpdateLabelInput 字段

名称说明

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.

输入 UpdateNotificationRestrictionSettingInput 字段

名称说明

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.

输入 UpdateOrganizationAllowPrivateRepositoryForkingSettingInput 字段

名称说明

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.

UpdateOrganizationWebCommitSignoffSettingInput

Autogenerated input type of UpdateOrganizationWebCommitSignoffSetting.

输入 UpdateOrganizationWebCommitSignoffSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizationId (ID!)

The ID of the organization on which to set the web commit signoff setting.

webCommitSignoffRequired (Boolean!)

Enable signoff on web-based commits for repositories in the organization?.

UpdateParametersInput

Only allow users with bypass permission to update matching refs.

输入 UpdateParametersInput 字段

名称说明

updateAllowsFetchAndMerge (Boolean!)

Branch can pull changes from its upstream repository.

UpdatePatreonSponsorabilityInput

Autogenerated input type of UpdatePatreonSponsorability.

输入 UpdatePatreonSponsorabilityInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

enablePatreonSponsorships (Boolean!)

Whether Patreon tiers should be shown on the GitHub Sponsors profile page, allowing potential sponsors to make their payment through Patreon instead of GitHub.

sponsorableLogin (String)

The username of the organization with the GitHub Sponsors profile, if any. Defaults to the GitHub Sponsors profile for the authenticated user if omitted.

UpdateProjectCardInput

Autogenerated input type of UpdateProjectCard.

输入 UpdateProjectCardInput 字段

名称说明

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.

输入 UpdateProjectColumnInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project column.

projectColumnId (ID!)

The ProjectColumn ID to update.

UpdateProjectInput

Autogenerated input type of UpdateProject.

输入 UpdateProjectInput 字段

名称说明

body (String)

The description of project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String)

The name of project.

projectId (ID!)

The Project ID to update.

public (Boolean)

Whether the project is public or not.

state (ProjectState)

Whether the project is open or closed.

UpdateProjectV2CollaboratorsInput

Autogenerated input type of UpdateProjectV2Collaborators.

输入 UpdateProjectV2CollaboratorsInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

collaborators ([ProjectV2Collaborator!]!)

The collaborators to update.

projectId (ID!)

The ID of the project to update the collaborators for.

UpdateProjectV2DraftIssueInput

Autogenerated input type of UpdateProjectV2DraftIssue.

输入 UpdateProjectV2DraftIssueInput 字段

名称说明

assigneeIds ([ID!])

The IDs of the assignees of the draft issue.

body (String)

The body of the draft issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssueId (ID!)

The ID of the draft issue to update.

title (String)

The title of the draft issue.

UpdateProjectV2FieldInput

Autogenerated input type of UpdateProjectV2Field.

输入 UpdateProjectV2FieldInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to update.

name (String)

The name to update.

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

Options for a field of type SINGLE_SELECT. If empty, no changes will be made to the options. If values are present, they will overwrite the existing options for the field.

UpdateProjectV2Input

Autogenerated input type of UpdateProjectV2.

输入 UpdateProjectV2Input 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

closed (Boolean)

Set the project to closed or open.

projectId (ID!)

The ID of the Project to update.

public (Boolean)

Set the project to public or private.

readme (String)

Set the readme description of the project.

shortDescription (String)

Set the short description of the project.

title (String)

Set the title of the project.

UpdateProjectV2ItemFieldValueInput

Autogenerated input type of UpdateProjectV2ItemFieldValue.

输入 UpdateProjectV2ItemFieldValueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to be updated.

itemId (ID!)

The ID of the item to be updated.

projectId (ID!)

The ID of the Project.

value (ProjectV2FieldValue!)

The value which will be set on the field.

UpdateProjectV2ItemPositionInput

Autogenerated input type of UpdateProjectV2ItemPosition.

输入 UpdateProjectV2ItemPositionInput 字段

名称说明

afterId (ID)

The ID of the item to position this item after. If omitted or set to null the item will be moved to top.

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the item to be moved.

projectId (ID!)

The ID of the Project.

UpdateProjectV2StatusUpdateInput

Autogenerated input type of UpdateProjectV2StatusUpdate.

输入 UpdateProjectV2StatusUpdateInput 字段

名称说明

body (String)

The body of the status update.

clientMutationId (String)

A unique identifier for the client performing the mutation.

startDate (Date)

The start date of the status update.

status (ProjectV2StatusUpdateStatus)

The status of the status update.

statusUpdateId (ID!)

The ID of the status update to be updated.

targetDate (Date)

The target date of the status update.

UpdatePullRequestBranchInput

Autogenerated input type of UpdatePullRequestBranch.

输入 UpdatePullRequestBranchInput 字段

名称说明

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.

updateMethod (PullRequestBranchUpdateMethod)

The update branch method to use. If omitted, defaults to 'MERGE'.

UpdatePullRequestInput

Autogenerated input type of UpdatePullRequest.

输入 UpdatePullRequestInput 字段

名称说明

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.

输入 UpdatePullRequestReviewCommentInput 字段

名称说明

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.

输入 UpdatePullRequestReviewInput 字段

名称说明

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.

输入 UpdateRefInput 字段

名称说明

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.

输入 UpdateRefsInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

refUpdates ([RefUpdate!]!)

A list of ref updates.

repositoryId (ID!)

The Node ID of the repository.

UpdateRepositoryInput

Autogenerated input type of UpdateRepository.

输入 UpdateRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

hasDiscussionsEnabled (Boolean)

Indicates if the repository should have the discussions feature enabled.

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

hasSponsorshipsEnabled (Boolean)

Indicates if the repository displays a Sponsor button for financial contributions.

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

name (String)

The new name of the repository.

repositoryId (ID!)

The ID of the repository to update.

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.

UpdateRepositoryRulesetInput

Autogenerated input type of UpdateRepositoryRuleset.

输入 UpdateRepositoryRulesetInput 字段

名称说明

bypassActors ([RepositoryRulesetBypassActorInput!])

A list of actors that are allowed to bypass rules in this ruleset.

clientMutationId (String)

A unique identifier for the client performing the mutation.

conditions (RepositoryRuleConditionsInput)

The list of conditions for this ruleset.

enforcement (RuleEnforcement)

The enforcement level for this ruleset.

name (String)

The name of the ruleset.

repositoryRulesetId (ID!)

The global relay id of the repository ruleset to be updated.

rules ([RepositoryRuleInput!])

The list of rules for this ruleset.

target (RepositoryRulesetTarget)

The target of the ruleset.

UpdateRepositoryWebCommitSignoffSettingInput

Autogenerated input type of UpdateRepositoryWebCommitSignoffSetting.

输入 UpdateRepositoryWebCommitSignoffSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to update.

webCommitSignoffRequired (Boolean!)

Indicates if the repository should require signoff on web-based commits.

UpdateSponsorshipPreferencesInput

Autogenerated input type of UpdateSponsorshipPreferences.

输入 UpdateSponsorshipPreferencesInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

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.

UpdateSubscriptionInput

Autogenerated input type of UpdateSubscription.

输入 UpdateSubscriptionInput 字段

名称说明

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.

输入 UpdateTeamDiscussionCommentInput 字段

名称说明

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.

输入 UpdateTeamDiscussionInput 字段

名称说明

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.

输入 UpdateTeamReviewAssignmentInput 字段

名称说明

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

countMembersAlreadyRequested (Boolean)

Count any members whose review has already been requested against the required number of members assigned to review.

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.

includeChildTeamMembers (Boolean)

Include the members of any child teams when assigning.

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

removeTeamRequest (Boolean)

Remove the team review request when assigning.

teamMemberCount (Int)

The number of team members to assign.

UpdateTeamsRepositoryInput

Autogenerated input type of UpdateTeamsRepository.

输入 UpdateTeamsRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

permission (RepositoryPermission!)

Permission that should be granted to the teams.

repositoryId (ID!)

Repository ID being granted access to.

teamIds ([ID!]!)

A list of teams being granted access. Limit: 10.

UpdateTopicsInput

Autogenerated input type of UpdateTopics.

输入 UpdateTopicsInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The Node ID of the repository.

topicNames ([String!]!)

An array of topic names.

UpdateUserListInput

Autogenerated input type of UpdateUserList.

输入 UpdateUserListInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A description of the list.

isPrivate (Boolean)

Whether or not the list is private.

listId (ID!)

The ID of the list to update.

name (String)

The name of the list.

UpdateUserListsForItemInput

Autogenerated input type of UpdateUserListsForItem.

输入 UpdateUserListsForItemInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The item to add to the list.

listIds ([ID!]!)

The lists to which this item should belong.

suggestedListIds ([ID!])

The suggested lists to create and add this item to.

UserStatusOrder

Ordering options for user status connections.

输入 UserStatusOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (UserStatusOrderField!)

The field to order user statuses by.

VerifiableDomainOrder

Ordering options for verifiable domain connections.

输入 VerifiableDomainOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (VerifiableDomainOrderField!)

The field to order verifiable domains by.

VerifyVerifiableDomainInput

Autogenerated input type of VerifyVerifiableDomain.

输入 VerifyVerifiableDomainInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to verify.

WorkflowFileReferenceInput

A workflow that must run for this rule to pass.

输入 WorkflowFileReferenceInput 字段

名称说明

path (String!)

The path to the workflow file.

ref (String)

The ref (branch or tag) of the workflow file to use.

repositoryId (Int!)

The ID of the repository where the workflow is defined.

sha (String)

The commit SHA of the workflow file to use.

WorkflowRunOrder

Ways in which lists of workflow runs can be ordered upon return.

输入 WorkflowRunOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order workflow runs by the specified field.

field (WorkflowRunOrderField!)

The field by which to order workflows.

WorkflowsParametersInput

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

输入 WorkflowsParametersInput 字段

名称说明

doNotEnforceOnCreate (Boolean)

Allow repositories and branches to be created if a check would otherwise prohibit it.

workflows ([WorkflowFileReferenceInput!]!)

Workflows that must pass for this rule to pass.