跳至主要内容

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

本文内容

关于输入对象

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

例如,CommitAuthor 接收一个名为 emails 的字段。为 emails 提供值会将 CommitAuthor 转换为包含该电子邮件地址的 User 对象列表。请注意,对象 **可能**具有输入对象,而变异 **需要**输入对象。

有关更多信息,请参阅“使用 GraphQL 形成调用”。

AbortQueuedMigrationsInput

AbortQueuedMigrations 的自动生成的输入类型。

AbortQueuedMigrationsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ownerId (ID!)

正在运行迁移的组织的 ID。

AbortRepositoryMigrationInput

AbortRepositoryMigration 的自动生成的输入类型。

AbortRepositoryMigrationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

migrationId (ID!)

要中止的迁移的 ID。

AcceptEnterpriseAdministratorInvitationInput

AcceptEnterpriseAdministratorInvitation 的自动生成的输入类型。

AcceptEnterpriseAdministratorInvitationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

invitationId (ID!)

正在接受的邀请的 ID。

AcceptEnterpriseMemberInvitationInput

AcceptEnterpriseMemberInvitation 的自动生成的输入类型。

AcceptEnterpriseMemberInvitationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

invitationId (ID!)

正在接受的邀请的 ID。

AcceptTopicSuggestionInput

AcceptTopicSuggestion 的自动生成的输入类型。

AcceptTopicSuggestionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String)

建议主题的名称。

2024-04-01 UTC 的即将发生的变化 描述:name 将被删除。 原因:不再支持建议的主题。

repositoryId (ID)

存储库的节点 ID。

2024-04-01 UTC 的即将发生的变化 描述:repositoryId 将被删除。 原因:不再支持建议的主题。

AddAssigneesToAssignableInput

AddAssigneesToAssignable 的自动生成的输入类型。

AddAssigneesToAssignableInput 的输入字段

名称描述

assignableId (ID!)

要向其添加受让人的可分配对象的 ID。

assigneeIds ([ID!]!)

要添加为受让人用户的 ID。

clientMutationId (String)

执行变异的客户端的唯一标识符。

AddCommentInput

AddComment 的自动生成的输入类型。

AddCommentInput 的输入字段

名称描述

body (String!)

评论的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

subjectId (ID!)

要修改的主题的节点 ID。

AddDiscussionCommentInput

AddDiscussionComment 的自动生成的输入类型。

AddDiscussionCommentInput 的输入字段

名称描述

body (String!)

评论的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

discussionId (ID!)

要评论的讨论的节点 ID。

replyToId (ID)

在此讨论中要回复的讨论评论的节点 ID。

AddDiscussionPollVoteInput

AddDiscussionPollVote 的自动生成的输入类型。

AddDiscussionPollVoteInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pollOptionId (ID!)

要投票的讨论投票选项的节点 ID。

AddEnterpriseOrganizationMemberInput

AddEnterpriseOrganizationMember 的自动生成的输入类型。

AddEnterpriseOrganizationMemberInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

拥有该组织的企业的 ID。

organizationId (ID!)

将添加用户的组织的 ID。

role (OrganizationMemberRole)

要分配给组织中用户的角色。

userIds ([ID!]!)

要添加的企业成员的 ID。

AddEnterpriseSupportEntitlementInput

AddEnterpriseSupportEntitlement 的自动生成的输入类型。

AddEnterpriseSupportEntitlementInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

管理员所属的企业的 ID。

login (String!)

将接收支持权利的成员的登录名。

AddLabelsToLabelableInput

AddLabelsToLabelable 的自动生成的输入类型。

AddLabelsToLabelableInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

labelIds ([ID!]!)

要添加的标签的 ID。

labelableId (ID!)

要向其添加标签的可标记对象的 ID。

AddProjectCardInput

AddProjectCard 的自动生成的输入类型。

AddProjectCardInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

contentId (ID)

卡片的内容。必须是 ProjectCardItem 联合的成员。

note (String)

卡片上的注释。

projectColumnId (ID!)

ProjectColumn 的节点 ID。

AddProjectColumnInput

AddProjectColumn 的自动生成的输入类型。

AddProjectColumnInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String!)

列的名称。

projectId (ID!)

项目的节点 ID。

AddProjectV2DraftIssueInput

AddProjectV2DraftIssue 的自动生成的输入类型。

AddProjectV2DraftIssueInput 的输入字段

名称描述

assigneeIds ([ID!])

草稿问题的受让人 ID。

body (String)

草稿问题的正文。

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要向其添加草稿问题的项目的 ID。

title (String!)

草稿问题的标题。如果您可以访问,也可以通过提供问题或拉取请求的 URL 来创建项目项。

AddProjectV2ItemByIdInput

AddProjectV2ItemById 的自动生成的输入类型。

AddProjectV2ItemByIdInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

contentId (ID!)

要添加的 Issue 或 Pull Request 的 ID。

projectId (ID!)

要将项目项添加到其中的项目的 ID。

AddPullRequestReviewCommentInput

AddPullRequestReviewComment 的自动生成的输入类型。

AddPullRequestReviewCommentInput 的输入字段

名称描述

body (String)

评论的文本。此字段是必需的

2023-10-01 UTC 将进行的变更 说明:body 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply 原因:我们即将弃用 addPullRequestReviewComment 突变。

clientMutationId (String)

执行变异的客户端的唯一标识符。

commitOID (GitObjectID)

要评论的提交的 SHA。

2023-10-01 UTC 将进行的变更 说明:commitOID 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply 原因:我们即将弃用 addPullRequestReviewComment 突变。

inReplyTo (ID)

要回复的评论 ID。

2023-10-01 UTC 将进行的变更 说明:inReplyTo 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply 原因:我们即将弃用 addPullRequestReviewComment 突变。

path (String)

要评论的文件的相对路径。

2023-10-01 UTC 将进行的变更 说明:path 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply 原因:我们即将弃用 addPullRequestReviewComment 突变。

position (Int)

要评论的 diff 中的行索引。

2023-10-01 UTC 将进行的变更 说明:position 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply 原因:我们即将弃用 addPullRequestReviewComment 突变。

pullRequestId (ID)

正在审查的拉取请求的节点 ID

2023-10-01 UTC 将进行的变更 说明:pullRequestId 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply 原因:我们即将弃用 addPullRequestReviewComment 突变。

pullRequestReviewId (ID)

要修改的审查的节点 ID。

2023-10-01 UTC 将进行的变更 说明:pullRequestReviewId 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply 原因:我们即将弃用 addPullRequestReviewComment 突变。

AddPullRequestReviewInput

AddPullRequestReview 的自动生成的输入类型。

AddPullRequestReviewInput 的输入字段

名称描述

body (String)

审查正文评论的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

comments ([DraftPullRequestReviewComment])

审查行注释。

2023-10-01 UTC 将进行的变更 说明:comments 将被移除。请改用 threads 参数 原因:我们即将弃用使用 diff 相对定位的注释字段。

commitOID (GitObjectID)

审查相关的提交 OID。

event (PullRequestReviewEvent)

要在拉取请求审查上执行的事件。

pullRequestId (ID!)

要修改的拉取请求的节点 ID。

threads ([DraftPullRequestReviewThread])

审查行注释线程。

AddPullRequestReviewThreadInput

AddPullRequestReviewThread 的自动生成的输入类型。

AddPullRequestReviewThreadInput 的输入字段

名称描述

body (String!)

线程第一个评论的正文。

clientMutationId (String)

执行变异的客户端的唯一标识符。

line (Int)

线程引用的 Blob 的行,对于行级线程是必需的。多行注释的行范围的结束。

path (String!)

正在评论的文件的路径。

pullRequestId (ID)

正在审查的拉取请求的节点 ID。

pullRequestReviewId (ID)

要修改的审查的节点 ID。

side (DiffSide)

行所在的 diff 的一侧。对于多行注释,这是行范围结束的一侧。

startLine (Int)

注释引用的范围的第一行。

startSide (DiffSide)

起始行所在的 diff 的一侧。

subjectType (PullRequestReviewThreadSubjectType)

相应线程中的注释所针对的级别,可以是 diff 行或文件。

AddPullRequestReviewThreadReplyInput

AddPullRequestReviewThreadReply 的自动生成的输入类型。

AddPullRequestReviewThreadReplyInput 的输入字段

名称描述

body (String!)

回复的文本。

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestReviewId (ID)

回复将属于的待处理审查的节点 ID。

pullRequestReviewThreadId (ID!)

正在编写此回复的线程的节点 ID。

AddReactionInput

AddReaction 的自动生成的输入类型。

AddReactionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

content (ReactionContent!)

要做出反应的表情符号的名称。

subjectId (ID!)

要修改的主题的节点 ID。

AddStarInput

AddStar 的自动生成的输入类型。

AddStarInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

starrableId (ID!)

要加星标的 Starrable ID。

AddUpvoteInput

AddUpvote 的自动生成的输入类型。

AddUpvoteInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

subjectId (ID!)

要点赞的讨论或评论的节点 ID。

AddVerifiableDomainInput

AddVerifiableDomain 的自动生成的输入类型。

AddVerifiableDomainInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

domain (URI!)

域的 URL。

ownerId (ID!)

要向其添加域的所有者的 ID。

ApproveDeploymentsInput

ApproveDeployments 的自动生成的输入类型。

ApproveDeploymentsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

comment (String)

批准部署的可选注释。

environmentIds ([ID!]!)

要拒绝部署的环境的 ID。

workflowRunId (ID!)

包含待处理部署的工作流运行的节点 ID。

ApproveVerifiableDomainInput

ApproveVerifiableDomain 的自动生成的输入类型。

ApproveVerifiableDomainInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要批准的可验证域的 ID。

ArchiveProjectV2ItemInput

ArchiveProjectV2Item 的自动生成的输入类型。

ArchiveProjectV2ItemInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

itemId (ID!)

要存档的 ProjectV2Item 的 ID。

projectId (ID!)

要从中存档项目的项目的 ID。

ArchiveRepositoryInput

ArchiveRepository 的自动生成的输入类型。

ArchiveRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryId (ID!)

要标记为已存档的存储库的 ID。

AuditLogOrder

审计日志连接的排序选项。

AuditLogOrder 的输入字段

名称描述

direction (OrderDirection)

排序方向。

field (AuditLogOrderField)

要按其对审计日志进行排序的字段。

BranchNamePatternParametersInput

要用于 branch_name_pattern 规则的参数。

BranchNamePatternParametersInput 的输入字段

名称描述

name (String)

此规则将如何显示给用户。

negate (Boolean)

如果为 true,则如果模式匹配,规则将失败。

operator (String!)

要用于匹配的操作符。

pattern (String!)

要匹配的模式。

BulkSponsorship

有关要为具有 GitHub Sponsors 个人资料的用户或组织进行的赞助的信息,作为一次性赞助许多用户或组织的一部分。

BulkSponsorship 的输入字段

名称描述

amount (Int!)

支付给可赞助对象的金额(以美元计)。有效值:1-12000。

sponsorableId (ID)

接收赞助的用户或组织的 ID。如果未给出 sponsorableLogin,则需要此项。

sponsorableLogin (String)

接收赞助的用户或组织的用户名。如果未给出 sponsorableId,则需要此项。

CancelEnterpriseAdminInvitationInput

CancelEnterpriseAdminInvitation 的自动生成输入类型。

CancelEnterpriseAdminInvitationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

invitationId (ID!)

待处理企业管理员邀请的节点 ID。

CancelEnterpriseMemberInvitationInput

CancelEnterpriseMemberInvitation 的自动生成输入类型。

CancelEnterpriseMemberInvitationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

invitationId (ID!)

待处理企业成员邀请的节点 ID。

CancelSponsorshipInput

CancelSponsorship 的自动生成输入类型。

CancelSponsorshipInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

sponsorId (ID)

充当赞助商(支付赞助费用)的用户或组织的 ID。如果未提供 sponsorLogin,则此字段必填。

sponsorLogin (String)

充当赞助商(支付赞助费用)的用户或组织的用户名。如果未提供 sponsorId,则此字段必填。

sponsorableId (ID)

接收赞助的用户或组织的 ID。如果未给出 sponsorableLogin,则需要此项。

sponsorableLogin (String)

接收赞助的用户或组织的用户名。如果未给出 sponsorableId,则需要此项。

ChangeUserStatusInput

ChangeUserStatus 的自动生成输入类型。

ChangeUserStatusInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

emoji (String)

表示您状态的表情符号。可以是原生 Unicode 表情符号,也可以是带冒号的表情符号名称,例如 😀。

expiresAt (DateTime)

如果设置,则用户状态将在此日期之后不再显示。

limitedAvailability (Boolean)

此状态是否应表示您在 GitHub 上无法完全使用,例如,您不在。

message (String)

您当前状态的简短描述。

organizationId (ID)

允许查看状态的组织成员的组织 ID。如果省略,则状态将公开可见。

CheckAnnotationData

来自代码检查运行分析的特定代码行的信息。

CheckAnnotationData 的输入字段

名称描述

annotationLevel (CheckAnnotationLevel!)

表示注释的信息级别。

location (CheckAnnotationRange!)

注释的位置。

message (String!)

针对这些代码行的反馈的简短描述。

path (String!)

要向其添加注释的文件的路径。

rawDetails (String)

有关此注释的详细信息。

title (String)

表示注释的标题。

CheckAnnotationRange

来自代码检查运行分析的特定代码行的信息。

CheckAnnotationRange 的输入字段

名称描述

endColumn (Int)

范围的结束列。

endLine (Int!)

范围的结束行。

startColumn (Int)

范围的起始列。

startLine (Int!)

范围的起始行。

CheckRunAction

集成商可以执行的其他操作。

CheckRunAction 的输入字段

名称描述

description (String!)

此操作将执行的操作的简短说明。

identifier (String!)

集成商系统上操作的参考。

label (String!)

将在 Web UI 中按钮上显示的文本。

CheckRunFilter

获取代码检查运行时可用的筛选器。

CheckRunFilter 的输入字段

名称描述

appId (Int)

筛选由此应用程序 ID 创建的代码检查运行。

checkName (String)

按此名称筛选代码检查运行。

checkType (CheckRunType)

按此类型筛选代码检查运行。

conclusions ([CheckConclusionState!])

按这些结论筛选代码检查运行。

status (CheckStatusState)

按此状态筛选代码检查运行。已被 statuses 取代。

statuses ([CheckStatusState!])

按此状态筛选代码检查运行。覆盖 status。

CheckRunOutput

有关代码检查运行的描述性详细信息。

CheckRunOutput 的输入字段

名称描述

annotations ([CheckAnnotationData!])

作为代码检查运行一部分而做出的注释。

images ([CheckRunOutputImage!])

附加到代码检查运行输出的图像,显示在 GitHub 拉取请求 UI 中。

summary (String!)

代码检查运行的摘要(支持 CommonMark)。

text (String)

代码检查运行的详细信息(支持 CommonMark)。

title (String!)

为此代码检查运行提供的标题。

CheckRunOutputImage

附加到代码检查运行输出的图像,显示在 GitHub 拉取请求 UI 中。

CheckRunOutputImage 的输入字段

名称描述

alt (String!)

图像的替代文本。

caption (String)

简短的图像描述。

imageUrl (URI!)

图像的完整 URL。

CheckSuiteAutoTriggerPreference

代码检查套件可用的自动触发首选项。

CheckSuiteAutoTriggerPreference 的输入字段

名称描述

appId (ID!)

拥有代码检查套件的应用程序的节点 ID。

setting (Boolean!)

设置为 true 以在向存储库推送时自动创建 CheckSuite 事件。

CheckSuiteFilter

获取代码检查套件时可用的筛选器。

CheckSuiteFilter 的输入字段

名称描述

appId (Int)

筛选由此应用程序 ID 创建的代码检查套件。

checkName (String)

按此名称筛选代码检查套件。

ClearLabelsFromLabelableInput

ClearLabelsFromLabelable 的自动生成输入类型。

ClearLabelsFromLabelableInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

labelableId (ID!)

要从中清除标签的可标记对象的 ID。

ClearProjectV2ItemFieldValueInput

ClearProjectV2ItemFieldValue 的自动生成输入类型。

ClearProjectV2ItemFieldValueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

fieldId (ID!)

要清除的字段的 ID。

itemId (ID!)

要清除的项目的 ID。

projectId (ID!)

项目的 ID。

CloneProjectInput

CloneProject 的自动生成输入类型。

CloneProjectInput 的输入字段

名称描述

body (String)

项目的描述。

clientMutationId (String)

执行变异的客户端的唯一标识符。

includeWorkflows (Boolean!)

是否克隆源项目的 workflows。

name (String!)

项目名称。

public (Boolean)

项目的可见性,默认为 false(私有)。

sourceId (ID!)

要克隆的源项目。

targetOwnerId (ID!)

要在其下创建项目的拥有者 ID。

CloneTemplateRepositoryInput

CloneTemplateRepository 的自动生成输入类型。

CloneTemplateRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String)

新存储库的简短描述。

includeAllBranches (Boolean)

是否从模板复制所有分支到新存储库。默认为仅复制模板的默认分支。

name (String!)

新存储库的名称。

ownerId (ID!)

新存储库的拥有者的 ID。

repositoryId (ID!)

模板存储库的节点 ID。

visibility (RepositoryVisibility!)

指示存储库的可见性级别。

CloseDiscussionInput

CloseDiscussion 的自动生成输入类型。

CloseDiscussionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

discussionId (ID!)

要关闭的讨论的 ID。

reason (DiscussionCloseReason)

关闭讨论的原因。

CloseIssueInput

CloseIssue 的自动生成输入类型。

CloseIssueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

issueId (ID!)

要关闭的问题的 ID。

stateReason (IssueClosedStateReason)

关闭问题的原因。

ClosePullRequestInput

ClosePullRequest 的自动生成输入类型。

ClosePullRequestInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestId (ID!)

要关闭的拉取请求的 ID。

CodeScanningParametersInput

选择在更新引用之前哪些工具必须提供代码扫描结果。配置后,代码扫描必须启用并具有要更新的提交和引用的结果。

CodeScanningParametersInput 的输入字段

名称描述

codeScanningTools ([CodeScanningToolInput!]!)

要使此规则通过,必须提供代码扫描结果的工具。

CodeScanningToolInput

要使此规则通过,必须提供代码扫描结果的工具。

CodeScanningToolInput 的输入字段

名称描述

alertsThreshold (String!)

引发警报的代码扫描结果阻止引用更新的严重级别。有关警报严重级别的更多信息,请参阅“关于代码扫描警报”。

securityAlertsThreshold (String!)

引发安全警报的代码扫描结果阻止引用更新的严重级别。有关安全严重级别的更多信息,请参阅“关于代码扫描警报”。

tool (String!)

代码扫描工具的名称。

CommitAuthor

指定用于过滤 Git 提交的作者。

CommitAuthor 的输入字段

名称描述

emails ([String!])

要过滤的电子邮件地址。将返回由指定电子邮件地址中的任何一个编写的提交。

id (ID)

要过滤的用户 ID。如果非空,则仅返回由此用户编写的提交。此字段优先于电子邮件。

CommitAuthorEmailPatternParametersInput

要用于 commit_author_email_pattern 规则的参数。

CommitAuthorEmailPatternParametersInput 的输入字段

名称描述

name (String)

此规则将如何显示给用户。

negate (Boolean)

如果为 true,则如果模式匹配,规则将失败。

operator (String!)

要用于匹配的操作符。

pattern (String!)

要匹配的模式。

CommitContributionOrder

提交贡献连接的排序选项。

CommitContributionOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (CommitContributionOrderField!)

用于排序提交贡献的字段。

CommitMessage

要包含在新提交中的消息。

CommitMessage 的输入字段

名称描述

body (String)

消息的主体。

headline (String!)

消息的标题。

CommitMessagePatternParametersInput

要用于 commit_message_pattern 规则的参数。

CommitMessagePatternParametersInput 的输入字段

名称描述

name (String)

此规则将如何显示给用户。

negate (Boolean)

如果为 true,则如果模式匹配,规则将失败。

operator (String!)

要用于匹配的操作符。

pattern (String!)

要匹配的模式。

CommittableBranch

要追加提交的 Git 引用。

该引用必须是分支,即其完全限定名称必须以 refs/heads/ 开头(尽管输入不需要是完全限定的)。

可以通过其全局节点 ID 或 repositoryNameWithOwnerbranchName 指定 Ref。

示例

使用全局节点 ID 指定分支

{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }

使用 repositoryNameWithOwnerbranchName 指定分支

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

CommittableBranch 的输入字段

名称描述

branchName (String)

要将提交追加到的分支的非限定名称。

id (ID)

要更新的 Ref 的节点 ID。

repositoryNameWithOwner (String)

要提交到的存储库的 nameWithOwner

CommitterEmailPatternParametersInput

要用于 committer_email_pattern 规则的参数。

CommitterEmailPatternParametersInput 的输入字段

名称描述

name (String)

此规则将如何显示给用户。

negate (Boolean)

如果为 true,则如果模式匹配,规则将失败。

operator (String!)

要用于匹配的操作符。

pattern (String!)

要匹配的模式。

ContributionOrder

贡献连接的排序选项。

ContributionOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

ConvertProjectCardNoteToIssueInput

ConvertProjectCardNoteToIssue 的自动生成的输入类型。

ConvertProjectCardNoteToIssueInput 的输入字段

名称描述

body (String)

新创建的问题的主体。

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectCardId (ID!)

要转换的 ProjectCard ID。

repositoryId (ID!)

要在其中创建问题的存储库的 ID。

title (String)

新创建的问题的标题。默认为卡片的注释文本。

ConvertProjectV2DraftIssueItemToIssueInput

ConvertProjectV2DraftIssueItemToIssue 的自动生成的输入类型。

ConvertProjectV2DraftIssueItemToIssueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

itemId (ID!)

要转换的草稿问题 ProjectV2Item 的 ID。

repositoryId (ID!)

要在其中创建问题的存储库的 ID。

ConvertPullRequestToDraftInput

ConvertPullRequestToDraft 的自动生成的输入类型。

ConvertPullRequestToDraftInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestId (ID!)

要转换为草稿的拉取请求的 ID。

CopyProjectV2Input

CopyProjectV2 的自动生成的输入类型。

CopyProjectV2Input 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

includeDraftIssues (Boolean)

在新的项目中包含草稿问题。

ownerId (ID!)

新项目的拥有者 ID。

projectId (ID!)

要复制的源项目的 ID。

title (String!)

项目的标题。

CreateAttributionInvitationInput

CreateAttributionInvitation 的自动生成的输入类型。

CreateAttributionInvitationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ownerId (ID!)

限定可重新归属数据的拥有者的节点 ID。

sourceId (ID!)

拥有要重新归属的数据的帐户的节点 ID。

targetId (ID!)

可以声明数据的帐户的节点 ID。

CreateBranchProtectionRuleInput

CreateBranchProtectionRule 的自动生成的输入类型。

CreateBranchProtectionRuleInput 的输入字段

名称描述

allowsDeletions (Boolean)

此分支是否可以删除。

allowsForcePushes (Boolean)

在此分支上是否允许强制推送。

blocksCreations (Boolean)

分支创建是否为受保护的操作。

bypassForcePushActorIds ([ID!])

允许绕过针对匹配分支的强制推送的用户、团队或应用 ID 列表。

bypassPullRequestActorIds ([ID!])

允许绕过针对匹配分支的拉取请求的用户、团队或应用 ID 列表。

clientMutationId (String)

执行变异的客户端的唯一标识符。

dismissesStaleReviews (Boolean)

推送到匹配分支的新提交是否会取消拉取请求审查批准。

isAdminEnforced (Boolean)

管理员是否可以覆盖分支保护。

lockAllowsFetchAndMerge (Boolean)

当分支被锁定时,用户是否可以从上游拉取更改。设置为 true 以允许 fork 同步。设置为 false 以防止 fork 同步。

lockBranch (Boolean)

是否将分支设置为只读。如果为真,用户将无法推送到该分支。

pattern (String!)

用于确定匹配分支的类似通配符的模式。

pushActorIds ([ID!])

允许推送到匹配分支的用户、团队或应用 ID 列表。

repositoryId (ID!)

应在其中创建新的分支保护规则的存储库的全局中继 ID。

requireLastPushApproval (Boolean)

最近的推送是否必须由推送者以外的人员批准。

requiredApprovingReviewCount (Int)

更新匹配分支所需的批准审查次数。

requiredDeploymentEnvironments ([String!])

所需的部署环境列表。

requiredStatusCheckContexts ([String!])

必须通过才能将提交接受到匹配分支的状态检查上下文列表。

requiredStatusChecks ([RequiredStatusCheckInput!])

所需状态检查列表。

requiresApprovingReviews (Boolean)

更新匹配分支是否需要批准审查。

requiresCodeOwnerReviews (Boolean)

更新匹配分支是否需要代码所有者的审查。

requiresCommitSignatures (Boolean)

提交是否需要签名。

requiresConversationResolution (Boolean)

合并前是否需要解决对话。

requiresDeployments (Boolean)

合并前是否需要成功的部署。

requiresLinearHistory (Boolean)

是否禁止将合并提交推送到此分支。

requiresStatusChecks (Boolean)

更新匹配分支是否需要状态检查。

requiresStrictStatusChecks (Boolean)

合并前是否需要分支是最新的。

restrictsPushes (Boolean)

推送到匹配分支是否受限。

restrictsReviewDismissals (Boolean)

是否限制取消拉取请求审查。

reviewDismissalActorIds ([ID!])

允许在针对匹配分支的拉取请求上驳回代码审查的用户、团队或应用 ID 列表。

CreateCheckRunInput

CreateCheckRun 的自动生成输入类型。

CreateCheckRunInput 的输入字段

名称描述

actions ([CheckRunAction!])

集成者可以执行的可能的进一步操作,用户可以触发这些操作。

clientMutationId (String)

执行变异的客户端的唯一标识符。

completedAt (DateTime)

检查运行完成的时间。

conclusion (CheckConclusionState)

检查的最终结论。

detailsUrl (URI)

集成者站点上的 URL,其中包含检查的完整详细信息。

externalId (String)

集成者系统上运行的参考。

headSha (GitObjectID!)

头提交的 SHA。

name (String!)

检查的名称。

output (CheckRunOutput)

关于运行的描述性详细信息。

repositoryId (ID!)

存储库的节点 ID。

startedAt (DateTime)

检查运行开始的时间。

status (RequestableCheckStatusState)

当前状态。

CreateCheckSuiteInput

CreateCheckSuite 的自动生成输入类型。

CreateCheckSuiteInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

headSha (GitObjectID!)

头提交的 SHA。

repositoryId (ID!)

存储库的节点 ID。

CreateCommitOnBranchInput

CreateCommitOnBranch 的自动生成输入类型。

CreateCommitOnBranchInput 的输入字段

名称描述

branch (CommittableBranch!)

要更新的 Ref。必须是分支。

clientMutationId (String)

执行变异的客户端的唯一标识符。

expectedHeadOid (GitObjectID!)

提交之前分支头部预期的 git 提交 oid。

fileChanges (FileChanges)

此提交中文件更改的描述。

message (CommitMessage!)

要包含在提交中的提交消息。

CreateDeploymentInput

CreateDeployment 的自动生成输入类型。

CreateDeploymentInput 的输入字段

名称描述

autoMerge (Boolean)

尝试自动将默认分支合并到请求的 ref 中,默认为 true。

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String)

部署的简短描述。

environment (String)

目标部署环境的名称。

payload (String)

包含有关部署的额外信息的 JSON 有效负载。

refId (ID!)

要部署的 ref 的节点 ID。

repositoryId (ID!)

存储库的节点 ID。

requiredContexts ([String!])

要针对其验证提交状态检查的状态上下文。要绕过必需的上下文,请传递一个空数组。默认为所有唯一上下文。

task (String)

指定要执行的任务。

CreateDeploymentStatusInput

CreateDeploymentStatus 的自动生成输入类型。

CreateDeploymentStatusInput 的输入字段

名称描述

autoInactive (Boolean)

为所有与创建的状态的部署具有相同存储库和环境名称的非瞬态、非生产环境部署添加新的非活动状态。

clientMutationId (String)

执行变异的客户端的唯一标识符。

deploymentId (ID!)

部署的节点 ID。

description (String)

状态的简短描述。最大长度为 140 个字符。

environment (String)

如果提供,则更新部署的环境。否则,不修改环境。

environmentUrl (String)

设置用于访问您的环境的 URL。

logUrl (String)

与该状态关联的日志 URL。此 URL 应包含输出,以在任务运行期间保持用户更新,或作为部署中发生情况的历史信息。

state (DeploymentStatusState!)

部署的状态。

CreateDiscussionInput

CreateDiscussion 的自动生成输入类型。

CreateDiscussionInput 的输入字段

名称描述

body (String!)

讨论的主体。

categoryId (ID!)

要与此讨论关联的讨论类别的 ID。

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryId (ID!)

要在其上创建讨论的存储库的 ID。

title (String!)

讨论的标题。

CreateEnterpriseOrganizationInput

CreateEnterpriseOrganization 的自动生成输入类型。

CreateEnterpriseOrganizationInput 的输入字段

名称描述

adminLogins ([String!]!)

新组织管理员的登录名。

billingEmail (String!)

用于发送账单收据的电子邮件。

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

拥有新组织的企业的 ID。

login (String!)

新组织的登录名。

profileName (String!)

新组织的个人资料名称。

CreateEnvironmentInput

CreateEnvironment 的自动生成输入类型。

CreateEnvironmentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String!)

环境的名称。

repositoryId (ID!)

存储库的节点 ID。

CreateIpAllowListEntryInput

CreateIpAllowListEntry 的自动生成输入类型。

CreateIpAllowListEntryInput 的输入字段

名称描述

allowListValue (String!)

以 CIDR 表示法表示的 IP 地址或地址范围。

clientMutationId (String)

执行变异的客户端的唯一标识符。

isActive (Boolean!)

启用 IP 允许列表时,IP 允许列表条目是否处于活动状态。

name (String)

IP 允许列表条目的可选名称。

ownerId (ID!)

要为其创建新的 IP 允许列表条目的所有者的 ID。

CreateIssueInput

CreateIssue 的自动生成输入类型。

CreateIssueInput 的输入字段

名称描述

assigneeIds ([ID!])

此问题的用户受让人节点 ID。

body (String)

问题的描述主体。

clientMutationId (String)

执行变异的客户端的唯一标识符。

issueTemplate (String)

存储库中问题模板的名称,将模板中的标签和受让人分配给问题。

labelIds ([ID!])

此问题标签的节点 ID 数组。

milestoneId (ID)

此问题的里程碑的节点 ID。

projectIds ([ID!])

与此问题关联的项目的节点 ID 数组。

repositoryId (ID!)

存储库的节点 ID。

title (String!)

问题的标题。

CreateLabelInput

CreateLabel 的自动生成输入类型。

CreateLabelInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

color (String!)

一个 6 字符十六进制代码,不带前导 #,标识标签的颜色。

description (String)

标签的简要描述,例如其用途。

name (String!)

标签的名称。

repositoryId (ID!)

存储库的节点 ID。

CreateLinkedBranchInput

CreateLinkedBranch 的自动生成输入类型。

CreateLinkedBranchInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

issueId (ID!)

要链接到的问题的 ID。

name (String)

新分支的名称。默认为问题编号和标题。

oid (GitObjectID!)

要基于其创建新分支的提交 SHA。

repositoryId (ID)

要在其中创建分支的存储库的 ID。默认为问题存储库。

CreateMigrationSourceInput

CreateMigrationSource 的自动生成输入类型。

CreateMigrationSourceInput 的输入字段

名称描述

accessToken (String)

迁移源访问令牌。

clientMutationId (String)

执行变异的客户端的唯一标识符。

githubPat (String)

导入到目标存储库的用户 GitHub 个人访问令牌。

name (String!)

迁移源名称。

ownerId (ID!)

将拥有迁移源的组织的 ID。

type (MigrationSourceType!)

迁移源类型。

url (String)

迁移源 URL,例如 https://github.comhttps://monalisa.ghe.com

CreateProjectInput

CreateProject 的自动生成输入类型。

CreateProjectInput 的输入字段

名称描述

body (String)

项目的描述。

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String!)

项目的名称。

ownerId (ID!)

要在其下创建项目的拥有者 ID。

repositoryIds ([ID!])

要作为项目链接存储库创建的存储库 ID 列表。

template (ProjectTemplate)

GitHub 提供的模板的名称。

CreateProjectV2FieldInput

CreateProjectV2Field 的自动生成输入类型。

CreateProjectV2FieldInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

dataType (ProjectV2CustomFieldType!)

字段的数据类型。

name (String!)

字段的名称。

projectId (ID!)

创建字段所属项目的 ID。

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

单选字段的选项。如果数据类型为 SINGLE_SELECT,则至少需要一个值。

CreateProjectV2Input

CreateProjectV2 的自动生成输入类型。

CreateProjectV2Input 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ownerId (ID!)

要在其下创建项目的拥有者 ID。

repositoryId (ID)

要将项目链接到的仓库。

teamId (ID)

要将项目链接到的团队。该团队将被授予读取权限。

title (String!)

项目的标题。

CreateProjectV2StatusUpdateInput

CreateProjectV2StatusUpdate 的自动生成输入类型。

CreateProjectV2StatusUpdateInput 的输入字段

名称描述

body (String)

状态更新的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

创建状态更新所属项目的 ID。

startDate (Date)

状态更新的开始日期。

status (ProjectV2StatusUpdateStatus)

状态更新的状态。

targetDate (Date)

状态更新的目标日期。

CreatePullRequestInput

CreatePullRequest 的自动生成输入类型。

CreatePullRequestInput 的输入字段

名称描述

baseRefName (String!)

您希望将更改拉取到的分支的名称。这应为当前存储库上的现有分支。您不能更新拉取请求上的基础分支以指向另一个存储库。

body (String)

拉取请求的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

draft (Boolean)

指示此拉取请求是否应为草稿。

headRefName (String!)

实现更改的分支的名称。对于同一网络中的跨存储库拉取请求,请使用用户为 head_ref_name 命名空间,例如:username:branch

headRepositoryId (ID)

头存储库的节点 ID。

maintainerCanModify (Boolean)

指示维护者是否可以修改拉取请求。

repositoryId (ID!)

存储库的节点 ID。

title (String!)

拉取请求的标题。

CreateRefInput

CreateRef 的自动生成输入类型。

CreateRefInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String!)

新 Ref 的完全限定名称(即:refs/heads/my_new_branch)。

oid (GitObjectID!)

新 Ref 将指向的 GitObjectID。必须指向一个提交。

repositoryId (ID!)

在其中创建 Ref 的存储库的节点 ID。

CreateRepositoryInput

CreateRepository 的自动生成输入类型。

CreateRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String)

新存储库的简短描述。

hasIssuesEnabled (Boolean)

指示存储库是否应启用问题功能。

hasWikiEnabled (Boolean)

指示存储库是否应启用 Wiki 功能。

homepageUrl (URI)

有关此存储库的网页的 URL。

name (String!)

新存储库的名称。

ownerId (ID)

新存储库的拥有者的 ID。

teamId (ID)

当指定组织作为所有者时,此 ID 标识应授予新存储库访问权限的团队。

template (Boolean)

此存储库是否应标记为模板,以便任何可以访问它的人都可以使用相同的文件和目录结构创建新的存储库。

visibility (RepositoryVisibility!)

指示存储库的可见性级别。

CreateRepositoryRulesetInput

CreateRepositoryRuleset 的自动生成输入类型。

CreateRepositoryRulesetInput 的输入字段

名称描述

bypassActors ([RepositoryRulesetBypassActorInput!])

允许绕过此规则集中的规则的参与者列表。

clientMutationId (String)

执行变异的客户端的唯一标识符。

conditions (RepositoryRuleConditionsInput!)

此规则集的条件集。

enforcement (RuleEnforcement!)

此规则集的执行级别。

name (String!)

规则集的名称。

rules ([RepositoryRuleInput!])

此规则集的规则列表。

sourceId (ID!)

应在其中创建新规则集的源的全局中继 ID。

target (RepositoryRulesetTarget)

规则集的目标。

CreateSponsorsListingInput

CreateSponsorsListing 的自动生成输入类型。

CreateSponsorsListingInput 的输入字段

名称描述

billingCountryOrRegionCode (SponsorsCountryOrRegionCode)

可赞助者的银行账户所在的国家或地区。如果未指定 fiscalHostLogin,则需要此项,如果指定了 fiscalHostLogin,则忽略此项。

clientMutationId (String)

执行变异的客户端的唯一标识符。

contactEmail (String)

我们应使用哪个电子邮件地址与您联系以创建 GitHub Sponsors 个人资料。此信息不会公开共享。必须是您 GitHub 帐户上已验证的电子邮件地址。仅当可赞助者是您自己时才相关。如果省略,则默认为您已备案的主要电子邮件地址。

fiscalHostLogin (String)

如果要通过财务托管人而不是直接到银行账户接收赞助付款,则为受支持的财务托管人的 GitHub 组织的用户名。例如,Open-Source-Collective用于 Open Source Collective 或 'numfocus' 用于 numFOCUS。不区分大小写。有关更多信息,请参阅 https://docs.github.com/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts

fiscallyHostedProjectProfileUrl (String)

您在财务托管人网站上的个人资料页面的 URL,例如 https://opencollective.com/babelhttps://numfocus.org/project/bokeh。如果指定了 fiscalHostLogin,则需要此项。

fullDescription (String)

提供简介作为主要焦点,显示在您的 GitHub Sponsors 个人资料上。这是一个绝佳的机会,可以帮助潜在赞助商详细了解您、您的工作以及他们的赞助对您为何如此重要。支持 GitHub 风格的 Markdown。

residenceCountryOrRegionCode (SponsorsCountryOrRegionCode)

可赞助者居住的国家或地区。这是出于税务目的。如果可赞助者是您自己,则需要此项,如果 sponsorableLogin 指定了组织,则忽略此项。

sponsorableLogin (String)

要为其创建 GitHub Sponsors 个人资料的组织的用户名(如果需要)。如果省略,则默认为为经过身份验证的用户创建 GitHub Sponsors 个人资料。

CreateSponsorsTierInput

CreateSponsorsTier 的自动生成输入类型。

CreateSponsorsTierInput 的输入字段

名称描述

amount (Int!)

新层级的美元值。有效值:1-12000。

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String!)

此层级的描述,赞助商可能获得的额外福利,此层级的赞助对您的意义等。

isRecurring (Boolean)

使用此层级的赞助是否应每月/每年发生一次或仅发生一次。

publish (Boolean)

是否立即使层级可供赞助商选择。默认为创建草稿层级,该层级不会公开可见。

repositoryId (ID)

此层级的赞助商应获得只读访问权限的私有存储库的可选 ID。必须由组织拥有。

repositoryName (String)

此层级的赞助商应获得只读访问权限的私有存储库的可选名称。必须由组织拥有。如果给出了 repositoryOwnerLogin,则需要此项。如果给出了 repositoryId,则将被忽略。

repositoryOwnerLogin (String)

此层级的赞助商应获得只读访问权限的私有存储库的组织所有者的可选登录名。如果给出了 repositoryName,则需要此项。如果给出了 repositoryId,则将被忽略。

sponsorableId (ID)

拥有 GitHub Sponsors 个人资料的用户或组织的 ID。如果省略且未给出 sponsorableLogin,则默认为当前用户。

sponsorableLogin (String)

拥有 GitHub Sponsors 个人资料的用户或组织的用户名。如果省略且未给出 sponsorableId,则默认为当前用户。

welcomeMessage (String)

此层级的新的赞助商将收到的可选消息。

CreateSponsorshipInput

CreateSponsorship 的自动生成输入类型。

CreateSponsorshipInput 的输入字段

名称描述

amount (Int)

支付给可赞助者的美元金额。如果未指定 tierId,则需要此项。有效值:1-12000。

clientMutationId (String)

执行变异的客户端的唯一标识符。

isRecurring (Boolean)

赞助是否应每月/每年发生一次或仅发生一次。如果未指定 tierId,则需要此项。

privacyLevel (SponsorshipPrivacy)

指定其他人是否应该能够看到赞助商正在赞助可赞助者。公开可见性仍然不会显示使用了哪个层级。

receiveEmails (布尔值)

赞助者是否应接收来自被赞助者的电子邮件更新。

sponsorId (ID)

充当赞助商(支付赞助费用)的用户或组织的 ID。如果未提供 sponsorLogin,则此字段必填。

sponsorLogin (String)

充当赞助商(支付赞助费用)的用户或组织的用户名。如果未提供 sponsorId,则此字段必填。

sponsorableId (ID)

接收赞助的用户或组织的 ID。如果未给出 sponsorableLogin,则需要此项。

sponsorableLogin (String)

接收赞助的用户或组织的用户名。如果未给出 sponsorableId,则需要此项。

tierId (ID)

被赞助者现有层级之一的 ID,用于赞助。如果未指定金额,则为必填项。

CreateSponsorshipsInput

CreateSponsorships 的自动生成输入类型。

CreateSponsorshipsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

privacyLevel (SponsorshipPrivacy)

指定其他人是否能够看到赞助者正在赞助被赞助者。公开可见性仍然不会透露赞助的金额。

receiveEmails (布尔值)

赞助者是否应接收来自被赞助者的电子邮件更新。

recurring (布尔值)

创建的赞助是否应在每个账单周期(每月或每年)持续进行赞助者,而不是仅持续一个月。默认为一次性赞助。

sponsorLogin (字符串!)

充当赞助者(为赞助付费)的用户或组织的用户名。

sponsorships ([BulkSponsorship!]!)

要赞助的维护者列表以及每个维护者的赞助金额。

CreateTeamDiscussionCommentInput

CreateTeamDiscussionComment 的自动生成输入类型。

CreateTeamDiscussionCommentInput 的输入字段

名称描述

body (String)

评论内容。此字段为必填项。

2024-07-01 UTC 的即将发生的变化 描述:body 将被移除。请按照 https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ 中的指南查找合适的替代方案。原因:团队讨论功能已弃用,转而使用组织讨论。

clientMutationId (String)

执行变异的客户端的唯一标识符。

discussionId (ID)

评论所属讨论的 ID。此字段为必填项。

2024-07-01 UTC 的即将发生的变化 描述:discussionId 将被移除。请按照 https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ 中的指南查找合适的替代方案。原因:团队讨论功能已弃用,转而使用组织讨论。

CreateTeamDiscussionInput

CreateTeamDiscussion 的自动生成输入类型。

CreateTeamDiscussionInput 的输入字段

名称描述

body (String)

讨论的内容。此字段为必填项。

2024-07-01 UTC 的即将发生的变化 描述:body 将被移除。请按照 https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ 中的指南查找合适的替代方案。原因:团队讨论功能已弃用,转而使用组织讨论。

clientMutationId (String)

执行变异的客户端的唯一标识符。

private (布尔值)

如果为 true,则将此讨论的可见性限制为团队成员和组织所有者。如果为 false 或未指定,则允许任何组织成员查看此讨论。

2024-07-01 UTC 的即将发生的变化 描述:private 将被移除。请按照 https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ 中的指南查找合适的替代方案。原因:团队讨论功能已弃用,转而使用组织讨论。

teamId (ID)

讨论所属团队的 ID。此字段为必填项。

2024-07-01 UTC 的即将发生的变化 描述:teamId 将被移除。请按照 https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ 中的指南查找合适的替代方案。原因:团队讨论功能已弃用,转而使用组织讨论。

title (String)

讨论的标题。此字段为必填项。

2024-07-01 UTC 的即将发生的变化 描述:title 将被移除。请按照 https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ 中的指南查找合适的替代方案。原因:团队讨论功能已弃用,转而使用组织讨论。

CreateUserListInput

CreateUserList 的自动生成输入类型。

CreateUserListInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String)

列表的描述。

isPrivate (布尔值)

列表是否为私有。

name (String!)

新列表的名称。

DeclineTopicSuggestionInput

DeclineTopicSuggestion 的自动生成输入类型。

DeclineTopicSuggestionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String)

建议主题的名称。

2024-04-01 UTC 的即将发生的变化 描述:name 将被删除。 原因:不再支持建议的主题。

reason (TopicSuggestionDeclineReason)

拒绝建议主题的原因。

2024-04-01 UTC 的即将发生的变化 描述:reason 将被移除。原因:不再支持建议的主题。

repositoryId (ID)

存储库的节点 ID。

2024-04-01 UTC 的即将发生的变化 描述:repositoryId 将被删除。 原因:不再支持建议的主题。

DeleteBranchProtectionRuleInput

DeleteBranchProtectionRule 的自动生成输入类型。

DeleteBranchProtectionRuleInput 的输入字段

名称描述

branchProtectionRuleId (ID!)

要删除的分支保护规则的全局中继 ID。

clientMutationId (String)

执行变异的客户端的唯一标识符。

DeleteDeploymentInput

DeleteDeployment 的自动生成输入类型。

DeleteDeploymentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的部署的节点 ID。

DeleteDiscussionCommentInput

DeleteDiscussionComment 的自动生成输入类型。

DeleteDiscussionCommentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的讨论评论的节点 ID。

DeleteDiscussionInput

DeleteDiscussion 的自动生成输入类型。

DeleteDiscussionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的讨论的 ID。

DeleteEnvironmentInput

DeleteEnvironment 的自动生成输入类型。

DeleteEnvironmentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的环境的节点 ID。

DeleteIpAllowListEntryInput

DeleteIpAllowListEntry 的自动生成输入类型。

DeleteIpAllowListEntryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ipAllowListEntryId (ID!)

要删除的 IP 允许列表条目的 ID。

DeleteIssueCommentInput

DeleteIssueComment 的自动生成输入类型。

DeleteIssueCommentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的评论的 ID。

DeleteIssueInput

DeleteIssue 的自动生成输入类型。

DeleteIssueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

issueId (ID!)

要删除的问题的 ID。

DeleteLabelInput

DeleteLabel 的自动生成输入类型。

DeleteLabelInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的标签的节点 ID。

DeleteLinkedBranchInput

DeleteLinkedBranch 的自动生成输入类型。

DeleteLinkedBranchInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

linkedBranchId (ID!)

链接分支的 ID。

DeletePackageVersionInput

DeletePackageVersion 的自动生成输入类型。

DeletePackageVersionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

packageVersionId (ID!)

要删除的软件包版本的 ID。

DeleteProjectCardInput

DeleteProjectCard 的自动生成输入类型。

DeleteProjectCardInput 的输入字段

名称描述

cardId (ID!)

要删除的卡片的 ID。

clientMutationId (String)

执行变异的客户端的唯一标识符。

DeleteProjectColumnInput

DeleteProjectColumn 的自动生成输入类型。

DeleteProjectColumnInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

columnId (ID!)

要删除的列的 ID。

DeleteProjectInput

DeleteProject 的自动生成输入类型。

DeleteProjectInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要更新的项目 ID。

DeleteProjectV2FieldInput

DeleteProjectV2Field 的自动生成输入类型。

DeleteProjectV2FieldInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

fieldId (ID!)

要删除的字段的 ID。

DeleteProjectV2Input

DeleteProjectV2 的自动生成输入类型。

DeleteProjectV2Input 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要删除的项目的 ID。

DeleteProjectV2ItemInput

DeleteProjectV2Item 的自动生成输入类型。

DeleteProjectV2ItemInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

itemId (ID!)

要移除的项目的 ID。

projectId (ID!)

应从中移除项目的项目的 ID。

DeleteProjectV2StatusUpdateInput

DeleteProjectV2StatusUpdate 的自动生成输入类型。

DeleteProjectV2StatusUpdateInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

statusUpdateId (ID!)

要移除的状态更新的 ID。

DeleteProjectV2WorkflowInput

DeleteProjectV2Workflow 的自动生成输入类型。

DeleteProjectV2WorkflowInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

workflowId (ID!)

要移除的工作流的 ID。

DeletePullRequestReviewCommentInput

DeletePullRequestReviewComment 的自动生成输入类型。

DeletePullRequestReviewCommentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的评论的 ID。

DeletePullRequestReviewInput

DeletePullRequestReview 的自动生成输入类型。

DeletePullRequestReviewInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestReviewId (ID!)

要删除的拉取请求审查的节点 ID。

DeleteRefInput

DeleteRef 的自动生成输入类型。

DeleteRefInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

refId (ID!)

要删除的 Ref 的节点 ID。

DeleteRepositoryRulesetInput

DeleteRepositoryRuleset 的自动生成输入类型。

DeleteRepositoryRulesetInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryRulesetId (ID!)

要删除的仓库规则集的全局中继 ID。

DeleteTeamDiscussionCommentInput

DeleteTeamDiscussionComment 的自动生成的输入类型。

DeleteTeamDiscussionCommentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的评论的 ID。

DeleteTeamDiscussionInput

DeleteTeamDiscussion 的自动生成的输入类型。

DeleteTeamDiscussionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的讨论 ID。

DeleteUserListInput

DeleteUserList 的自动生成的输入类型。

DeleteUserListInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

listId (ID!)

要删除的列表的 ID。

DeleteVerifiableDomainInput

DeleteVerifiableDomain 的自动生成的输入类型。

DeleteVerifiableDomainInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要删除的可验证域的 ID。

DeploymentOrder

部署连接的排序选项。

DeploymentOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (DeploymentOrderField!)

按其排序部署的字段。

DequeuePullRequestInput

DequeuePullRequest 的自动生成的输入类型。

DequeuePullRequestInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要取消入队的拉取请求的 ID。

DisablePullRequestAutoMergeInput

DisablePullRequestAutoMerge 的自动生成的输入类型。

DisablePullRequestAutoMergeInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestId (ID!)

要禁用自动合并的拉取请求的 ID。

DiscussionOrder

返回时可以对讨论列表进行排序的方式。

DiscussionOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段对讨论进行排序的方向。

field (DiscussionOrderField!)

用于对讨论进行排序的字段。

DiscussionPollOptionOrder

讨论投票选项连接的排序选项。

DiscussionPollOptionOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (DiscussionPollOptionOrderField!)

按其排序投票选项的字段。

DismissPullRequestReviewInput

DismissPullRequestReview 的自动生成的输入类型。

DismissPullRequestReviewInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

message (String!)

拉取请求审查驳回消息的内容。

pullRequestReviewId (ID!)

要修改的拉取请求审查的节点 ID。

DismissRepositoryVulnerabilityAlertInput

DismissRepositoryVulnerabilityAlert 的自动生成的输入类型。

DismissRepositoryVulnerabilityAlertInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

dismissReason (DismissReason!)

驳回 Dependabot 告警的原因。

repositoryVulnerabilityAlertId (ID!)

要驳回的 Dependabot 告警 ID。

DraftPullRequestReviewComment

指定要与拉取请求审查一起留下的审查评论。

DraftPullRequestReviewComment 的输入字段

名称描述

body (String!)

要留下的评论的正文。

path (String!)

正在评论的文件的路径。

position (Int!)

在文件中留下评论的位置。

DraftPullRequestReviewThread

指定要与拉取请求审查一起留下的审查评论线程。

DraftPullRequestReviewThread 的输入字段

名称描述

body (String!)

要留下的评论的正文。

line (Int!)

该线程引用的 Blob 的行号。多行注释的行范围的结尾。

path (String!)

正在评论的文件的路径。

side (DiffSide)

行所在的 diff 的一侧。对于多行注释,这是行范围结束的一侧。

startLine (Int)

注释引用的范围的第一行。

startSide (DiffSide)

起始行所在的 diff 的一侧。

EnablePullRequestAutoMergeInput

EnablePullRequestAutoMerge 的自动生成的输入类型。

EnablePullRequestAutoMergeInput 的输入字段

名称描述

authorEmail (String)

与此合并关联的电子邮件地址。

clientMutationId (String)

执行变异的客户端的唯一标识符。

commitBody (String)

当 PR 可合并时用于提交的提交正文;如果省略,则将使用默认消息。注意:使用合并队列合并时,将忽略提交消息的任何输入值。

commitHeadline (String)

当 PR 可合并时用于提交的提交标题;如果省略,则将使用默认消息。注意:使用合并队列合并时,将忽略提交标题的任何输入值。

expectedHeadOid (GitObjectID)

拉取请求的预期头部 OID。

mergeMethod (PullRequestMergeMethod)

要使用的合并方法。如果省略,则默认为 MERGE。注意:使用合并队列合并时,将忽略合并方法的任何输入值。

pullRequestId (ID!)

要启用自动合并的拉取请求的 ID。

EnqueuePullRequestInput

EnqueuePullRequest 的自动生成的输入类型。

EnqueuePullRequestInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

expectedHeadOid (GitObjectID)

拉取请求的预期头部 OID。

jump (Boolean)

将拉取请求添加到队列的前面。

pullRequestId (ID!)

要入队的拉取请求的 ID。

EnterpriseAdministratorInvitationOrder

企业管理员邀请连接的排序选项。

EnterpriseAdministratorInvitationOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseAdministratorInvitationOrderField!)

按其排序企业管理员邀请的字段。

EnterpriseMemberInvitationOrder

企业管理员邀请连接的排序选项。

EnterpriseMemberInvitationOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseMemberInvitationOrderField!)

按其排序企业成员邀请的字段。

EnterpriseMemberOrder

企业成员连接的排序选项。

EnterpriseMemberOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseMemberOrderField!)

按其排序企业成员的字段。

EnterpriseOrder

企业的排序选项。

EnterpriseOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseOrderField!)

按其排序企业的字段。

EnterpriseServerInstallationOrder

企业服务器安装连接的排序选项。

EnterpriseServerInstallationOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseServerInstallationOrderField!)

按其排序企业服务器安装的字段。

EnterpriseServerUserAccountEmailOrder

企业服务器用户帐户电子邮件连接的排序选项。

EnterpriseServerUserAccountEmailOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseServerUserAccountEmailOrderField!)

按其排序电子邮件的字段。

EnterpriseServerUserAccountOrder

企业服务器用户帐户连接的排序选项。

EnterpriseServerUserAccountOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseServerUserAccountOrderField!)

按其排序用户帐户的字段。

EnterpriseServerUserAccountsUploadOrder

企业服务器用户帐户上传连接的排序选项。

EnterpriseServerUserAccountsUploadOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseServerUserAccountsUploadOrderField!)

按其排序用户帐户上传的字段。

Environments

环境的排序选项。

Environments 的输入字段

名称描述

direction (OrderDirection!)

按指定字段对环境进行排序的方向。

field (EnvironmentOrderField!)

用于对环境进行排序的字段。

FileAddition

在给定路径下添加具有给定内容的文件作为提交的一部分的命令。该路径下任何现有的文件都将被替换。

FileAddition 的输入字段

名称描述

contents (Base64String!)

文件的 Base64 编码内容。

path (String!)

存储库中文件所在的位置的路径。

FileChanges

对要作为 Git 提交的一部分对文件树进行的一组更改的描述,建模为零个或多个文件 additions 和零个或多个文件 deletions

这两个字段都是可选的;如果都省略,则会生成一个没有文件更改的提交。

deletionsadditions 描述了使用 unix 样式路径分隔符(即 /)在 git 树中通过其路径标识的文件的更改。git 树的根是一个空字符串,因此路径没有斜杠前缀。

提供的 additionsdeletions 中的所有 path 值必须唯一。任何重复都会导致验证错误。

编码

每个 FileAddition 必须提供完整的文件内容。

FileAdditioncontents 必须使用符合 RFC 4648 的 base64 编码,即需要正确的填充,并且不能使用标准字母表之外的任何字符。无效的 base64 编码将被拒绝并返回验证错误。

编码后的内容可以是二进制的。

对于文本文件,不对文件内容的字符编码(base64 解码后)做任何假设。不会执行字符集转换或行尾规范化;管理他们提供文件的字符编码是客户端的责任。但是,为了最大限度地兼容,我们建议使用 UTF-8 编码,并确保存储库中的所有文件都使用一致的行尾约定(\n\r\n),并且所有文件都以换行符结尾。

建模文件更改

可以使用 FileChanges 类型描述可以在 git 提交中进行的五种概念性更改中的每一种,如下所示

  1. 新增文件:在路径 docs/README.txt 中创建文件 hello world\n

    {
      "additions" [
        {
          "path": "docs/README.txt",
          "contents": base64encode("hello world\n")
        }
      ]
    }
    
  2. 现有文件修改:将现有 docs/README.txt 更改为具有新内容 new content here\n

    {
      "additions" [
        {
          "path": "docs/README.txt",
          "contents": base64encode("new content here\n")
        }
      ]
    }
    
  3. 现有文件删除:删除现有文件 docs/README.txt。请注意,路径必须存在——指定在给定分支上不存在的路径将中止提交并返回错误。

    {
      "deletions" [
        {
          "path": "docs/README.txt"
        }
      ]
    }
    
  4. 文件重命名且无更改:将 docs/README.txt(以前内容为 hello world\n)重命名为 newdocs/README.txt,内容相同。

    {
      "deletions" [
        {
          "path": "docs/README.txt",
        }
      ],
      "additions" [
        {
          "path": "newdocs/README.txt",
          "contents": base64encode("hello world\n")
        }
      ]
    }
    
  5. 文件重命名并更改:将 docs/README.txt(以前内容为 hello world\n)重命名为路径 newdocs/README.txt 处的文件,内容为 new contents\n

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

FileChanges 的输入字段

名称描述

additions ([FileAddition!])

要添加或更改的文件。

deletions ([FileDeletion!])

要删除的文件。

FileDeletion

一个命令,用于在提交过程中删除给定路径下的文件。

FileDeletion 的输入字段

名称描述

path (String!)

要删除的路径。

FileExtensionRestrictionParametersInput

防止将包含指定文件扩展名的文件的提交推送到提交图。

FileExtensionRestrictionParametersInput 的输入字段

名称描述

restrictedFileExtensions ([String!]!)

禁止推送到提交图的文件扩展名。

FilePathRestrictionParametersInput

防止将包含指定文件路径中更改的提交推送到提交图。

FilePathRestrictionParametersInput 的输入字段

名称描述

restrictedFilePaths ([String!]!)

禁止推送到提交图的文件路径。

FollowOrganizationInput

FollowOrganization 的自动生成的输入类型。

FollowOrganizationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

organizationId (ID!)

要关注的组织的 ID。

FollowUserInput

FollowUser 的自动生成的输入类型。

FollowUserInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

userId (ID!)

要关注的用户的 ID。

GistOrder

片段连接的排序选项。

GistOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (GistOrderField!)

要按其排序存储库的字段。

GrantEnterpriseOrganizationsMigratorRoleInput

GrantEnterpriseOrganizationsMigratorRole 的自动生成的输入类型。

GrantEnterpriseOrganizationsMigratorRoleInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

企业 ID,所有由其管理的组织都将被授予迁移者角色。

login (String!)

要授予迁移者角色的用户登录名。

GrantMigratorRoleInput

GrantMigratorRole 的自动生成的输入类型。

GrantMigratorRoleInput 的输入字段

名称描述

actor (String!)

要授予迁移者角色的用户登录名或团队别名。

actorType (ActorType!)

指定参与者的类型,可以是 USER 或 TEAM。

clientMutationId (String)

执行变异的客户端的唯一标识符。

organizationId (ID!)

用户/团队所属的组织的 ID。

ImportProjectInput

ImportProject 的自动生成的输入类型。

ImportProjectInput 的输入字段

名称描述

body (String)

项目的描述。

clientMutationId (String)

执行变异的客户端的唯一标识符。

columnImports ([ProjectColumnImport!]!)

包含问题和拉取请求的列列表。

name (String!)

项目的名称。

ownerName (String!)

要在其下创建项目的组织或用户的名称。

public (Boolean)

项目是否公开。

InviteEnterpriseAdminInput

InviteEnterpriseAdmin 的自动生成的输入类型。

InviteEnterpriseAdminInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

email (String)

要邀请为管理员的人员的电子邮件。

enterpriseId (ID!)

要邀请管理员的企业的 ID。

invitee (String)

要邀请为管理员的用户登录名。

role (EnterpriseAdministratorRole)

管理员的角色。

InviteEnterpriseMemberInput

InviteEnterpriseMember 的自动生成的输入类型。

InviteEnterpriseMemberInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

email (String)

要邀请为非关联成员的人员的电子邮件。

enterpriseId (ID!)

要邀请非关联成员的企业的 ID。

invitee (String)

要邀请为非关联成员的用户登录名。

IpAllowListEntryOrder

IP 允许列表条目连接的排序选项。

IpAllowListEntryOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (IpAllowListEntryOrderField!)

要按其排序 IP 允许列表条目的字段。

IssueCommentOrder

返回时可以对问题评论列表进行排序的方式。

IssueCommentOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段排序问题评论的方向。

field (IssueCommentOrderField!)

要按其排序问题评论的字段。

IssueFilters

筛选问题列表的方式。

IssueFilters 的输入字段

名称描述

assignee (String)

列出分配给给定名称的问题。对于未分配用户的 issue,传入 null,对于分配给任何用户的 issue,传入 *

createdBy (String)

列出由给定名称创建的问题。

labels ([String!])

列出 issue 上存在标签名称列表的问题。

mentioned (String)

列出在 issue 中提及给定名称的问题。

milestone (String)

按给定里程碑参数列出问题。如果传递了整数的字符串表示形式,则它应通过其数据库 ID 指向里程碑。对于没有里程碑的问题,传入 null,对于分配到任何里程碑的问题,传入 *

milestoneNumber (String)

按给定里程碑参数列出问题。如果传递了整数的字符串表示形式,则它应通过其数字字段指向里程碑。对于没有里程碑的问题,传入 null,对于分配到任何里程碑的问题,传入 *

since (DateTime)

列出在给定日期或之后更新的问题。

states ([IssueState!])

列出按给定状态列表过滤的问题。

viewerSubscribed (Boolean)

列出查看者订阅的问题。

IssueOrder

返回时可以对问题列表进行排序的方式。

IssueOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段排序问题的方向。

field (IssueOrderField!)

要按其排序问题的字段。

LabelOrder

返回时可以对标签列表进行排序的方式。

LabelOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段排序标签的方向。

field (LabelOrderField!)

要按其排序标签的字段。

LanguageOrder

语言连接的排序选项。

LanguageOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (LanguageOrderField!)

要按其排序语言的字段。

LinkProjectV2ToRepositoryInput

LinkProjectV2ToRepository 的自动生成输入类型。

LinkProjectV2ToRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要链接到存储库的项目的 ID。

repositoryId (ID!)

要链接到项目的存储库的 ID。

LinkProjectV2ToTeamInput

LinkProjectV2ToTeam 的自动生成输入类型。

LinkProjectV2ToTeamInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要链接到团队的项目的 ID。

teamId (ID!)

要链接到项目的团队的 ID。

LinkRepositoryToProjectInput

LinkRepositoryToProject 的自动生成输入类型。

LinkRepositoryToProjectInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要链接到存储库的项目的 ID。

repositoryId (ID!)

要链接到项目的存储库的 ID。

LockLockableInput

LockLockable 的自动生成输入类型。

LockLockableInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

lockReason (LockReason)

项目被锁定的原因。

lockableId (ID!)

要锁定的项目的 ID。

MannequinOrder

木偶排序选项。

MannequinOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (MannequinOrderField!)

按哪个字段排序木偶。

MarkDiscussionCommentAsAnswerInput

MarkDiscussionCommentAsAnswer 的自动生成输入类型。

MarkDiscussionCommentAsAnswerInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要标记为答案的讨论评论的节点 ID。

MarkFileAsViewedInput

MarkFileAsViewed 的自动生成输入类型。

MarkFileAsViewedInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

path (String!)

要标记为已查看的文件的路径。

pullRequestId (ID!)

拉取请求的节点 ID。

MarkNotificationAsDoneInput

MarkNotificationAsDone 的自动生成输入类型。

MarkNotificationAsDoneInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

通知线程 ID。

MarkProjectV2AsTemplateInput

MarkProjectV2AsTemplate 的自动生成输入类型。

MarkProjectV2AsTemplateInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要标记为模板的项目的 ID。

MarkPullRequestReadyForReviewInput

MarkPullRequestReadyForReview 的自动生成输入类型。

MarkPullRequestReadyForReviewInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestId (ID!)

要标记为已准备好审查的拉取请求的 ID。

MaxFilePathLengthParametersInput

防止将包含超过指定字符限制的文件路径的提交推送到提交图。

MaxFilePathLengthParametersInput 的输入字段

名称描述

maxFilePathLength (Int!)

文件路径中允许的最大字符数。

MaxFileSizeParametersInput

防止将超过指定文件大小限制的提交推送到提交。

MaxFileSizeParametersInput 的输入字段

名称描述

maxFileSize (Int!)

允许的最大文件大小(以兆字节为单位)。此限制不适用于 Git 大型文件存储 (Git LFS)。

MergeBranchInput

MergeBranch 的自动生成输入类型。

MergeBranchInput 的输入字段

名称描述

authorEmail (String)

与此提交关联的电子邮件地址。

base (String!)

提供的 head 将合并到的基础分支的名称。

clientMutationId (String)

执行变异的客户端的唯一标识符。

commitMessage (String)

用于合并提交的消息。如果省略,将使用默认值。

head (String!)

要合并到基础分支的 head。这可以是分支名称或提交 GitObjectID。

repositoryId (ID!)

包含将被修改的基础分支的存储库的节点 ID。

MergePullRequestInput

MergePullRequest 的自动生成输入类型。

MergePullRequestInput 的输入字段

名称描述

authorEmail (String)

与此合并关联的电子邮件地址。

clientMutationId (String)

执行变异的客户端的唯一标识符。

commitBody (String)

用于合并提交的提交正文;如果省略,将使用默认消息。

commitHeadline (String)

用于合并提交的提交标题;如果省略,将使用默认消息。

expectedHeadOid (GitObjectID)

拉取请求 head ref 必须匹配才能允许合并的 OID;如果省略,则不执行检查。

mergeMethod (PullRequestMergeMethod)

要使用的合并方法。如果省略,则默认为“MERGE”。

pullRequestId (ID!)

要合并的拉取请求的 ID。

MergeQueueParametersInput

合并必须通过合并队列执行。

MergeQueueParametersInput 的输入字段

名称描述

checkResponseTimeoutMinutes (Int!)

必需状态检查报告结论的最长时间。经过这么长时间后,尚未报告结论的检查将被假定为失败。

groupingStrategy (MergeQueueGroupingStrategy!)

设置为 ALLGREEN 时,合并队列为组中的每个 PR 创建的合并提交必须通过所有必需的检查才能合并。设置为 HEADGREEN 时,只有合并组头部的提交(即包含组中所有 PR 的更改的提交)必须通过其必需的检查才能合并。

maxEntriesToBuild (Int!)

限制同时请求检查和工作流运行的排队拉取请求的数量。

maxEntriesToMerge (Int!)

将在一个组中合并在一起的 PR 的最大数量。

mergeMethod (MergeQueueMergeMethod!)

从排队的拉取请求合并更改时要使用的方法。

minEntriesToMerge (Int!)

将在一个组中合并在一起的 PR 的最小数量。

minEntriesToMergeWaitMinutes (Int!)

在第一个 PR 添加到队列后,合并队列应等待多长时间才能满足最小组大小。经过这么长时间后,将忽略最小组大小,并将合并较小的组。

MilestoneOrder

里程碑连接的排序选项。

MilestoneOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (MilestoneOrderField!)

按哪个字段排序里程碑。

MinimizeCommentInput

MinimizeComment 的自动生成输入类型。

MinimizeCommentInput 的输入字段

名称描述

classifier (ReportedContentClassifiers!)

评论的分类。

clientMutationId (String)

执行变异的客户端的唯一标识符。

subjectId (ID!)

要修改的主题的节点 ID。

MoveProjectCardInput

MoveProjectCard 的自动生成输入类型。

MoveProjectCardInput 的输入字段

名称描述

afterCardId (ID)

将新卡片放在具有此 ID 的卡片之后。传递 null 以将其放在顶部。

cardId (ID!)

要移动的卡片的 ID。

clientMutationId (String)

执行变异的客户端的唯一标识符。

columnId (ID!)

要将其移动到的列的 ID。

MoveProjectColumnInput

MoveProjectColumn 的自动生成输入类型。

MoveProjectColumnInput 的输入字段

名称描述

afterColumnId (ID)

将新列放在具有此 ID 的列之后。传递 null 以将其放在最前面。

clientMutationId (String)

执行变异的客户端的唯一标识符。

columnId (ID!)

要移动的列的 ID。

OrgEnterpriseOwnerOrder

组织的企业所有者连接的排序选项。

OrgEnterpriseOwnerOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (OrgEnterpriseOwnerOrderField!)

按哪个字段排序企业所有者。

OrganizationOrder

组织连接的排序选项。

OrganizationOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (OrganizationOrderField!)

按哪个字段排序组织。

PackageFileOrder

返回时可以对软件包文件列表进行排序的方式。

PackageFileOrder 的输入字段

名称描述

direction (OrderDirection)

按指定字段对软件包文件排序的方向。

field (PackageFileOrderField)

按哪个字段对软件包文件排序。

PackageOrder

返回时可以对软件包列表进行排序的方式。

PackageOrder 的输入字段

名称描述

direction (OrderDirection)

按指定字段对软件包排序的方向。

field (PackageOrderField)

按哪个字段对软件包排序。

PackageVersionOrder

返回时可以对软件包版本列表进行排序的方式。

PackageVersionOrder 的输入字段

名称描述

direction (OrderDirection)

按指定字段对软件包版本排序的方向。

field (PackageVersionOrderField)

按哪个字段对软件包版本排序。

PinEnvironmentInput

PinEnvironment 的自动生成输入类型。

PinEnvironmentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

environmentId (ID!)

要修改的环境的 ID。

pinned (Boolean!)

环境的所需状态。如果为真,则环境将被固定。如果为假,则将取消固定。

PinIssueInput

PinIssue 的自动生成输入类型。

PinIssueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

issueId (ID!)

要固定的问题的 ID。

PinnedEnvironmentOrder

固定环境的排序选项。

PinnedEnvironmentOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段对固定环境排序的方向。

field (PinnedEnvironmentOrderField!)

按哪个字段排序固定环境。

ProjectCardImport

要用于项目卡片的问题或 PR 及其所属存储库。

ProjectCardImport 的输入字段

名称描述

number (Int!)

问题或拉取请求编号。

repository (String!)

包含所有者的仓库名称(owner/repository)。

ProjectColumnImport

一个项目列及其问题和PR列表。

ProjectColumnImport的输入字段

名称描述

columnName (String!)

列的名称。

issues ([ProjectCardImport!])

列中问题和拉取请求的列表。

position (Int!)

列的位置,从0开始。

ProjectOrder

返回时对项目列表进行排序的方式。

ProjectOrder的输入字段

名称描述

direction (OrderDirection!)

按指定字段对项目排序的方向。

field (ProjectOrderField!)

按其排序项目的字段。

ProjectV2Collaborator

要更新项目上的协作者。只能提供userId或teamId之一。

ProjectV2Collaborator的输入字段

名称描述

role (ProjectV2Roles!)

授予协作者的角色。

teamId (ID)

作为协作者的团队的ID。

userId (ID)

作为协作者的用户ID。

ProjectV2FieldOrder

项目v2字段连接的排序选项。

ProjectV2FieldOrder的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (ProjectV2FieldOrderField!)

按其排序项目v2字段的字段。

ProjectV2FieldValue

可用于更新项目内项目字段的值。一次只能更新一个值。

ProjectV2FieldValue的输入字段

名称描述

date (Date)

要在字段上设置的ISO 8601日期。

iterationId (String)

要在字段上设置的迭代的ID。

number (Float)

要在字段上设置的数字。

singleSelectOptionId (String)

要在字段上设置的单选选项的ID。

text (String)

要在字段上设置的文本。

ProjectV2Filters

过滤项目列表的方式。

ProjectV2Filters的输入字段

名称描述

state (ProjectV2State)

按给定状态过滤的项目v2列表。

ProjectV2ItemFieldValueOrder

项目v2项目字段值连接的排序选项。

ProjectV2ItemFieldValueOrder的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (ProjectV2ItemFieldValueOrderField!)

按其排序项目v2项目字段值的字段。

ProjectV2ItemOrder

项目v2项目连接的排序选项。

ProjectV2ItemOrder的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (ProjectV2ItemOrderField!)

按其排序项目v2项目的字段。

ProjectV2Order

返回时对项目列表进行排序的方式。

ProjectV2Order的输入字段

名称描述

direction (OrderDirection!)

按指定字段对项目排序的方向。

field (ProjectV2OrderField!)

按其排序项目的字段。

ProjectV2SingleSelectFieldOptionInput

表示一个单选字段选项。

ProjectV2SingleSelectFieldOptionInput的输入字段

名称描述

color (ProjectV2SingleSelectFieldOptionColor!)

选项的显示颜色。

description (String!)

选项的描述文本。

name (String!)

选项的名称。

ProjectV2StatusOrder

项目v2状态更新可以排序的方式。

ProjectV2StatusOrder的输入字段

名称描述

direction (OrderDirection!)

对节点排序的方向。

field (ProjectV2StatusUpdateOrderField!)

按其对节点排序的字段。

ProjectV2ViewOrder

项目v2视图连接的排序选项。

ProjectV2ViewOrder的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (ProjectV2ViewOrderField!)

按其排序项目v2视图的字段。

ProjectV2WorkflowOrder

项目v2工作流连接的排序选项。

ProjectV2WorkflowOrder的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (ProjectV2WorkflowsOrderField!)

按其排序项目v2工作流的字段。

PropertyTargetDefinitionInput

必须匹配的属性。

PropertyTargetDefinitionInput的输入字段

名称描述

name (String!)

属性的名称。

propertyValues ([String!]!)

要匹配的值。

source (String)

属性的来源。选择custom或'system'。如果未指定,则默认为'custom'。

PublishSponsorsTierInput

PublishSponsorsTier的自动生成的输入类型。

PublishSponsorsTierInput的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

tierId (ID!)

要发布的草稿层级的ID。

PullRequestOrder

返回时可以对问题列表进行排序的方式。

PullRequestOrder的输入字段

名称描述

direction (OrderDirection!)

按指定字段对拉取请求排序的方向。

field (PullRequestOrderField!)

按其排序拉取请求的字段。

PullRequestParametersInput

要求所有提交都必须在非目标分支中进行,并在合并之前通过拉取请求提交。

PullRequestParametersInput的输入字段

名称描述

dismissStaleReviewsOnPush (Boolean!)

推送的新、可审查的提交将取消先前的拉取请求审查批准。

requireCodeOwnerReview (Boolean!)

要求在修改具有指定代码所有者的文件的拉取请求中进行批准审查。

requireLastPushApproval (Boolean!)

最近一次可审查的推送是否必须由推送者以外的人员批准。

requiredApprovingReviewCount (Int!)

在拉取请求可以合并之前所需的批准审查次数。

requiredReviewThreadResolution (Boolean!)

在拉取请求可以合并之前,必须解决代码上的所有对话。

ReactionOrder

返回时对反应列表进行排序的方式。

ReactionOrder的输入字段

名称描述

direction (OrderDirection!)

按指定字段对反应排序的方向。

field (ReactionOrderField!)

按其排序反应的字段。

RefNameConditionTargetInput

要用于ref_name条件的参数。

RefNameConditionTargetInput的输入字段

名称描述

exclude ([String!]!)

要排除的ref名称或模式数组。如果这些模式中的任何一个匹配,则条件将不会通过。

include ([String!]!)

要包含的ref名称或模式数组。这些模式之一必须匹配才能使条件通过。还接受~DEFAULT_BRANCH以包含默认分支或~ALL以包含所有分支。

RefOrder

返回时对git ref列表进行排序的方式。

RefOrder的输入字段

名称描述

direction (OrderDirection!)

按指定字段对ref排序的方向。

field (RefOrderField!)

按其排序ref的字段。

RefUpdate

ref更新。

RefUpdate的输入字段

名称描述

afterOid (GitObjectID!)

此ref应更新到的值。

beforeOid (GitObjectID)

更新前此ref需要指向的值。

force (Boolean)

强制非快进更新。

name (GitRefname!)

要更新的 ref 的完全限定名称。例如 refs/heads/branch-name

RegenerateEnterpriseIdentityProviderRecoveryCodesInput

RegenerateEnterpriseIdentityProviderRecoveryCodes 的自动生成输入类型。

RegenerateEnterpriseIdentityProviderRecoveryCodesInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置身份提供程序的企业的 ID。

RegenerateVerifiableDomainTokenInput

RegenerateVerifiableDomainToken 的自动生成输入类型。

RegenerateVerifiableDomainTokenInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要重新生成验证令牌的可验证域的 ID。

RejectDeploymentsInput

RejectDeployments 的自动生成输入类型。

RejectDeploymentsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

comment (String)

拒绝部署的可选注释。

environmentIds ([ID!]!)

要拒绝部署的环境的 ID。

workflowRunId (ID!)

包含待处理部署的工作流运行的节点 ID。

ReleaseOrder

返回时可以对发布列表进行排序的方式。

ReleaseOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段对发布进行排序的方向。

field (ReleaseOrderField!)

按其排序发布的字段。

RemoveAssigneesFromAssignableInput

RemoveAssigneesFromAssignable 的自动生成输入类型。

RemoveAssigneesFromAssignableInput 的输入字段

名称描述

assignableId (ID!)

要从中删除指派人的可指派对象的 id。

assigneeIds ([ID!]!)

要删除为指派人的用户的 id。

clientMutationId (String)

执行变异的客户端的唯一标识符。

RemoveEnterpriseAdminInput

RemoveEnterpriseAdmin 的自动生成输入类型。

RemoveEnterpriseAdminInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要从中删除管理员的企业 ID。

login (String!)

要删除为管理员的用户登录名。

RemoveEnterpriseIdentityProviderInput

RemoveEnterpriseIdentityProvider 的自动生成输入类型。

RemoveEnterpriseIdentityProviderInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要从中删除身份提供程序的企业的 ID。

RemoveEnterpriseMemberInput

RemoveEnterpriseMember 的自动生成输入类型。

RemoveEnterpriseMemberInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

应从中删除用户的企业的 ID。

userId (ID!)

要从企业中删除的用户的 ID。

RemoveEnterpriseOrganizationInput

RemoveEnterpriseOrganization 的自动生成输入类型。

RemoveEnterpriseOrganizationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要从中删除组织的企业的 ID。

organizationId (ID!)

要从企业中删除的组织的 ID。

RemoveEnterpriseSupportEntitlementInput

RemoveEnterpriseSupportEntitlement 的自动生成输入类型。

RemoveEnterpriseSupportEntitlementInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

管理员所属的企业的 ID。

login (String!)

将失去支持资格的成员的登录名。

RemoveLabelsFromLabelableInput

RemoveLabelsFromLabelable 的自动生成输入类型。

RemoveLabelsFromLabelableInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

labelIds ([ID!]!)

要删除的标签的 id。

labelableId (ID!)

要从中删除标签的可标记对象的 id。

RemoveOutsideCollaboratorInput

RemoveOutsideCollaborator 的自动生成输入类型。

RemoveOutsideCollaboratorInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

organizationId (ID!)

要从中删除外部协作者的组织的 ID。

userId (ID!)

要删除的外部协作者的 ID。

RemoveReactionInput

RemoveReaction 的自动生成输入类型。

RemoveReactionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

content (ReactionContent!)

要删除的表情符号反应的名称。

subjectId (ID!)

要修改的主题的节点 ID。

RemoveStarInput

RemoveStar 的自动生成输入类型。

RemoveStarInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

starrableId (ID!)

要取消星标的 Starrable ID。

RemoveUpvoteInput

RemoveUpvote 的自动生成输入类型。

RemoveUpvoteInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

subjectId (ID!)

要删除赞成的讨论或评论的节点 ID。

ReopenDiscussionInput

ReopenDiscussion 的自动生成输入类型。

ReopenDiscussionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

discussionId (ID!)

要重新打开的讨论的 ID。

ReopenIssueInput

ReopenIssue 的自动生成输入类型。

ReopenIssueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

issueId (ID!)

要打开的问题的 ID。

ReopenPullRequestInput

ReopenPullRequest 的自动生成输入类型。

ReopenPullRequestInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestId (ID!)

要重新打开的拉取请求的 ID。

ReorderEnvironmentInput

ReorderEnvironment 的自动生成输入类型。

ReorderEnvironmentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

environmentId (ID!)

要修改的环境的 ID。

position (Int!)

环境的所需位置。

RepositoryIdConditionTargetInput

要用于 repository_id 条件的参数。

RepositoryIdConditionTargetInput 的输入字段

名称描述

repositoryIds ([ID!]!)

这些仓库 ID 之一必须与仓库匹配。

RepositoryInvitationOrder

仓库邀请连接的排序选项。

RepositoryInvitationOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (RepositoryInvitationOrderField!)

要按其排序仓库邀请的字段。

RepositoryMigrationOrder

仓库迁移的排序选项。

RepositoryMigrationOrder 的输入字段

名称描述

direction (RepositoryMigrationOrderDirection!)

排序方向。

field (RepositoryMigrationOrderField!)

要按其排序仓库迁移的字段。

RepositoryNameConditionTargetInput

要用于 repository_name 条件的参数。

RepositoryNameConditionTargetInput 的输入字段

名称描述

exclude ([String!]!)

要排除的仓库名称或模式的数组。如果这些模式中的任何一个匹配,则条件将不会通过。

include ([String!]!)

要包含的仓库名称或模式的数组。这些模式之一必须匹配才能使条件通过。还接受 ~ALL 以包含所有仓库。

protected (Boolean)

除了具有绕过权限的用户外,将阻止与这些模式匹配的目标更改。

RepositoryOrder

仓库连接的排序选项。

RepositoryOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (RepositoryOrderField!)

要按其排序存储库的字段。

RepositoryPropertyConditionTargetInput

要用于 repository_property 条件的参数。

RepositoryPropertyConditionTargetInput 的输入字段

名称描述

exclude ([PropertyTargetDefinitionInput!]!)

必须不匹配的仓库属性数组。

include ([PropertyTargetDefinitionInput!]!)

必须匹配的仓库属性数组。

RepositoryRuleConditionsInput

指定规则集评估所需的条件。

RepositoryRuleConditionsInput 的输入字段

名称描述

refName (RefNameConditionTargetInput)

ref_name 条件的配置。

repositoryId (RepositoryIdConditionTargetInput)

repository_id 条件的配置。

repositoryName (RepositoryNameConditionTargetInput)

repository_name 条件的配置。

repositoryProperty (RepositoryPropertyConditionTargetInput)

repository_property 条件的配置。

RepositoryRuleInput

指定新规则或更新规则的属性。

RepositoryRuleInput 的输入字段

名称描述

id (ID)

更新时此规则的可选 ID。

parameters (RuleParametersInput)

规则的参数。

type (RepositoryRuleType!)

要创建的规则类型。

RepositoryRuleOrder

仓库规则的排序选项。

RepositoryRuleOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (RepositoryRuleOrderField!)

要按其排序仓库规则的字段。

RepositoryRulesetBypassActorInput

指定新规则集绕过参与者或更新规则集绕过参与者的属性。仅应指定 actor_idrepository_role_database_idorganization_admindeploy_key 中的一个。

RepositoryRulesetBypassActorInput 的输入字段

名称描述

actorId (ID)

对于团队和集成绕过,团队或集成 ID。

bypassMode (RepositoryRulesetBypassActorBypassMode!)

此参与者的绕过模式。

deployKey (Boolean)

对于部署密钥绕过,为 true。只能使用 ALWAYS 作为绕过模式。

enterpriseOwner (Boolean)

对于企业所有者绕过,为 true。

organizationAdmin (Boolean)

对于组织所有者绕过,为 true。

repositoryRoleDatabaseId (Int)

对于角色绕过,角色数据库 ID。

RequestReviewsInput

RequestReviews 的自动生成输入类型。

RequestReviewsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestId (ID!)

要修改的拉取请求的节点 ID。

teamIds ([ID!])

要请求的团队的节点 ID。

union (Boolean)

将用户添加到集合中,而不是替换。

userIds ([ID!])

要请求的用户节点 ID。

RequiredDeploymentsParametersInput

选择在将 ref 推送到与该规则匹配的 ref 之前必须成功部署到的环境。

RequiredDeploymentsParametersInput 的输入字段

名称描述

requiredDeploymentEnvironments ([String!]!)

在合并分支之前必须成功部署到的环境。

RequiredStatusCheckInput

指定新的或更新的必需状态检查的属性。

RequiredStatusCheckInput 的输入字段

名称描述

appId (ID)

必须设置状态才能被接受的 App 的 ID。省略此值以使用最近设置此状态的任何 App,或使用“any”允许任何 App 设置状态。

context (String!)

必须通过才能将提交接受到匹配分支的状态检查上下文。

RequiredStatusChecksParametersInput

选择在更新 ref 之前必须通过哪些状态检查。启用后,必须首先将提交推送到另一个检查通过的 ref。

RequiredStatusChecksParametersInput 的输入字段

名称描述

doNotEnforceOnCreate (Boolean)

如果检查会阻止创建,则允许创建存储库和分支。

requiredStatusChecks ([StatusCheckConfigurationInput!]!)

必需的状态检查。

strictRequiredStatusChecksPolicy (Boolean!)

是否必须使用最新代码测试针对匹配分支的拉取请求。除非至少启用了其中一项状态检查,否则此设置不会生效。

RerequestCheckSuiteInput

RerequestCheckSuite 的自动生成的输入类型。

RerequestCheckSuiteInput 的输入字段

名称描述

checkSuiteId (ID!)

检查套件的节点 ID。

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryId (ID!)

存储库的节点 ID。

ResolveReviewThreadInput

ResolveReviewThread 的自动生成的输入类型。

ResolveReviewThreadInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

threadId (ID!)

要解决的线程的 ID。

RetireSponsorsTierInput

RetireSponsorsTier 的自动生成的输入类型。

RetireSponsorsTierInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

tierId (ID!)

要停用的已发布层级的 ID。

RevertPullRequestInput

RevertPullRequest 的自动生成的输入类型。

RevertPullRequestInput 的输入字段

名称描述

body (String)

回退拉取请求的描述。

clientMutationId (String)

执行变异的客户端的唯一标识符。

draft (Boolean)

指示回退拉取请求是否应为草稿。

pullRequestId (ID!)

要回退的拉取请求的 ID。

title (String)

回退拉取请求的标题。

RevokeEnterpriseOrganizationsMigratorRoleInput

RevokeEnterpriseOrganizationsMigratorRole 的自动生成的输入类型。

RevokeEnterpriseOrganizationsMigratorRoleInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

企业 ID,所有由其管理的组织都将被授予迁移者角色。

login (String!)

要撤销迁移器角色的用户登录名。

RevokeMigratorRoleInput

RevokeMigratorRole 的自动生成的输入类型。

RevokeMigratorRoleInput 的输入字段

名称描述

actor (String!)

要撤销迁移器角色的用户登录名或团队别名。

actorType (ActorType!)

指定参与者的类型,可以是 USER 或 TEAM。

clientMutationId (String)

执行变异的客户端的唯一标识符。

organizationId (ID!)

用户/团队所属的组织的 ID。

RuleParametersInput

指定 RepositoryRule 对象的参数。应仅指定一个字段。

RuleParametersInput 的输入字段

名称描述

branchNamePattern (BranchNamePatternParametersInput)

用于 branch_name_pattern 规则类型的参数。

codeScanning (CodeScanningParametersInput)

用于 code_scanning 规则类型的参数。

commitAuthorEmailPattern (CommitAuthorEmailPatternParametersInput)

用于 commit_author_email_pattern 规则类型的参数。

commitMessagePattern (CommitMessagePatternParametersInput)

用于 commit_message_pattern 规则类型的参数。

committerEmailPattern (CommitterEmailPatternParametersInput)

用于 committer_email_pattern 规则类型的参数。

fileExtensionRestriction (FileExtensionRestrictionParametersInput)

用于 file_extension_restriction 规则类型的参数。

filePathRestriction (FilePathRestrictionParametersInput)

用于 file_path_restriction 规则类型的参数。

maxFilePathLength (MaxFilePathLengthParametersInput)

用于 max_file_path_length 规则类型的参数。

maxFileSize (MaxFileSizeParametersInput)

用于 max_file_size 规则类型的参数。

mergeQueue (MergeQueueParametersInput)

用于 merge_queue 规则类型的参数。

pullRequest (PullRequestParametersInput)

用于 pull_request 规则类型的参数。

requiredDeployments (RequiredDeploymentsParametersInput)

用于 required_deployments 规则类型的参数。

requiredStatusChecks (RequiredStatusChecksParametersInput)

用于 required_status_checks 规则类型的参数。

tagNamePattern (TagNamePatternParametersInput)

用于 tag_name_pattern 规则类型的参数。

update (UpdateParametersInput)

用于 update 规则类型的参数。

workflows (WorkflowsParametersInput)

用于 workflows 规则类型的参数。

SavedReplyOrder

保存的回复连接的排序选项。

SavedReplyOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SavedReplyOrderField!)

要按其排序保存的回复的字段。

SecurityAdvisoryIdentifierFilter

用于过滤结果的咨询标识符。

SecurityAdvisoryIdentifierFilter 的输入字段

名称描述

type (SecurityAdvisoryIdentifierType!)

标识符类型。

value (String!)

标识符字符串。支持精确或部分匹配。

SecurityAdvisoryOrder

安全咨询连接的排序选项。

SecurityAdvisoryOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SecurityAdvisoryOrderField!)

要按其排序安全咨询的字段。

SecurityVulnerabilityOrder

安全漏洞连接的排序选项。

SecurityVulnerabilityOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SecurityVulnerabilityOrderField!)

要按其排序安全漏洞的字段。

SetEnterpriseIdentityProviderInput

SetEnterpriseIdentityProvider 的自动生成的输入类型。

SetEnterpriseIdentityProviderInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

digestMethod (SamlDigestAlgorithm!)

用于为标识提供程序签名 SAML 请求的摘要算法。

enterpriseId (ID!)

要设置身份提供程序的企业的 ID。

idpCertificate (String!)

标识提供程序用于签名断言和响应的 x509 证书。

issuer (String)

SAML 标识提供程序的发行者实体 ID。

signatureMethod (SamlSignatureAlgorithm!)

用于为标识提供程序签名 SAML 请求的签名算法。

ssoUrl (URI!)

标识提供程序的 SAML SSO 的 URL 端点。

SetOrganizationInteractionLimitInput

SetOrganizationInteractionLimit 的自动生成的输入类型。

SetOrganizationInteractionLimitInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

expiry (RepositoryInteractionLimitExpiry)

此限制应何时过期。

limit (RepositoryInteractionLimit!)

要设置的限制。

organizationId (ID!)

要为其设置限制的组织的 ID。

SetRepositoryInteractionLimitInput

SetRepositoryInteractionLimit 的自动生成的输入类型。

SetRepositoryInteractionLimitInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

expiry (RepositoryInteractionLimitExpiry)

此限制应何时过期。

limit (RepositoryInteractionLimit!)

要设置的限制。

repositoryId (ID!)

要为其设置限制的存储库的 ID。

SetUserInteractionLimitInput

SetUserInteractionLimit 的自动生成的输入类型。

SetUserInteractionLimitInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

expiry (RepositoryInteractionLimitExpiry)

此限制应何时过期。

limit (RepositoryInteractionLimit!)

要设置的限制。

userId (ID!)

要为其设置限制的用户 ID。

SponsorAndLifetimeValueOrder

用于获取赞助商实体和关联的 GitHub Sponsors 的美元金额的连接的排序选项。

SponsorAndLifetimeValueOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorAndLifetimeValueOrderField!)

要按其排序结果的字段。

SponsorOrder

用于获取 GitHub Sponsors 的赞助商实体的连接的排序选项。

SponsorOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorOrderField!)

用于对赞助者实体进行排序的字段。

SponsorableOrder

用于获取 GitHub Sponsors 可赞助实体连接的排序选项。

SponsorableOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorableOrderField!)

用于对可赞助实体进行排序的字段。

SponsorsActivityOrder

GitHub Sponsors 活动连接的排序选项。

SponsorsActivityOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorsActivityOrderField!)

用于对活动进行排序的字段。

SponsorsTierOrder

Sponsors 级别连接的排序选项。

SponsorsTierOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorsTierOrderField!)

用于对级别进行排序的字段。

SponsorshipNewsletterOrder

赞助简报连接的排序选项。

SponsorshipNewsletterOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorshipNewsletterOrderField!)

用于对赞助简报进行排序的字段。

SponsorshipOrder

赞助连接的排序选项。

SponsorshipOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorshipOrderField!)

用于对赞助进行排序的字段。

StarOrder

星标连接的排序方式。

StarOrder 的输入字段

名称描述

direction (OrderDirection!)

对节点排序的方向。

field (StarOrderField!)

用于对节点进行排序的字段。

StartOrganizationMigrationInput

StartOrganizationMigration 的自动生成的输入类型。

StartOrganizationMigrationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

sourceAccessToken (String!)

迁移源访问令牌。

sourceOrgUrl (URI!)

要迁移的组织的 URL。

targetEnterpriseId (ID!)

目标组织所属企业的 ID。

targetOrgName (String!)

目标组织的名称。

StartRepositoryMigrationInput

StartRepositoryMigration 的自动生成的输入类型。

StartRepositoryMigrationInput 的输入字段

名称描述

accessToken (String)

迁移源访问令牌。

clientMutationId (String)

执行变异的客户端的唯一标识符。

continueOnError (Boolean)

是否在发生错误时继续迁移。默认为 true

gitArchiveUrl (String)

访问用户上传的 Git 归档文件的签名 URL。

githubPat (String)

导入到目标存储库的用户 GitHub 个人访问令牌。

lockSource (Boolean)

是否锁定源存储库。

metadataArchiveUrl (String)

访问用户上传的元数据归档文件的签名 URL。

ownerId (ID!)

将拥有导入存储库的组织的 ID。

repositoryName (String!)

导入存储库的名称。

skipReleases (Boolean)

是否跳过迁移存储库的发布。

sourceId (ID!)

迁移源的 ID。

sourceRepositoryUrl (URI!)

源存储库的 URL。

targetRepoVisibility (String)

导入存储库的可见性。

StatusCheckConfigurationInput

必需的状态检查。

StatusCheckConfigurationInput 的输入字段

名称描述

context (String!)

提交中必须存在的状态检查上下文名称。

integrationId (Int)

此状态检查必须源自的可选集成 ID。

SubmitPullRequestReviewInput

SubmitPullRequestReview 的自动生成的输入类型。

SubmitPullRequestReviewInput 的输入字段

名称描述

body (String)

要在拉取请求审查中设置的文本字段。

clientMutationId (String)

执行变异的客户端的唯一标识符。

event (PullRequestReviewEvent!)

要发送到拉取请求审查的事件。

pullRequestId (ID)

要提交任何挂起的审查的拉取请求 ID。

pullRequestReviewId (ID)

要提交的拉取请求审查 ID。

TagNamePatternParametersInput

要用于 tag_name_pattern 规则的参数。

TagNamePatternParametersInput 的输入字段

名称描述

name (String)

此规则将如何显示给用户。

negate (Boolean)

如果为 true,则如果模式匹配,规则将失败。

operator (String!)

要用于匹配的操作符。

pattern (String!)

要匹配的模式。

TeamDiscussionCommentOrder

团队讨论评论连接的排序方式。

TeamDiscussionCommentOrder 的输入字段

名称描述

direction (OrderDirection!)

对节点排序的方向。

field (TeamDiscussionCommentOrderField!)

按其对节点排序的字段。

TeamDiscussionOrder

团队讨论连接的排序方式。

TeamDiscussionOrder 的输入字段

名称描述

direction (OrderDirection!)

对节点排序的方向。

field (TeamDiscussionOrderField!)

按其对节点排序的字段。

TeamMemberOrder

团队成员连接的排序选项。

TeamMemberOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (TeamMemberOrderField!)

用于对团队成员进行排序的字段。

TeamOrder

团队连接的排序方式。

TeamOrder 的输入字段

名称描述

direction (OrderDirection!)

对节点排序的方向。

field (TeamOrderField!)

用于对节点进行排序的字段。

TeamRepositoryOrder

团队存储库连接的排序选项。

TeamRepositoryOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (TeamRepositoryOrderField!)

要按其排序存储库的字段。

TransferEnterpriseOrganizationInput

TransferEnterpriseOrganization 的自动生成的输入类型。

TransferEnterpriseOrganizationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

destinationEnterpriseId (ID!)

应将组织转移到的企业的 ID。

organizationId (ID!)

要转移的组织的 ID。

TransferIssueInput

TransferIssue 的自动生成的输入类型。

TransferIssueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

createLabelsIfMissing (Boolean)

如果标签在目标存储库中不存在(按名称匹配),是否创建标签。

issueId (ID!)

要转移的问题的节点 ID。

repositoryId (ID!)

应将问题转移到的存储库的节点 ID。

UnarchiveProjectV2ItemInput

UnarchiveProjectV2Item 的自动生成的输入类型。

UnarchiveProjectV2ItemInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

itemId (ID!)

要取消归档的 ProjectV2Item 的 ID。

projectId (ID!)

要从中存档项目的项目的 ID。

UnarchiveRepositoryInput

UnarchiveRepository 的自动生成的输入类型。

UnarchiveRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryId (ID!)

要取消归档的存储库的 ID。

UnfollowOrganizationInput

UnfollowOrganization 的自动生成的输入类型。

UnfollowOrganizationInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

organizationId (ID!)

要取消关注的组织的 ID。

UnfollowUserInput

UnfollowUser 的自动生成的输入类型。

UnfollowUserInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

userId (ID!)

要取消关注的用户 ID。

UnlinkProjectV2FromRepositoryInput

UnlinkProjectV2FromRepository 的自动生成的输入类型。

UnlinkProjectV2FromRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要从存储库中取消链接的项目的 ID。

repositoryId (ID!)

要从项目中取消链接的存储库的 ID。

UnlinkProjectV2FromTeamInput

UnlinkProjectV2FromTeam 的自动生成的输入类型。

UnlinkProjectV2FromTeamInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要从团队中取消链接的项目的 ID。

teamId (ID!)

要从项目中取消链接的团队的 ID。

UnlinkRepositoryFromProjectInput

UnlinkRepositoryFromProject 的自动生成的输入类型。

UnlinkRepositoryFromProjectInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

与存储库链接的项目的 ID。

repositoryId (ID!)

与项目链接的存储库的 ID。

UnlockLockableInput

UnlockLockable 的自动生成的输入类型。

UnlockLockableInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

lockableId (ID!)

要解锁的项目的 ID。

UnmarkDiscussionCommentAsAnswerInput

UnmarkDiscussionCommentAsAnswer 的自动生成的输入类型。

UnmarkDiscussionCommentAsAnswerInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要取消标记为答案的讨论评论的节点 ID。

UnmarkFileAsViewedInput

UnmarkFileAsViewed 的自动生成的输入类型。

UnmarkFileAsViewedInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

path (String!)

要标记为未查看的文件的路径。

pullRequestId (ID!)

拉取请求的节点 ID。

UnmarkIssueAsDuplicateInput

UnmarkIssueAsDuplicate 的自动生成的输入类型。

UnmarkIssueAsDuplicateInput 的输入字段

名称描述

canonicalId (ID!)

当前被视为规范/权威/原始的问题或拉取请求的 ID。

clientMutationId (String)

执行变异的客户端的唯一标识符。

duplicateId (ID!)

当前标记为重复的问题或拉取请求的 ID。

UnmarkProjectV2AsTemplateInput

UnmarkProjectV2AsTemplate 的自动生成输入类型。

UnmarkProjectV2AsTemplateInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

projectId (ID!)

要取消标记为模板的项目的 ID。

UnminimizeCommentInput

UnminimizeComment 的自动生成输入类型。

UnminimizeCommentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

subjectId (ID!)

要修改的主题的节点 ID。

UnpinIssueInput

UnpinIssue 的自动生成输入类型。

UnpinIssueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

issueId (ID!)

要取消固定问题的 ID。

UnresolveReviewThreadInput

UnresolveReviewThread 的自动生成输入类型。

UnresolveReviewThreadInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

threadId (ID!)

要取消解决的线程的 ID。

UnsubscribeFromNotificationsInput

UnsubscribeFromNotifications 的自动生成输入类型。

UnsubscribeFromNotificationsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ids ([ID!]!)

要取消订阅的对象的 NotificationThread ID。

UpdateBranchProtectionRuleInput

UpdateBranchProtectionRule 的自动生成输入类型。

UpdateBranchProtectionRuleInput 的输入字段

名称描述

allowsDeletions (Boolean)

此分支是否可以删除。

allowsForcePushes (Boolean)

在此分支上是否允许强制推送。

blocksCreations (Boolean)

分支创建是否为受保护的操作。

branchProtectionRuleId (ID!)

要更新的分支保护规则的全局中继 ID。

bypassForcePushActorIds ([ID!])

允许绕过针对匹配分支的强制推送的用户、团队或应用 ID 列表。

bypassPullRequestActorIds ([ID!])

允许绕过针对匹配分支的拉取请求的用户、团队或应用 ID 列表。

clientMutationId (String)

执行变异的客户端的唯一标识符。

dismissesStaleReviews (Boolean)

推送到匹配分支的新提交是否会取消拉取请求审查批准。

isAdminEnforced (Boolean)

管理员是否可以覆盖分支保护。

lockAllowsFetchAndMerge (Boolean)

当分支被锁定时,用户是否可以从上游拉取更改。设置为 true 以允许 fork 同步。设置为 false 以防止 fork 同步。

lockBranch (Boolean)

是否将分支设置为只读。如果为真,用户将无法推送到该分支。

pattern (String)

用于确定匹配分支的类似通配符的模式。

pushActorIds ([ID!])

允许推送到匹配分支的用户、团队或应用 ID 列表。

requireLastPushApproval (Boolean)

最近的推送是否必须由推送者以外的人员批准。

requiredApprovingReviewCount (Int)

更新匹配分支所需的批准审查次数。

requiredDeploymentEnvironments ([String!])

所需的部署环境列表。

requiredStatusCheckContexts ([String!])

必须通过才能将提交接受到匹配分支的状态检查上下文列表。

requiredStatusChecks ([RequiredStatusCheckInput!])

所需状态检查列表。

requiresApprovingReviews (Boolean)

更新匹配分支是否需要批准审查。

requiresCodeOwnerReviews (Boolean)

更新匹配分支是否需要代码所有者的审查。

requiresCommitSignatures (Boolean)

提交是否需要签名。

requiresConversationResolution (Boolean)

合并前是否需要解决对话。

requiresDeployments (Boolean)

合并前是否需要成功的部署。

requiresLinearHistory (Boolean)

是否禁止将合并提交推送到此分支。

requiresStatusChecks (Boolean)

更新匹配分支是否需要状态检查。

requiresStrictStatusChecks (Boolean)

合并前是否需要分支是最新的。

restrictsPushes (Boolean)

推送到匹配分支是否受限。

restrictsReviewDismissals (Boolean)

是否限制取消拉取请求审查。

reviewDismissalActorIds ([ID!])

允许在针对匹配分支的拉取请求上驳回代码审查的用户、团队或应用 ID 列表。

UpdateCheckRunInput

UpdateCheckRun 的自动生成输入类型。

UpdateCheckRunInput 的输入字段

名称描述

actions ([CheckRunAction!])

集成者可以执行的可能的进一步操作,用户可以触发这些操作。

checkRunId (ID!)

检查的节点。

clientMutationId (String)

执行变异的客户端的唯一标识符。

completedAt (DateTime)

检查运行完成的时间。

conclusion (CheckConclusionState)

检查的最终结论。

detailsUrl (URI)

集成者站点上的 URL,其中包含检查的完整详细信息。

externalId (String)

集成者系统上运行的参考。

name (String)

检查的名称。

output (CheckRunOutput)

关于运行的描述性详细信息。

repositoryId (ID!)

存储库的节点 ID。

startedAt (DateTime)

检查运行开始的时间。

status (RequestableCheckStatusState)

当前状态。

UpdateCheckSuitePreferencesInput

UpdateCheckSuitePreferences 的自动生成输入类型。

UpdateCheckSuitePreferencesInput 的输入字段

名称描述

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

要修改的检查套件首选项。

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryId (ID!)

存储库的节点 ID。

UpdateDiscussionCommentInput

UpdateDiscussionComment 的自动生成输入类型。

UpdateDiscussionCommentInput 的输入字段

名称描述

body (String!)

评论正文的新内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

commentId (ID!)

要更新的讨论评论的节点 ID。

UpdateDiscussionInput

UpdateDiscussion 的自动生成输入类型。

UpdateDiscussionInput 的输入字段

名称描述

body (String)

讨论正文的新内容。

categoryId (ID)

同一存储库中讨论类别的节点 ID,用于将此讨论更改为此类别。

clientMutationId (String)

执行变异的客户端的唯一标识符。

discussionId (ID!)

要更新的讨论的节点 ID。

title (String)

新的讨论标题。

UpdateEnterpriseAdministratorRoleInput

UpdateEnterpriseAdministratorRole 的自动生成输入类型。

UpdateEnterpriseAdministratorRoleInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

管理员所属的企业的 ID。

login (String!)

正在更改其角色的管理员的登录名。

role (EnterpriseAdministratorRole!)

企业管理员的新角色。

UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput

UpdateEnterpriseAllowPrivateRepositoryForkingSetting 的自动生成输入类型。

UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置允许私有存储库分叉设置的企业的 ID。

policyValue (EnterpriseAllowPrivateRepositoryForkingPolicyValue)

企业上允许私有存储库分叉策略的值。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上允许私有存储库分叉设置的值。

UpdateEnterpriseDefaultRepositoryPermissionSettingInput

UpdateEnterpriseDefaultRepositoryPermissionSetting 的自动生成输入类型。

UpdateEnterpriseDefaultRepositoryPermissionSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置基本存储库权限设置的企业的 ID。

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

企业上基本存储库权限设置的值。

UpdateEnterpriseDeployKeySettingInput

UpdateEnterpriseDeployKeySetting 的自动生成输入类型。

UpdateEnterpriseDeployKeySettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置部署密钥设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上部署密钥设置的值。

UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput

UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting 的自动生成输入类型。

UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以更改存储库可见性设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上成员可以更改存储库可见性设置的值。

UpdateEnterpriseMembersCanCreateRepositoriesSettingInput

UpdateEnterpriseMembersCanCreateRepositoriesSetting 的自动生成输入类型。

UpdateEnterpriseMembersCanCreateRepositoriesSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以创建存储库设置的企业的 ID。

membersCanCreateInternalRepositories (Boolean)

允许成员创建内部存储库。默认为当前值。

membersCanCreatePrivateRepositories (Boolean)

允许成员创建私有存储库。默认为当前值。

membersCanCreatePublicRepositories (Boolean)

允许成员创建公共存储库。默认为当前值。

membersCanCreateRepositoriesPolicyEnabled (Boolean)

如果为 false,则允许成员组织设置自己的存储库创建成员权限。

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

企业上成员可以创建存储库设置的值。必须提供此值或详细的公共/私有/内部允许字段(但不能同时提供两者)。

UpdateEnterpriseMembersCanDeleteIssuesSettingInput

UpdateEnterpriseMembersCanDeleteIssuesSetting 的自动生成输入类型。

UpdateEnterpriseMembersCanDeleteIssuesSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以删除问题设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上成员可以删除问题设置的值。

UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput

UpdateEnterpriseMembersCanDeleteRepositoriesSetting 的自动生成输入类型。

UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以删除存储库设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上成员可以删除存储库设置的值。

UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput

UpdateEnterpriseMembersCanInviteCollaboratorsSetting 的自动生成输入类型。

UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以邀请协作者设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上成员可以邀请协作者设置的值。

UpdateEnterpriseMembersCanMakePurchasesSettingInput

UpdateEnterpriseMembersCanMakePurchasesSetting 的自动生成输入类型。

UpdateEnterpriseMembersCanMakePurchasesSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以进行购买设置的企业的 ID。

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

企业上成员可以进行购买设置的值。

UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput

UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting 的自动生成输入类型。

UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以更新受保护分支设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上成员可以更新受保护分支设置的值。

UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput

UpdateEnterpriseMembersCanViewDependencyInsightsSetting 的自动生成输入类型。

UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置成员可以查看依赖项洞察设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上成员可以查看依赖项洞察设置的值。

UpdateEnterpriseOrganizationProjectsSettingInput

UpdateEnterpriseOrganizationProjectsSetting 的自动生成输入类型。

UpdateEnterpriseOrganizationProjectsSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置组织项目设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上组织项目设置的值。

UpdateEnterpriseOwnerOrganizationRoleInput

UpdateEnterpriseOwnerOrganizationRole 的自动生成输入类型。

UpdateEnterpriseOwnerOrganizationRoleInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

所有者所属的企业的 ID。

organizationId (ID!)

要更改其成员资格的组织的 ID。

organizationRole (RoleInOrganization!)

在组织中要承担的角色。

UpdateEnterpriseProfileInput

UpdateEnterpriseProfile 的自动生成的输入类型。

UpdateEnterpriseProfileInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String)

企业的描述。

enterpriseId (ID!)

要更新的企业 ID。

location (String)

企业的所在地。

name (String)

企业的名称。

websiteUrl (String)

企业网站的 URL。

UpdateEnterpriseRepositoryProjectsSettingInput

UpdateEnterpriseRepositoryProjectsSetting 的自动生成的输入类型。

UpdateEnterpriseRepositoryProjectsSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置存储库项目设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上存储库项目设置的值。

UpdateEnterpriseTeamDiscussionsSettingInput

UpdateEnterpriseTeamDiscussionsSetting 的自动生成的输入类型。

UpdateEnterpriseTeamDiscussionsSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置团队讨论设置的企业的 ID。

settingValue (EnterpriseEnabledDisabledSettingValue!)

企业上团队讨论设置的值。

UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput

UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting 的自动生成的输入类型。

UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置双因素身份验证禁用方法设置的企业的 ID。

settingValue (EnterpriseDisallowedMethodsSettingValue!)

企业上双因素身份验证禁用方法设置的值。

UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput

UpdateEnterpriseTwoFactorAuthenticationRequiredSetting 的自动生成的输入类型。

UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enterpriseId (ID!)

要设置双因素身份验证必需设置的企业的 ID。

settingValue (EnterpriseEnabledSettingValue!)

企业上双因素身份验证必需设置的值。

UpdateEnvironmentInput

UpdateEnvironment 的自动生成的输入类型。

UpdateEnvironmentInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

environmentId (ID!)

环境的节点 ID。

preventSelfReview (Boolean)

是否允许部署到此环境的用户批准他们创建的部署。

reviewers ([ID!])

可以批准部署到此环境的用户或团队的 ID。

waitTimer (Int)

等待时间(分钟)。

UpdateIpAllowListEnabledSettingInput

UpdateIpAllowListEnabledSetting 的自动生成的输入类型。

UpdateIpAllowListEnabledSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ownerId (ID!)

要设置 IP 允许列表启用设置的所有者的 ID。

settingValue (IpAllowListEnabledSettingValue!)

IP 允许列表启用设置的值。

UpdateIpAllowListEntryInput

UpdateIpAllowListEntry 的自动生成的输入类型。

UpdateIpAllowListEntryInput 的输入字段

名称描述

allowListValue (String!)

以 CIDR 表示法表示的 IP 地址或地址范围。

clientMutationId (String)

执行变异的客户端的唯一标识符。

ipAllowListEntryId (ID!)

要更新的 IP 允许列表条目的 ID。

isActive (Boolean!)

启用 IP 允许列表时,IP 允许列表条目是否处于活动状态。

name (String)

IP 允许列表条目的可选名称。

UpdateIpAllowListForInstalledAppsEnabledSettingInput

UpdateIpAllowListForInstalledAppsEnabledSetting 的自动生成的输入类型。

UpdateIpAllowListForInstalledAppsEnabledSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ownerId (ID!)

所有者的 ID。

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

已安装的 GitHub Apps 的 IP 允许列表配置的值。

UpdateIssueCommentInput

UpdateIssueComment 的自动生成的输入类型。

UpdateIssueCommentInput 的输入字段

名称描述

body (String!)

评论的更新文本。

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要修改的 IssueComment 的 ID。

UpdateIssueInput

UpdateIssue 的自动生成的输入类型。

UpdateIssueInput 的输入字段

名称描述

assigneeIds ([ID!])

此问题的用户节点 ID 数组。

body (String)

问题的描述主体。

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要修改的 Issue 的 ID。

labelIds ([ID!])

此问题标签的节点 ID 数组。

milestoneId (ID)

此问题的里程碑的节点 ID。

projectIds ([ID!])

与此问题关联的项目的节点 ID 数组。

state (IssueState)

所需的 Issue 状态。

title (String)

问题的标题。

UpdateLabelInput

UpdateLabel 的自动生成的输入类型。

UpdateLabelInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

color (String)

一个 6 个字符的十六进制代码,不带前导 #,标识标签的更新颜色。

description (String)

标签的简要描述,例如其用途。

id (ID!)

要更新的标签的节点 ID。

name (String)

标签的更新名称。

UpdateNotificationRestrictionSettingInput

UpdateNotificationRestrictionSetting 的自动生成的输入类型。

UpdateNotificationRestrictionSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

ownerId (ID!)

要设置限制通知设置的所有者的 ID。

settingValue (NotificationRestrictionSettingValue!)

限制通知设置的值。

UpdateOrganizationAllowPrivateRepositoryForkingSettingInput

UpdateOrganizationAllowPrivateRepositoryForkingSetting 的自动生成的输入类型。

UpdateOrganizationAllowPrivateRepositoryForkingSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

forkingEnabled (Boolean!)

是否启用在组织中分叉私有存储库?

organizationId (ID!)

要设置允许私有存储库分叉设置的组织的 ID。

UpdateOrganizationWebCommitSignoffSettingInput

UpdateOrganizationWebCommitSignoffSetting 的自动生成的输入类型。

UpdateOrganizationWebCommitSignoffSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

organizationId (ID!)

要设置 Web 提交签核设置的组织的 ID。

webCommitSignoffRequired (Boolean!)

是否启用对组织中存储库的基于 Web 的提交进行签核?

UpdateParametersInput

仅允许具有绕过权限的用户更新匹配的 ref。

UpdateParametersInput 的输入字段

名称描述

updateAllowsFetchAndMerge (Boolean!)

分支可以从其上游存储库拉取更改。

UpdatePatreonSponsorabilityInput

UpdatePatreonSponsorability 的自动生成的输入类型。

UpdatePatreonSponsorabilityInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

enablePatreonSponsorships (Boolean!)

是否应在 GitHub Sponsors 个人资料页面上显示 Patreon 等级,允许潜在赞助商通过 Patreon 而不是 GitHub 进行付款。

sponsorableLogin (String)

具有 GitHub Sponsors 个人资料的组织的用户名(如果有)。如果省略,则默认为经过身份验证的用户。的 GitHub Sponsors 个人资料。

UpdateProjectCardInput

UpdateProjectCard 的自动生成的输入类型。

UpdateProjectCardInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

isArchived (Boolean)

ProjectCard 是否应归档。

note (String)

ProjectCard 的注释。

projectCardId (ID!)

要更新的 ProjectCard ID。

UpdateProjectColumnInput

UpdateProjectColumn 的自动生成的输入类型。

UpdateProjectColumnInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String!)

项目列的名称。

projectColumnId (ID!)

要更新的 ProjectColumn ID。

UpdateProjectInput

UpdateProject 的自动生成的输入类型。

UpdateProjectInput 的输入字段

名称描述

body (String)

项目的描述。

clientMutationId (String)

执行变异的客户端的唯一标识符。

name (String)

项目的名称。

projectId (ID!)

要更新的项目 ID。

public (Boolean)

项目是否公开。

state (ProjectState)

项目是打开还是关闭。

UpdateProjectV2CollaboratorsInput

UpdateProjectV2Collaborators 的自动生成的输入类型。

UpdateProjectV2CollaboratorsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

collaborators ([ProjectV2Collaborator!]!)

要更新的协作者。

projectId (ID!)

要更新协作者的项目的 ID。

UpdateProjectV2DraftIssueInput

UpdateProjectV2DraftIssue 的自动生成的输入类型。

UpdateProjectV2DraftIssueInput 的输入字段

名称描述

assigneeIds ([ID!])

草稿问题的受让人 ID。

body (String)

草稿问题的正文。

clientMutationId (String)

执行变异的客户端的唯一标识符。

draftIssueId (ID!)

要更新的草稿问题的 ID。

title (String)

草稿问题的标题。

UpdateProjectV2Input

UpdateProjectV2 的自动生成的输入类型。

UpdateProjectV2Input 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

closed (Boolean)

将项目设置为关闭或打开。

projectId (ID!)

要更新的项目的 ID。

public (Boolean)

将项目设置为公开或私有。

readme (String)

设置项目的自述文件描述。

shortDescription (String)

设置项目的简短描述。

title (String)

设置项目的标题。

UpdateProjectV2ItemFieldValueInput

UpdateProjectV2ItemFieldValue 的自动生成的输入类型。

UpdateProjectV2ItemFieldValueInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

fieldId (ID!)

要更新的字段的 ID。

itemId (ID!)

要更新的项目的 ID。

projectId (ID!)

项目的 ID。

value (ProjectV2FieldValue!)

将在字段上设置的值。

UpdateProjectV2ItemPositionInput

UpdateProjectV2ItemPosition 的自动生成的输入类型。

UpdateProjectV2ItemPositionInput 的输入字段

名称描述

afterId (ID)

要将此项置于其后的项目的 ID。如果省略或设置为 null,则该项将移至顶部。

clientMutationId (String)

执行变异的客户端的唯一标识符。

itemId (ID!)

要移动的项目的 ID。

projectId (ID!)

项目的 ID。

UpdateProjectV2StatusUpdateInput

UpdateProjectV2StatusUpdate 的自动生成的输入类型。

UpdateProjectV2StatusUpdateInput 的输入字段

名称描述

body (String)

状态更新的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

startDate (Date)

状态更新的开始日期。

status (ProjectV2StatusUpdateStatus)

状态更新的状态。

statusUpdateId (ID!)

要更新的状态更新的 ID。

targetDate (Date)

状态更新的目标日期。

UpdatePullRequestBranchInput

UpdatePullRequestBranch 的自动生成的输入类型。

UpdatePullRequestBranchInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

expectedHeadOid (GitObjectID)

上游分支的头部 ref oid。

pullRequestId (ID!)

拉取请求的节点 ID。

updateMethod (PullRequestBranchUpdateMethod)

要使用的更新分支方法。如果省略,默认为“MERGE”。

UpdatePullRequestInput

UpdatePullRequest 的自动生成的输入类型。

UpdatePullRequestInput 的输入字段

名称描述

assigneeIds ([ID!])

此拉取请求的用户节点 ID 数组。

baseRefName (String)

您希望将更改拉取到的分支的名称。这应该是在当前存储库上的现有分支。

body (String)

拉取请求的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

labelIds ([ID!])

此拉取请求的标签节点 ID 数组。

maintainerCanModify (Boolean)

指示维护者是否可以修改拉取请求。

milestoneId (ID)

此拉取请求的里程碑的节点 ID。

projectIds ([ID!])

与此拉取请求关联的项目的节点 ID 数组。

pullRequestId (ID!)

拉取请求的节点 ID。

state (PullRequestUpdateState)

拉取请求的目标状态。

title (String)

拉取请求的标题。

UpdatePullRequestReviewCommentInput

UpdatePullRequestReviewComment 的自动生成的输入类型。

UpdatePullRequestReviewCommentInput 的输入字段

名称描述

body (String!)

注释的文本。

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestReviewCommentId (ID!)

要修改的注释的节点 ID。

UpdatePullRequestReviewInput

UpdatePullRequestReview 的自动生成的输入类型。

UpdatePullRequestReviewInput 的输入字段

名称描述

body (String!)

拉取请求审查正文的内容。

clientMutationId (String)

执行变异的客户端的唯一标识符。

pullRequestReviewId (ID!)

要修改的拉取请求审查的节点 ID。

UpdateRefInput

UpdateRef 的自动生成的输入类型。

UpdateRefInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

force (Boolean)

允许更新不是快进的分支 Ref 吗?

oid (GitObjectID!)

Ref 将更新为指向的 GitObjectID。

refId (ID!)

要更新的 Ref 的节点 ID。

UpdateRefsInput

UpdateRefs 的自动生成的输入类型。

UpdateRefsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

refUpdates ([RefUpdate!]!)

Ref 更新列表。

repositoryId (ID!)

存储库的节点 ID。

UpdateRepositoryInput

UpdateRepository 的自动生成的输入类型。

UpdateRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String)

存储库的新描述。传递空字符串以擦除现有描述。

hasDiscussionsEnabled (Boolean)

指示存储库是否应启用讨论功能。

hasIssuesEnabled (Boolean)

指示存储库是否应启用问题功能。

hasProjectsEnabled (Boolean)

指示存储库是否应启用项目看板功能。

hasSponsorshipsEnabled (Boolean)

指示存储库是否显示赞助按钮以获取财务捐款。

hasWikiEnabled (Boolean)

指示存储库是否应启用 Wiki 功能。

homepageUrl (URI)

有关此存储库的网页的 URL。传递空字符串以擦除现有 URL。

name (String)

存储库的新名称。

repositoryId (ID!)

要更新的存储库的 ID。

template (Boolean)

此存储库是否应标记为模板,以便任何可以访问它的人都可以使用相同的文件和目录结构创建新的存储库。

UpdateRepositoryRulesetInput

UpdateRepositoryRuleset 的自动生成的输入类型。

UpdateRepositoryRulesetInput 的输入字段

名称描述

bypassActors ([RepositoryRulesetBypassActorInput!])

允许绕过此规则集中的规则的参与者列表。

clientMutationId (String)

执行变异的客户端的唯一标识符。

conditions (RepositoryRuleConditionsInput)

此规则集的条件列表。

enforcement (RuleEnforcement)

此规则集的执行级别。

name (String)

规则集的名称。

repositoryRulesetId (ID!)

要更新的存储库规则集的全局中继 ID。

rules ([RepositoryRuleInput!])

此规则集的规则列表。

target (RepositoryRulesetTarget)

规则集的目标。

UpdateRepositoryWebCommitSignoffSettingInput

UpdateRepositoryWebCommitSignoffSetting 的自动生成的输入类型。

UpdateRepositoryWebCommitSignoffSettingInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryId (ID!)

要更新的存储库的 ID。

webCommitSignoffRequired (Boolean!)

指示存储库是否应要求在基于 Web 的提交上进行签核。

UpdateSponsorshipPreferencesInput

UpdateSponsorshipPreferences 的自动生成的输入类型。

UpdateSponsorshipPreferencesInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

privacyLevel (SponsorshipPrivacy)

指定其他人是否应该能够看到赞助商正在赞助可赞助者。公开可见性仍然不会显示使用了哪个层级。

receiveEmails (布尔值)

赞助者是否应接收来自被赞助者的电子邮件更新。

sponsorId (ID)

充当赞助商(支付赞助费用)的用户或组织的 ID。如果未提供 sponsorLogin,则此字段必填。

sponsorLogin (String)

充当赞助商(支付赞助费用)的用户或组织的用户名。如果未提供 sponsorId,则此字段必填。

sponsorableId (ID)

接收赞助的用户或组织的 ID。如果未给出 sponsorableLogin,则需要此项。

sponsorableLogin (String)

接收赞助的用户或组织的用户名。如果未给出 sponsorableId,则需要此项。

UpdateSubscriptionInput

UpdateSubscription 的自动生成的输入类型。

UpdateSubscriptionInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

state (SubscriptionState!)

订阅的新状态。

subscribableId (ID!)

要修改的可订阅对象的节点 ID。

UpdateTeamDiscussionCommentInput

UpdateTeamDiscussionComment 的自动生成的输入类型。

UpdateTeamDiscussionCommentInput 的输入字段

名称描述

body (String!)

评论的更新文本。

bodyVersion (String)

正文内容的当前版本。

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要修改的评论的 ID。

UpdateTeamDiscussionInput

UpdateTeamDiscussion 的自动生成的输入类型。

UpdateTeamDiscussionInput 的输入字段

名称描述

body (String)

讨论的更新文本。

bodyVersion (String)

正文内容的当前版本。如果提供,则如果给定的版本与服务器上的最新版本不匹配,则此更新操作将被拒绝。

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要修改的讨论的节点 ID。

pinned (Boolean)

如果提供,则设置更新讨论的固定状态。

title (String)

讨论的更新标题。

UpdateTeamReviewAssignmentInput

UpdateTeamReviewAssignment 的自动生成的输入类型。

UpdateTeamReviewAssignmentInput 的输入字段

名称描述

algorithm (TeamReviewAssignmentAlgorithm)

用于审查分配的算法。

clientMutationId (String)

执行变异的客户端的唯一标识符。

countMembersAlreadyRequested (Boolean)

将任何其审查请求已提出的成员计数计入分配审查所需的成员数量。

enabled (Boolean!)

开启或关闭审查分配。

excludedTeamMemberIds ([ID!])

要排除的团队成员 ID 数组。

id (ID!)

要更新审查分配的团队的节点 ID。

includeChildTeamMembers (Boolean)

在分配时包含任何子团队的成员。

notifyTeam (Boolean)

如果委托,则通知整个团队 PR。

removeTeamRequest (Boolean)

在分配时删除团队审查请求。

teamMemberCount (Int)

要分配的团队成员数量。

UpdateTeamsRepositoryInput

UpdateTeamsRepository 的自动生成的输入类型。

UpdateTeamsRepositoryInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

permission (RepositoryPermission!)

应授予团队的权限。

repositoryId (ID!)

授予访问权限的存储库 ID。

teamIds ([ID!]!)

正在授予访问权限的团队列表。限制:10。

UpdateTopicsInput

UpdateTopics 的自动生成的输入类型。

UpdateTopicsInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

repositoryId (ID!)

存储库的节点 ID。

topicNames ([String!]!)

主题名称数组。

UpdateUserListInput

UpdateUserList 的自动生成的输入类型。

UpdateUserListInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

description (String)

列表的描述。

isPrivate (布尔值)

列表是否为私有。

listId (ID!)

要更新的列表的 ID。

name (String)

列表的名称。

UpdateUserListsForItemInput

UpdateUserListsForItem 的自动生成的输入类型。

UpdateUserListsForItemInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

itemId (ID!)

要添加到列表中的项目。

listIds ([ID!]!)

此项目应属于的列表。

suggestedListIds ([ID!])

要创建并向其中添加此项目的建议列表。

UserStatusOrder

用户状态连接的排序选项。

UserStatusOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (UserStatusOrderField!)

要按其排序用户状态的字段。

VerifiableDomainOrder

可验证域连接的排序选项。

VerifiableDomainOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (VerifiableDomainOrderField!)

用于对可验证域进行排序的字段。

VerifyVerifiableDomainInput

VerifyVerifiableDomain 的自动生成的输入类型。

VerifyVerifiableDomainInput 的输入字段

名称描述

clientMutationId (String)

执行变异的客户端的唯一标识符。

id (ID!)

要验证的可验证域的 ID。

WorkflowFileReferenceInput

此规则要通过,必须运行的工作流。

WorkflowFileReferenceInput 的输入字段

名称描述

path (String!)

工作流文件的路径。

ref (String)

要使用的工作流文件的 ref(分支或标签)。

repositoryId (Int!)

定义工作流的存储库的 ID。

sha (String)

要使用的工作流文件的提交 SHA。

WorkflowRunOrder

返回时对工作流运行列表进行排序的方式。

WorkflowRunOrder 的输入字段

名称描述

direction (OrderDirection!)

根据指定字段对工作流运行进行排序的方向。

field (WorkflowRunOrderField!)

用于对工作流进行排序的字段。

WorkflowsParametersInput

要求对目标分支进行的所有更改都必须通过指定的工作流,然后才能合并。

WorkflowsParametersInput 的输入字段

名称描述

doNotEnforceOnCreate (Boolean)

如果检查会阻止创建,则允许创建存储库和分支。

workflows ([WorkflowFileReferenceInput!]!)

此规则要通过,必须通过的工作流。