跳至主要内容

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

本文内容

关于输入对象

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

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

有关更多信息,请参阅使用 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 将被移除。 原因: 不再支持建议的主题。

AccessUserNamespaceRepositoryInput

AccessUserNamespaceRepository 的自动生成输入类型。

AccessUserNamespaceRepositoryInput 的输入字段

名称描述

clientMutationId (String)

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

enterpriseId (ID!)

拥有该用户命名空间仓库的企业 ID。

repositoryId (ID!)

要访问的用户命名空间仓库的 ID。

AddAssigneesToAssignableInput

AddAssigneesToAssignable 的自动生成输入类型。

AddAssigneesToAssignableInput 的输入字段

名称描述

agentAssignment (AgentAssignmentInput)

为此议题指派 Copilot 的配置。

assignableId (ID!)

要添加负责人的可指派对象的 ID。

assigneeIds ([ID!]!)

要作为负责人添加的参与者(用户或机器人)的 ID。

clientMutationId (String)

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

AddBlockedByInput

AddBlockedBy 的自动生成输入类型。

AddBlockedByInput 的输入字段

名称描述

blockingIssueId (ID!)

阻塞给定议题的议题 ID。

clientMutationId (String)

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

issueId (ID!)

要被阻塞的议题的 ID。

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

要添加的议题或拉取请求的 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 参数 原因: 我们正在弃用使用差异相对位置的评论字段。

commitOID (GitObjectID)

评审涉及的提交 OID。

event (PullRequestReviewEvent)

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

pullRequestId (ID!)

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

threads ([DraftPullRequestReviewThread])

评审行内评论对话 (threads)。

AddPullRequestReviewThreadInput

AddPullRequestReviewThread 的自动生成输入类型。

AddPullRequestReviewThreadInput 的输入字段

名称描述

body (String!)

对话中第一条评论的正文。

clientMutationId (String)

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

line (Int)

对话引用的 blob 行,行级对话必填。多行评论的结束行范围。

path (String)

被评论文件的路径。

pullRequestId (ID)

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

pullRequestReviewId (ID)

要修改的评审的节点 ID。

side (DiffSide)

该行所在的差异面。对于多行评论,这是结束行范围所在的面。

startLine (Int)

评论引用范围的第一行。

startSide (DiffSide)

起始行所在的差异面。

subjectType (PullRequestReviewThreadSubjectType)

对应对话中评论所针对的级别,可以是差异行或文件。

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

要星标的可星标对象 ID。

AddSubIssueInput

AddSubIssue 的自动生成输入类型。

AddSubIssueInput 的输入字段

名称描述

clientMutationId (String)

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

issueId (ID!)

议题的 ID。

replaceParent (Boolean)

如果已存在父级议题,则替换父级议题的选项。

subIssueId (ID)

子议题的 ID。

subIssueUrl (String)

子议题的 URL。

AddUpvoteInput

AddUpvote 的自动生成输入类型。

AddUpvoteInput 的输入字段

名称描述

clientMutationId (String)

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

subjectId (ID!)

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

AddVerifiableDomainInput

AddVerifiableDomain 的自动生成输入类型。

AddVerifiableDomainInput 的输入字段

名称描述

clientMutationId (String)

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

domain (URI!)

域名的 URL。

ownerId (ID!)

要将域名添加到的所有者的 ID。

AgentAssignmentInput

表示为议题指派 Copilot 的配置(公开变体)。

AgentAssignmentInput 的输入字段

名称描述

baseRef (String)

仓库的基准引用/分支。如果未提供,则默认为默认分支。

customAgent (String)

Copilot 的自定义代理。

customInstructions (String)

Copilot 的自定义指令。

targetRepositoryId (ID)

Copilot 应工作的目标仓库节点 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!)

是否克隆源项目的工作流。

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)

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

duplicateIssueId (ID)

该议题重复项所属议题的 ID。

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。如果非空,则仅返回此用户编写的提交。此字段优先于 emails。

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 来指定。

示例

使用全局节点 ID 指定分支

{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }

使用 repositoryNameWithOwnerbranchName 指定分支

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

CommittableBranch 的输入字段

名称描述

branchName (String)

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

id (ID)

要更新的引用的节点 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。

CopilotCodeReviewParametersInput

如果作者有权访问 Copilot 代码评审且其高级请求配额尚未达到限制,则自动为新的拉取请求请求 Copilot 代码评审。

CopilotCodeReviewParametersInput 的输入字段

名称描述

reviewDraftPullRequests (Boolean)

Copilot 在草稿拉取请求被标记为准备好评审之前对其进行自动评审。

reviewOnPush (Boolean)

Copilot 自动评审推送到拉取请求的每次新更改。

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

允许绕过强制推送并以匹配分支为目标的 User、Team 或 App ID 列表。

bypassPullRequestActorIds ([ID!])

允许绕过拉取请求并以匹配分支为目标的 User、Team 或 App ID 列表。

clientMutationId (String)

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

dismissesStaleReviews (Boolean)

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

isAdminEnforced (Boolean)

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

lockAllowsFetchAndMerge (Boolean)

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

lockBranch (Boolean)

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

pattern (String!)

用于确定匹配分支的类 glob 模式。

pushActorIds ([ID!])

允许推送到匹配分支的 User、Team 或 App ID 列表。

repositoryId (ID!)

应在其中创建新分支保护规则的存储库的全局 relay 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!])

允许在以匹配分支为目标的拉取请求上驳回审核的 User、Team 或 App 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。

CreateIssueFieldInput

CreateIssueField 的自动生成输入类型。

CreateIssueFieldInput 的输入字段

名称描述

clientMutationId (String)

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

dataType (IssueFieldDataType!)

议题字段的数据类型。

description (String)

议题字段的描述。

name (String!)

议题字段的名称。

options ([IssueFieldSingleSelectOptionInput!])

议题字段的选项(如果适用)。

ownerId (ID!)

将创建议题字段的组织的 ID。

visibility (IssueFieldVisibility)

议题字段的可见性。

CreateIssueFieldValueInput

CreateIssueFieldValue 的自动生成输入类型。

CreateIssueFieldValueInput 的输入字段

名称描述

clientMutationId (String)

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

issueField (IssueFieldCreateOrUpdateInput!)

要创建的字段值。

issueId (ID!)

议题的 ID。

CreateIssueInput

CreateIssue 的自动生成输入类型。

CreateIssueInput 的输入字段

名称描述

agentAssignment (AgentAssignmentInput)

为此议题指派 Copilot 的配置。

assigneeIds ([ID!])

此议题负责人的节点 ID。

body (String)

议题说明的正文。

clientMutationId (String)

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

issueFields ([IssueFieldCreateOrUpdateInput!])

创建期间要在议题上设置的议题字段数组。

issueTemplate (String)

存储库中议题模板的名称,将模板中的标签和负责人分配给该议题。

issueTypeId (ID)

此议题类型的节点 ID。

labelIds ([ID!])

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

milestoneId (ID)

此议题里程碑的节点 ID。

parentIssueId (ID)

要将此新议题添加到的父议题的节点 ID。

projectIds ([ID!])

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

projectV2Ids ([ID!])

与此议题关联的 Projects V2 节点 ID 数组。

repositoryId (ID!)

仓库的节点 ID。

title (String!)

议题的标题。

CreateIssueTypeInput

CreateIssueType 的自动生成输入类型。

CreateIssueTypeInput 的输入字段

名称描述

clientMutationId (String)

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

color (IssueTypeColor)

议题类型的颜色。

description (String)

新议题类型的描述。

isEnabled (Boolean!)

是否在组织级别启用议题类型。

name (String!)

新议题类型的名称。

ownerId (ID!)

创建议题类型的组织的 ID。

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

字段的数据类型。

iterationConfiguration (ProjectV2IterationFieldConfigurationInput)

迭代字段的配置。

name (String!)

字段的名称。

projectId (ID!)

要在其中创建字段的项目 ID。

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

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

CreateProjectV2Input

CreateProjectV2 的自动生成输入类型。

CreateProjectV2Input 的输入字段

名称描述

clientMutationId (String)

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

ownerId (ID!)

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

repositoryId (ID)

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

teamId (ID)

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

title (String!)

项目的标题。

CreateProjectV2IssueFieldInput

CreateProjectV2IssueField 的自动生成输入类型。

CreateProjectV2IssueFieldInput 的输入字段

名称描述

clientMutationId (String)

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

issueFieldId (ID!)

要为其创建字段的 IssueField 的 ID。

projectId (ID!)

要在其中创建字段的项目 ID。

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。

CreateRepositoryCustomPropertyInput

CreateRepositoryCustomProperty 的自动生成输入类型。

CreateRepositoryCustomPropertyInput 的输入字段

名称描述

allowedValues ([String!])

自定义属性的允许值。

clientMutationId (String)

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

defaultValue (String)

如果属性是必需的,则为自定义属性的默认值。

description (String)

自定义属性的描述。

propertyName (String!)

自定义属性的名称。

regex (String)

如果 value_typestring,则自定义属性的值必须匹配的正则表达式模式。

requireExplicitValues (Boolean)

此存储库自定义属性是否需要显式值。

required (Boolean)

自定义属性是否为必需。

sourceId (ID!)

应在其中创建新自定义属性的源的全局 relay id。

valueType (CustomPropertyValueType!)

自定义属性的值类型。

valuesEditableBy (RepositoryCustomPropertyValuesEditableBy)

可以编辑自定义属性值的允许参与者。

CreateRepositoryInput

CreateRepository 的自动生成输入类型。

CreateRepositoryInput 的输入字段

名称描述

clientMutationId (String)

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

description (String)

新仓库的简短描述。

hasIssuesEnabled (Boolean)

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

hasWikiEnabled (Boolean)

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

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

应在其中创建新规则集的源的全局 relay 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 (Boolean)

赞助商是否应接收来自赞助对象的电子邮件更新。

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 (Boolean)

赞助商是否应接收来自这些赞助对象的电子邮件更新。

recurring (Boolean)

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

sponsorLogin (String!)

充当赞助商、支付赞助费用的用户或组织的用户名。

sponsorships ([BulkSponsorship!]!)

要赞助的维护者名单以及每人的赞助金额。

CreateUserListInput

CreateUserList 的自动生成输入类型。

CreateUserListInput 的输入字段

名称描述

clientMutationId (String)

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

description (String)

列表的描述。

isPrivate (Boolean)

该列表是否为私有。

name (String!)

新列表的名称。

CustomPropertyValueInput

要设置的自定义属性名称和值。

CustomPropertyValueInput 的输入字段

名称描述

propertyName (String!)

自定义属性的名称。

value (CustomPropertyValue)

为自定义属性设置的值。使用 null 值将取消设置属性值,如果属性是必需的,则恢复为默认值。

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

要删除的分支保护规则的全局 relay 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。

DeleteIssueFieldInput

DeleteIssueField 的自动生成输入类型。

DeleteIssueFieldInput 的输入字段

名称描述

clientMutationId (String)

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

fieldId (ID!)

要删除的字段 ID。

DeleteIssueFieldValueInput

DeleteIssueFieldValue 的自动生成输入类型。

DeleteIssueFieldValueInput 的输入字段

名称描述

clientMutationId (String)

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

fieldId (ID!)

要删除的字段 ID。

issueId (ID!)

议题的 ID。

DeleteIssueInput

DeleteIssue 的自动生成输入类型。

DeleteIssueInput 的输入字段

名称描述

clientMutationId (String)

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

issueId (ID!)

要删除的议题 ID。

DeleteIssueTypeInput

DeleteIssueType 的自动生成输入类型。

DeleteIssueTypeInput 的输入字段

名称描述

clientMutationId (String)

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

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

应从中移除该项目的 Project 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。

DeleteRepositoryCustomPropertyInput

DeleteRepositoryCustomProperty 的自动生成输入类型。

DeleteRepositoryCustomPropertyInput 的输入字段

名称描述

clientMutationId (String)

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

id (ID!)

要删除的自定义属性的全局 relay id。

DeleteRepositoryRulesetInput

DeleteRepositoryRuleset 的自动生成输入类型。

DeleteRepositoryRulesetInput 的输入字段

名称描述

clientMutationId (String)

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

repositoryRulesetId (ID!)

要删除的存储库规则集的全局 relay 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)

该行所在的差异面。对于多行评论,这是结束行范围所在的面。

startLine (Int)

评论引用范围的第一行。

startSide (DiffSide)

起始行所在的差异面。

EnablePullRequestAutoMergeInput

EnablePullRequestAutoMerge 的自动生成输入类型。

EnablePullRequestAutoMergeInput 的输入字段

名称描述

authorEmail (String)

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

clientMutationId (String)

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

commitBody (String)

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

commitHeadline (String)

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

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

Enterprise Server 安装连接的排序选项。

EnterpriseServerInstallationOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseServerInstallationOrderField!)

对 Enterprise Server 安装进行排序的字段。

EnterpriseServerUserAccountEmailOrder

Enterprise Server 用户账户电子邮件连接的排序选项。

EnterpriseServerUserAccountEmailOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseServerUserAccountEmailOrderField!)

对电子邮件进行排序的字段。

EnterpriseServerUserAccountOrder

Enterprise Server 用户账户连接的排序选项。

EnterpriseServerUserAccountOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (EnterpriseServerUserAccountOrderField!)

对用户账户进行排序的字段。

EnterpriseServerUserAccountsUploadOrder

Enterprise Server 用户账户上传连接的排序选项。

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 树的根是一个空字符串,因此路径不带斜杠前缀。

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

编码

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

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

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

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

建模文件更改

可以在 git 提交中进行的五种概念性更改都可以使用 FileChanges 类型描述如下:

  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. 无更改的文件重命名:将原内容为 hello world\ndocs/README.txt 重命名为 newdocs/README.txt,内容保持不变。

    {
      "deletions" [
        {
          "path": "docs/README.txt",
        }
      ],
      "additions" [
        {
          "path": "newdocs/README.txt",
          "contents": base64encode("hello world\n")
        }
      ]
    }
    
  5. 有更改的文件重命名:将原内容为 hello world\ndocs/README.txt 重命名为路径 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

Gist 连接的排序选项。

GistOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (GistOrderField!)

对存储库进行排序的字段。

GrantEnterpriseOrganizationsMigratorRoleInput

GrantEnterpriseOrganizationsMigratorRole 的自动生成输入类型。

GrantEnterpriseOrganizationsMigratorRoleInput 的输入字段

名称描述

clientMutationId (String)

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

enterpriseId (ID!)

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

login (String!)

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

GrantMigratorRoleInput

GrantMigratorRole 的自动生成输入类型。

GrantMigratorRoleInput 的输入字段

名称描述

actor (String!)

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

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

用于对议题评论进行排序的字段。

IssueDependencyOrder

议题依赖项的排序选项。

IssueDependencyOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (IssueDependencyOrderField!)

对议题依赖项进行排序的字段。

IssueFieldCreateOrUpdateInput

表示创建议题期间必须在议题上设置的议题字段值。

IssueFieldCreateOrUpdateInput 的输入字段

名称描述

dateValue (String)

日期字段的日期值。

delete (Boolean)

设置为 true 以删除该字段值。

fieldId (ID!)

议题字段的 ID。

numberValue (Float)

数值,用于数字字段。

singleSelectOptionId (ID)

所选选项的 ID,用于单选字段。

textValue (String)

文本值,用于文本字段。

IssueFieldOrder

议题字段连接的排序选项。

IssueFieldOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (IssueFieldOrderField!)

议题字段排序所依据的字段。

IssueFieldSingleSelectOptionInput

议题字段的单选选项。

IssueFieldSingleSelectOptionInput 的输入字段

名称描述

color (IssueFieldSingleSelectOptionColor!)

与该选项关联的颜色。

description (String)

选项的描述。

name (String!)

选项的名称。

priority (Int!)

该选项在列表中的优先级。

IssueFilters

过滤议题列表的方法。

IssueFilters 的输入字段

名称描述

assignee (String)

列出指派给给定名称的议题。对于没有指派用户的议题,传入 null;对于指派给任何用户的议题,传入 *

createdBy (String)

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

labels ([String!])

列出包含指定标签名称列表的议题。

mentioned (String)

列出提及给定名称的议题。

milestone (String)

按给定的里程碑参数列出议题。如果传入的是整数的字符串表示形式,则应通过数据库 ID 引用里程碑。对于没有里程碑的议题,传入 null;对于已指派给任何里程碑的议题,传入 *

milestoneNumber (String)

按给定的里程碑参数列出议题。如果传入的是整数的字符串表示形式,则应通过其 number 字段引用里程碑。对于没有里程碑的议题,传入 null;对于已指派给任何里程碑的议题,传入 *

since (DateTime)

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

states ([IssueState!])

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

type (String)

按给定的类型过滤议题列表,仅支持对存储库的搜索。

viewerSubscribed (Boolean)

列出查看者订阅的议题。

IssueOrder

返回议题列表时的排序方式。

IssueOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段对议题进行排序的方向。

field (IssueOrderField!)

议题排序所依据的字段。

IssueTypeOrder

议题类型连接的排序选项。

IssueTypeOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (IssueTypeOrderField!)

议题类型排序所依据的字段。

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

假人 (mannequins) 的排序选项。

MannequinOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (MannequinOrderField!)

假人排序所依据的字段。

MarkDiscussionCommentAsAnswerInput

MarkDiscussionCommentAsAnswer 的自动生成输入类型。

MarkDiscussionCommentAsAnswerInput 的输入字段

名称描述

clientMutationId (String)

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

id (ID!)

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

MarkFileAsViewedInput

MarkFileAsViewed 的自动生成输入类型。

MarkFileAsViewedInput 的输入字段

名称描述

clientMutationId (String)

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

path (String!)

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

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

允许的最大文件大小(以 MB 为单位)。此限制不适用于 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 引用必须匹配的 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!)

组织排序所依据的字段。

OrganizationPropertyConditionTargetInput

用于 organization_property 条件的参数。

OrganizationPropertyConditionTargetInput 的输入字段

名称描述

exclude ([OrganizationPropertyTargetDefinitionInput!]!)

不得匹配的组织属性数组。

include ([OrganizationPropertyTargetDefinitionInput!]!)

必须匹配的组织属性数组。

OrganizationPropertyTargetDefinitionInput

必须匹配的属性。

OrganizationPropertyTargetDefinitionInput 的输入字段

名称描述

name (String!)

属性名称。

propertyValues ([String!]!)

要匹配的值。

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

所需的环境状态。如果为 true,环境将被置顶。如果为 false,将取消置顶。

PinIssueCommentInput

PinIssueComment 的自动生成输入类型。

PinIssueCommentInput 的输入字段

名称描述

clientMutationId (String)

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

issueCommentId (ID!)

要置顶的议题评论 ID。拉取请求不支持评论置顶。

PinIssueInput

PinIssue 的自动生成输入类型。

PinIssueInput 的输入字段

名称描述

clientMutationId (String)

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

issueId (ID!)

要置顶的议题 ID。

PinnedEnvironmentOrder

置顶环境的排序选项。

PinnedEnvironmentOrder 的输入字段

名称描述

direction (OrderDirection!)

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

field (PinnedEnvironmentOrderField!)

置顶环境排序所依据的字段。

ProjectCardImport

用于项目卡片的议题或拉取请求及其所属存储库。

ProjectCardImport 的输入字段

名称描述

number (Int!)

议题或拉取请求编号。

repository (String!)

带有所有者的存储库名称 (owner/repository)。

ProjectColumnImport

项目列及其议题和拉取请求列表。

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

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

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) 项排序所依据的字段。

ProjectV2Iteration

代表一次迭代。

ProjectV2Iteration 的输入字段

名称描述

duration (Int!)

迭代的持续时间(天)。

startDate (Date!)

迭代的开始日期。

title (String!)

迭代的标题。

ProjectV2IterationFieldConfigurationInput

代表迭代字段配置。

ProjectV2IterationFieldConfigurationInput 的输入字段

名称描述

duration (Int!)

每次迭代的持续时间(天)。

iterations ([ProjectV2Iteration!]!)

该字段的零个或多个迭代。

startDate (Date!)

第一次迭代的开始日期。

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) 工作流排序所依据的字段。

PromoteRepositoryCustomPropertyInput

PromoteRepositoryCustomProperty 的自动生成输入类型。

PromoteRepositoryCustomPropertyInput 的输入字段

名称描述

clientMutationId (String)

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

repositoryCustomPropertyId (ID!)

要晋升的存储库自定义属性 ID。

PropertyTargetDefinitionInput

必须匹配的属性。

PropertyTargetDefinitionInput 的输入字段

名称描述

name (String!)

属性名称。

propertyValues ([String!]!)

要匹配的值。

source (String)

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

PublishSponsorsTierInput

PublishSponsorsTier 的自动生成输入类型。

PublishSponsorsTierInput 的输入字段

名称描述

clientMutationId (String)

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

tierId (ID!)

要发布的草稿层级 (tier) ID。

PullRequestOrder

返回议题列表时的排序方式。

PullRequestOrder 的输入字段

名称描述

direction (OrderDirection!)

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

field (PullRequestOrderField!)

拉取请求排序所依据的字段。

PullRequestParametersInput

要求所有提交在合并前必须先提交到非目标分支,并随后通过拉取请求提交。

PullRequestParametersInput 的输入字段

名称描述

allowedMergeMethods ([PullRequestAllowedMergeMethods!])

允许的合并方法数组。允许的值包括 mergesquashrebase。必须至少启用一个选项。

dismissStaleReviewsOnPush (Boolean!)

推送新的可评审提交将取消之前的拉取请求评审批准。

requireCodeOwnerReview (Boolean!)

在修改具有指定代码所有者的文件的拉取请求中,需要获得批准的评审。

requireLastPushApproval (Boolean!)

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

requiredApprovingReviewCount (Int!)

拉取请求在合并前所需的批准评审数量。

requiredReviewThreadResolution (Boolean!)

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

requiredReviewers ([RequiredReviewerConfigurationInput!])

此参数处于测试阶段,可能会发生变化。评审者及其关联文件模式的集合。每个评审者都有一个文件模式列表,这些模式决定了该评审者必须评审的文件。

ReactionOrder

返回反应 (reactions) 列表时的排序方式。

ReactionOrder 的输入字段

名称描述

direction (OrderDirection!)

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

field (ReactionOrderField!)

反应排序所依据的字段。

RefNameConditionTargetInput

用于 ref_name 条件的参数。

RefNameConditionTargetInput 的输入字段

名称描述

exclude ([String!]!)

要排除的引用名称或模式数组。如果匹配其中任何模式,则条件将不通过。

include ([String!]!)

要包含的引用名称或模式数组。必须匹配其中一个模式才能使条件通过。还接受 ~DEFAULT_BRANCH 以包含默认分支,或使用 ~ALL 以包含所有分支。

RefOrder

返回 git 引用列表时的排序方式。

RefOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段对引用进行排序的方向。

field (RefOrderField!)

引用排序所依据的字段。

RefUpdate

引用更新。

RefUpdate 的输入字段

名称描述

afterOid (GitObjectID!)

此引用应更新到的值。

beforeOid (GitObjectID)

更新前此引用需要指向的值。

force (Boolean)

强制进行非快进式 (non fast-forward) 更新。

name (GitRefname!)

要更新的引用的全限定名称。例如 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

返回发布 (releases) 列表时的排序方式。

ReleaseOrder 的输入字段

名称描述

direction (OrderDirection!)

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

field (ReleaseOrderField!)

发布排序所依据的字段。

RemoveAssigneesFromAssignableInput

RemoveAssigneesFromAssignable 的自动生成输入类型。

RemoveAssigneesFromAssignableInput 的输入字段

名称描述

assignableId (ID!)

要从中移除被指派人的可指派对象 ID。

assigneeIds ([ID!]!)

要移除的被指派人的参与者 ID。

clientMutationId (String)

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

RemoveBlockedByInput

RemoveBlockedBy 的自动生成输入类型。

RemoveBlockedByInput 的输入字段

名称描述

blockingIssueId (ID!)

阻塞议题 (blocking issue) 的 ID。

clientMutationId (String)

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

issueId (ID!)

被阻塞议题 (blocked issue) 的 ID。

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

要取消点赞的可星标对象 ID。

RemoveSubIssueInput

RemoveSubIssue 的自动生成输入类型。

RemoveSubIssueInput 的输入字段

名称描述

clientMutationId (String)

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

issueId (ID!)

议题的 ID。

subIssueId (ID!)

子议题的 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!)

环境的理想位置。

ReplaceActorsForAssignableInput

ReplaceActorsForAssignable 的自动生成输入类型。

ReplaceActorsForAssignableInput 的输入字段

名称描述

actorIds ([ID!])

用于替换现有被指派人的参与者 ID。可以作为 actorLogins 的替代方案或与其结合使用。

actorLogins ([String!])

用于替换现有被指派人的参与者用户名。可以作为 actorIds 的替代方案或与其结合使用。对于机器人,请使用带有 [bot] 后缀的登录名格式(例如,'my-app[bot]')。

agentAssignment (AgentAssignmentInput)

为此议题指派 AI 代理的配置。

assignableId (ID!)

要为其替换被指派人的可指派对象 ID。

clientMutationId (String)

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

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 的输入字段

名称描述

organizationProperty (OrganizationPropertyConditionTargetInput)

organization_property 条件的配置。

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)

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

enterpriseOwner (Boolean)

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

organizationAdmin (Boolean)

对于组织管理员绕过,为 true。

repositoryRoleDatabaseId (Int)

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

ReprioritizeSubIssueInput

ReprioritizeSubIssue 的自动生成输入类型。

ReprioritizeSubIssueInput 的输入字段

名称描述

afterId (ID)

要在其之后排列优先级的子议题 ID(应指定 after 或 before 位置参数其中之一)。

beforeId (ID)

要在其之前排列优先级的子议题 ID(应指定 after 或 before 位置参数其中之一)。

clientMutationId (String)

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

issueId (ID!)

父议题 ID。

subIssueId (ID!)

要重新排列优先级的子议题 ID。

RequestReviewsByLoginInput

RequestReviewsByLogin 的自动生成输入类型。

RequestReviewsByLoginInput 的输入字段

名称描述

botLogins ([String!])

请求其进行评审的机器人登录名,包括 [bot] 后缀(例如,'copilot-pull-request-reviewer[bot]')。

clientMutationId (String)

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

pullRequestId (ID!)

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

teamSlugs ([String!])

请求其进行评审的团队 slug(格式:'org/team-slug')。

union (Boolean)

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

userLogins ([String!])

请求其进行评审的用户登录字符串。

RequestReviewsInput

RequestReviews 的自动生成输入类型。

RequestReviewsInput 的输入字段

名称描述

botIds ([ID!])

请求的机器人节点 ID。

clientMutationId (String)

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

pullRequestId (ID!)

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

teamIds ([ID!])

请求的团队节点 ID。

union (Boolean)

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

userIds ([ID!])

请求的用户节点 ID。

RequiredDeploymentsParametersInput

选择在将引用推送到匹配此规则的引用之前,必须成功部署到的环境。

RequiredDeploymentsParametersInput 的输入字段

名称描述

requiredDeploymentEnvironments ([String!]!)

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

RequiredReviewerConfigurationInput

一个评审团队,以及描述他们必须批准哪些文件更改的文件模式。

RequiredReviewerConfigurationInput 的输入字段

名称描述

filePatterns ([String!]!)

文件模式数组。更改匹配文件的拉取请求必须由指定团队批准。文件模式使用 fnmatch 语法。

minimumApprovals (Int!)

指定团队所需的最低批准数量。如果设置为零,团队将被添加到拉取请求中,但批准是可选的。

reviewerId (ID!)

必须评审匹配文件更改的团队节点 ID。

RequiredStatusCheckInput

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

RequiredStatusCheckInput 的输入字段

名称描述

appId (ID)

必须设置状态才能使其被接受的应用程序 ID。省略此值将使用最近一直在设置此状态的任何应用程序,或者使用 "any" 以允许任何应用程序设置状态。

context (String!)

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

RequiredStatusChecksParametersInput

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

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

要退出的已发布层级 (tier) 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!)

要从中撤销迁移者角色的用户登录名或团队 slug。

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 规则类型的参数。

copilotCodeReview (CopilotCodeReviewParametersInput)

用于 copilot_code_review 规则类型的参数。

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 终结点。

SetIssueFieldValueInput

SetIssueFieldValue 的自动生成输入类型。

SetIssueFieldValueInput 的输入字段

名称描述

clientMutationId (String)

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

issueFields ([IssueFieldCreateOrUpdateInput!]!)

要在议题上设置的议题字段。

issueId (ID!)

要设置字段值的议题 ID。

SetOrganizationInteractionLimitInput

SetOrganizationInteractionLimit 的自动生成输入类型。

SetOrganizationInteractionLimitInput 的输入字段

名称描述

clientMutationId (String)

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

expiry (RepositoryInteractionLimitExpiry)

此限制应在何时过期。

limit (RepositoryInteractionLimit!)

要设置的限制。

organizationId (ID!)

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

SetRepositoryCustomPropertyValuesInput

SetRepositoryCustomPropertyValues 的自动生成输入类型。

SetRepositoryCustomPropertyValuesInput 的输入字段

名称描述

clientMutationId (String)

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

properties ([CustomPropertyValueInput!]!)

要应用的自定义属性名称及相关值的列表。

repositoryId (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 tiers) 连接的排序选项。

SponsorsTierOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorsTierOrderField!)

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

SponsorshipNewsletterOrder

赞助新闻通讯连接的排序选项。

SponsorshipNewsletterOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorshipNewsletterOrderField!)

用于对赞助新闻通讯进行排序的字段。

SponsorshipOrder

赞助连接的排序选项。

SponsorshipOrder 的输入字段

名称描述

direction (OrderDirection!)

排序方向。

field (SponsorshipOrderField!)

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

StarOrder

Star 连接的排序方式。

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)

是否跳过迁移该仓库的发布版 (releases)。

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

要匹配的模式。

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。

UnpinIssueCommentInput

UnpinIssueComment 自动生成的输入类型。

UnpinIssueCommentInput 的输入字段

名称描述

clientMutationId (String)

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

issueCommentId (ID!)

要取消置顶的议题评论 ID。拉取请求不支持评论置顶。

UnpinIssueInput

UnpinIssue 自动生成的输入类型。

UnpinIssueInput 的输入字段

名称描述

clientMutationId (String)

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

issueId (ID!)

要取消置顶的议题 ID。

UnresolveReviewThreadInput

UnresolveReviewThread 自动生成的输入类型。

UnresolveReviewThreadInput 的输入字段

名称描述

clientMutationId (String)

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

threadId (ID!)

要取消解决的线索 ID。

UpdateBranchProtectionRuleInput

UpdateBranchProtectionRule 自动生成的输入类型。

UpdateBranchProtectionRuleInput 的输入字段

名称描述

allowsDeletions (Boolean)

此分支是否可以删除。

allowsForcePushes (Boolean)

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

blocksCreations (Boolean)

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

branchProtectionRuleId (ID!)

要更新的分支保护规则的全局中继 ID。

bypassForcePushActorIds ([ID!])

允许绕过强制推送并以匹配分支为目标的 User、Team 或 App ID 列表。

bypassPullRequestActorIds ([ID!])

允许绕过拉取请求并以匹配分支为目标的 User、Team 或 App ID 列表。

clientMutationId (String)

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

dismissesStaleReviews (Boolean)

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

isAdminEnforced (Boolean)

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

lockAllowsFetchAndMerge (Boolean)

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

lockBranch (Boolean)

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

pattern (String)

用于确定匹配分支的类 glob 模式。

pushActorIds ([ID!])

允许推送到匹配分支的 User、Team 或 App 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!])

允许在以匹配分支为目标的拉取请求上驳回审核的 User、Team 或 App 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)

企业的名称。

securityContactEmail (String)

企业的安全联系电子邮件地址。

websiteUrl (String)

企业网站的 URL。

UpdateEnterpriseRepositoryProjectsSettingInput

UpdateEnterpriseRepositoryProjectsSetting 自动生成的输入类型。

UpdateEnterpriseRepositoryProjectsSettingInput 的输入字段

名称描述

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 允许列表配置设置的值。

UpdateIpAllowListUserLevelEnforcementEnabledSettingInput

UpdateIpAllowListUserLevelEnforcementEnabledSetting 自动生成的输入类型。

UpdateIpAllowListUserLevelEnforcementEnabledSettingInput 的输入字段

名称描述

clientMutationId (String)

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

ownerId (ID!)

所有者的 ID。

settingValue (IpAllowListUserLevelEnforcementEnabledSettingValue!)

启用 IP 允许列表用户级强制执行设置的值。

UpdateIssueCommentInput

UpdateIssueComment 自动生成的输入类型。

UpdateIssueCommentInput 的输入字段

名称描述

body (String!)

评论更新后的文本。

clientMutationId (String)

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

id (ID!)

要修改的 IssueComment 的 ID。

UpdateIssueFieldInput

UpdateIssueField 自动生成的输入类型。

UpdateIssueFieldInput 的输入字段

名称描述

clientMutationId (String)

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

description (String)

议题字段的描述。

id (ID!)

要更新的议题字段 ID。

name (String)

议题字段的名称。

options ([IssueFieldSingleSelectOptionInput!])

议题字段的选项(如果适用)。

visibility (IssueFieldVisibility)

议题字段的可见性。

UpdateIssueFieldValueInput

UpdateIssueFieldValue 自动生成的输入类型。

UpdateIssueFieldValueInput 的输入字段

名称描述

clientMutationId (String)

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

issueField (IssueFieldCreateOrUpdateInput!)

要更新的字段值。

issueId (ID!)

议题的 ID。

UpdateIssueInput

UpdateIssue 自动生成的输入类型。

UpdateIssueInput 的输入字段

名称描述

agentAssignment (AgentAssignmentInput)

为此议题指派 AI 代理的配置。

assigneeIds ([ID!])

该议题的用户或机器人的节点 ID 数组。

body (String)

议题说明的正文。

clientMutationId (String)

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

id (ID!)

要修改的议题 ID。

issueTypeId (ID)

该议题的议题类型 ID。

labelIds ([ID!])

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

milestoneId (ID)

此议题里程碑的节点 ID。

projectIds ([ID!])

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

state (IssueState)

期望的议题状态。

title (String)

议题的标题。

UpdateIssueIssueTypeInput

UpdateIssueIssueType 自动生成的输入类型。

UpdateIssueIssueTypeInput 的输入字段

名称描述

clientMutationId (String)

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

issueId (ID!)

要更新的议题 ID。

issueTypeId (ID)

要在议题上更新的议题类型 ID。

UpdateIssueTypeInput

UpdateIssueType 自动生成的输入类型。

UpdateIssueTypeInput 的输入字段

名称描述

clientMutationId (String)

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

color (IssueTypeColor)

议题类型的颜色。

description (String)

议题类型的描述。

isEnabled (Boolean)

是否为该组织启用了该议题类型。

issueTypeId (ID!)

要更新的议题类型 ID。

name (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

仅允许具有绕过权限的用户更新匹配的引用。

UpdateParametersInput 的输入字段

名称描述

updateAllowsFetchAndMerge (Boolean!)

分支可以从其上游仓库拉取更改。

UpdatePatreonSponsorabilityInput

UpdatePatreonSponsorability 自动生成的输入类型。

UpdatePatreonSponsorabilityInput 的输入字段

名称描述

clientMutationId (String)

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

enablePatreonSponsorships (Boolean!)

Patreon 等级是否应显示在 GitHub Sponsors 个人资料页面上,从而允许潜在赞助者通过 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)

草稿议题的标题。

UpdateProjectV2FieldInput

UpdateProjectV2Field 自动生成的输入类型。

UpdateProjectV2FieldInput 的输入字段

名称描述

clientMutationId (String)

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

fieldId (ID!)

要更新的字段 ID。

iterationConfiguration (ProjectV2IterationFieldConfigurationInput)

ITERATION 类型字段的配置。空输入将被忽略,提供的值将覆盖现有配置,应获取现有配置以进行部分更新。

name (String)

要更新的名称。

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

SINGLE_SELECT 类型字段的选项。空输入将被忽略,提供的值将覆盖现有选项,应获取现有选项以进行部分更新。

UpdateProjectV2Input

UpdateProjectV2 自动生成的输入类型。

UpdateProjectV2Input 的输入字段

名称描述

clientMutationId (String)

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

closed (Boolean)

将项目设置为关闭或开启。

projectId (ID!)

要更新的项目 ID。

public (Boolean)

将项目设置为公开或私有。

readme (String)

设置项目的 README 描述。

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)

上游分支的 head 引用 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)

是否允许非快进式 (non-fast-forward) 的分支引用更新?

oid (GitObjectID!)

引用应当更新指向的 GitObjectID。

refId (ID!)

要更新的引用的节点 ID。

UpdateRefsInput

UpdateRefs 自动生成的输入类型。

UpdateRefsInput 的输入字段

名称描述

clientMutationId (String)

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

refUpdates ([RefUpdate!]!)

引用更新列表。

repositoryId (ID!)

仓库的节点 ID。

UpdateRepositoryCustomPropertyInput

UpdateRepositoryCustomProperty 自动生成的输入类型。

UpdateRepositoryCustomPropertyInput 的输入字段

名称描述

allowedValues ([String!])

自定义属性更新后的允许值。

clientMutationId (String)

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

defaultValue (String)

如果自定义属性是必需的,其更新后的默认值。

description (String)

自定义属性更新后的描述。

regex (String)

如果 value_typestring,则自定义属性的值必须匹配的正则表达式模式。

repositoryCustomPropertyId (ID!)

自定义属性来源的全局中继 ID。

requireExplicitValues (Boolean)

此存储库自定义属性是否需要显式值。

required (Boolean)

更新后的自定义属性是否为必需。

valuesEditableBy (RepositoryCustomPropertyValuesEditableBy)

可以编辑自定义属性值的更新后的执行者。

UpdateRepositoryInput

UpdateRepository 自动生成的输入类型。

UpdateRepositoryInput 的输入字段

名称描述

clientMutationId (String)

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

description (String)

仓库的新描述。传递空字符串以擦除现有描述。

hasDiscussionsEnabled (Boolean)

指示仓库是否应当启用讨论功能。

hasIssuesEnabled (Boolean)

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

hasProjectsEnabled (Boolean)

指示仓库是否应当启用项目看板功能。

hasPullRequestsEnabled (Boolean)

指示仓库是否应当启用拉取请求功能。

hasSponsorshipsEnabled (Boolean)

指示仓库是否显示用于资金捐助的“赞助 (Sponsor)”按钮。

hasWikiEnabled (Boolean)

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

homepageUrl (URI)

有关此仓库的网页 URL。传递空字符串以擦除现有 URL。

name (String)

仓库的新名称。

pullRequestCreationPolicy (PullRequestCreationPolicy)

控制谁可以在此仓库中创建拉取请求的策略。

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 (Boolean)

赞助商是否应接收来自赞助对象的电子邮件更新。

sponsorId (ID)

作为赞助者(支付赞助费用)的用户或组织的 ID。如果未提供 sponsorLogin,则必填。

sponsorLogin (String)

作为赞助者(支付赞助费用)的用户或组织的用户名。如果未提供 sponsorId,则必填。

sponsorableId (ID)

接收赞助的用户或组织的 ID。如果未提供 sponsorableLogin,则必填。

sponsorableLogin (String)

接收赞助的用户或组织的用户名。如果未提供 sponsorableId,则必填。

UpdateSubscriptionInput

UpdateSubscription 自动生成的输入类型。

UpdateSubscriptionInput 的输入字段

名称描述

clientMutationId (String)

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

state (SubscriptionState!)

订阅的新状态。

subscribableId (ID!)

要修改的可订阅对象的节点 ID。

UpdateTeamReviewAssignmentInput

UpdateTeamReviewAssignment 自动生成的输入类型。

UpdateTeamReviewAssignmentInput 的输入字段

名称描述

algorithm (TeamReviewAssignmentAlgorithm)

用于审阅分配的算法。

clientMutationId (String)

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

countMembersAlreadyRequested (Boolean)

将已请求审阅的任何成员计入分配审阅的所需成员数量中。

enabled (Boolean!)

开启或关闭审阅分配。

excludedTeamMemberIds ([ID!])

要排除的团队成员 ID 数组。

id (ID!)

要更新审阅分配的团队节点 ID。

includeChildTeamMembers (Boolean)

分配时包含任何子团队的成员。

notifyTeam (Boolean)

如果是委派的,通知整个团队该拉取请求。

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 (Boolean)

该列表是否为私有。

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)

要使用的工作流文件的引用(分支或标签)。

repositoryId (Int!)

定义工作流的仓库 ID。

sha (String)

要使用的工作流文件的提交 SHA。

WorkflowRunOrder

返回时工作流运行列表的排序方式。

WorkflowRunOrder 的输入字段

名称描述

direction (OrderDirection!)

按指定字段对工作流运行进行排序的方向。

field (WorkflowRunOrderField!)

用于对工作流进行排序的字段。

WorkflowsParametersInput

要求对目标分支所做的所有更改在合并前必须通过指定的工作流。

WorkflowsParametersInput 的输入字段

名称描述

doNotEnforceOnCreate (Boolean)

如果状态检查原本会禁止创建存储库和分支,则允许创建它们。

workflows ([WorkflowFileReferenceInput!]!)

规则通过前必须通过的工作流。

© . This site is unofficial and not affiliated with GitHub, Inc.