重大更改

了解 GitHub GraphQL API 最近和即将发生的重大更改。

本文内容

关于重大更改

重大更改是指可能需要我们的集成商采取行动的任何更改。我们将这些更改分为两类

  • 重大更改： 会破坏对 GraphQL API 的现有查询的更改。例如，删除字段将是重大更改。
  • 危险更改： 不会破坏现有查询但可能会影响客户端运行时行为的更改。添加枚举值是危险更改的一个示例。

我们将在对 GraphQL 模式进行更改之前至少提前三个月宣布即将发生的重大更改，以便集成商有时间进行必要的调整。更改将在季度的第一天生效（1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日）。例如，如果我们在 1 月 15 日宣布更改，则将在 7 月 1 日进行更改。

计划于 2025 年 10 月 1 日进行的更改

  • 重大更改 将对SecurityAdvisory.cvss进行更改。
    说明：

    cvss将被删除。新的cvss_severities字段现在将包含cvss_v3和cvss_v4属性。

    原因：

    cvss将被删除。

计划于 2025 年 4 月 1 日进行的更改

  • 重大更改 将对ProjectV2Workflow.databaseId进行更改。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 将对ProjectV2View.databaseId进行更改。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 将对ProjectV2StatusUpdate.databaseId进行更改。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 将对ProjectV2Item.databaseId进行更改。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 将对ProjectV2.databaseId进行更改。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 将对EnterpriseOwnerInfo.outsideCollaborators.hasTwoFactorEnabled进行更改。
    说明：

    hasTwoFactorEnabled将被删除。请改用two_factor_method_security。

    原因：

    has_two_factor_enabled将被删除。

  • 重大更改 将对EnterpriseOwnerInfo.admins.hasTwoFactorEnabled进行更改。
    说明：

    hasTwoFactorEnabled将被删除。请改用two_factor_method_security。

    原因：

    has_two_factor_enabled将被删除。

  • 重大更改 将对Enterprise.members.hasTwoFactorEnabled进行更改。
    说明：

    hasTwoFactorEnabled将被删除。请改用two_factor_method_security。

    原因：

    has_two_factor_enabled将被删除。

计划于 2025 年 1 月 1 日进行的更改

  • 重大更改 将对AddMobileDevicePublicKeyPayload.expiresAt进行更改。
    说明：

    expiresAt将被删除。请勿依赖此字段，如果设备密钥无限期有效，则当前将其设置为未来某个日期。

    原因：

    我们正在弃用用于移动双因素身份验证的移动设备密钥的过期时间。

计划于 2024 年 10 月 1 日进行的更改

  • 重大更改 将对Workflow.hasWorkflowDispatchTrigger进行更改。
    说明：

    hasWorkflowDispatchTrigger将被删除。请改用has_workflow_dispatch_trigger_for_branch(branch_ref)。

    原因：

    has_workflow_dispatch_trigger将被删除，因为它可能会产生误导，并且仅检查存储库的默认分支。

计划于 2024 年 7 月 1 日进行的更改

  • 重大更改 PullRequestReviewComment.databaseId 将发生变更。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 PullRequestReview.databaseId 将发生变更。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 PullRequest.databaseId 将发生变更。
    说明：

    databaseId将被删除。请改用fullDatabaseId。

    原因：

    databaseId将被删除，因为它不支持 64 位有符号整数标识符。

  • 重大更改 OrganizationInvitation.inviter 将发生变更。
    描述：

    inviter 将被移除。inviter 将被 inviterActor 替换。

    原因：

    inviter 将被移除。

计划于 2024-04-01 发布的变更

  • 重大更改 TopicSuggestionDeclineReason.TOO_SPECIFIC 将发生变更。
    描述：

    TOO_SPECIFIC 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 TopicSuggestionDeclineReason.TOO_GENERAL 将发生变更。
    描述：

    TOO_GENERAL 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 TopicSuggestionDeclineReason.PERSONAL_PREFERENCE 将发生变更。
    描述：

    PERSONAL_PREFERENCE 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 TopicSuggestionDeclineReason.NOT_RELEVANT 将发生变更。
    描述：

    NOT_RELEVANT 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 DeclineTopicSuggestionPayload.topic 将发生变更。
    描述：

    topic 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 DeclineTopicSuggestionInput.repositoryId 将发生变更。
    描述：

    repositoryId 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 DeclineTopicSuggestionInput.reason 将发生变更。
    描述：

    reason 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 DeclineTopicSuggestionInput.name 将发生变更。
    描述：

    name 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 AcceptTopicSuggestionPayload.topic 将发生变更。
    描述：

    topic 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 AcceptTopicSuggestionInput.repositoryId 将发生变更。
    描述：

    repositoryId 将被移除。

    原因：

    不再支持建议主题

  • 重大更改 AcceptTopicSuggestionInput.name 将发生变更。
    描述：

    name 将被移除。

    原因：

    不再支持建议主题

计划于 2023-10-01 发布的变更

  • 重大更改 PullRequestReviewComment.position 将发生变更。
    描述：

    position 将被移除。请改用 line 和 startLine 字段，它们表示文件行号而不是差异行号。

    原因：

    我们正在逐步淘汰 PR 评论的差异相关定位。

  • 重大更改 PullRequestReviewComment.originalPosition 将发生变更。
    描述：

    originalPosition 将被移除。

    原因：

    我们正在逐步淘汰 PR 评论的差异相关定位。

  • 重大更改 AddPullRequestReviewInput.comments 将发生变更。
    描述：

    comments 将被移除。请改用 threads 参数。

    原因：

    我们正在弃用使用差异相关定位的评论字段。

  • 重大更改 AddPullRequestReviewCommentInput.pullRequestReviewId 将发生变更。
    描述：

    pullRequestReviewId 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply。

    原因：

    我们正在弃用 addPullRequestReviewComment 变异。

  • 重大更改 AddPullRequestReviewCommentInput.pullRequestId 将发生变更。
    描述：

    pullRequestId 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply。

    原因：

    我们正在弃用 addPullRequestReviewComment 变异。

  • 重大更改 AddPullRequestReviewCommentInput.position 将发生变更。
    描述：

    position 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply。

    原因：

    我们正在弃用 addPullRequestReviewComment 变异。

  • 重大更改 AddPullRequestReviewCommentInput.path 将发生变更。
    描述：

    path 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply。

    原因：

    我们正在弃用 addPullRequestReviewComment 变异。

  • 重大更改 AddPullRequestReviewCommentInput.inReplyTo 将发生变更。
    描述：

    inReplyTo 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply。

    原因：

    我们正在弃用 addPullRequestReviewComment 变异。

  • 重大更改 AddPullRequestReviewCommentInput.commitOID 将发生变更。
    描述：

    commitOID 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply。

    原因：

    我们正在弃用 addPullRequestReviewComment 变异。

  • 重大更改 AddPullRequestReviewCommentInput.body 将发生变更。
    描述：

    body 将被移除。请改用 addPullRequestReviewThread 或 addPullRequestReviewThreadReply。

    原因：

    我们正在弃用 addPullRequestReviewComment 变异。

计划于 2023-07-01 发布的变更

  • 重大更改 ProjectV2ItemFieldGroup.field 将发生变更。
    描述：

    field 将被移除。请查看 ProjectV2ItemFieldGroup#groupByField API 作为功能更强大的替代方案的示例。

    原因：

    ProjectV2ItemFieldGroup#field API 已弃用，取而代之的是功能更强大的 ProjectV2ItemFieldGroup#groupByField API。

  • 重大更改 MergeQueueEntry.isSolo 将发生变更。
    描述：

    isSolo 将被移除。请改用 solo。

    原因：

    isSolo 将被移除。

  • 重大更改 MergeQueueEntry.headOid 将发生变更。
    描述：

    headOid 将被移除。请改用 headCommit。

    原因：

    headOid 将被移除。

  • 重大更改 MergeQueueEntry.hasJumpedQueue 将发生变更。
    描述：

    hasJumpedQueue 将被移除。请改用 jump。

    原因：

    hasJumpedQueue 将被移除。

  • 重大更改 MergeQueueEntry.checkStatus 将发生变更。
    描述：

    checkStatus 将被移除。请改用 state。

    原因：

    checkStatus 将被移除。

  • 重大更改 MergeQueueEntry.blockedByMergeConflicts 将发生变更。
    描述：

    blockedByMergeConflicts 将被移除。请改用 state。

    原因：

    blockedByMergeConflicts 将被移除。

  • 重大更改 MergeQueueEntry.baseOid 将发生变更。
    描述：

    baseOid 将被移除。请改用 baseCommit。

    原因：

    baseOid 将被移除。

  • 重大更改 MergeQueue.pendingRemovalEntries 将发生变更。
    描述：

    pendingRemovalEntries 将被移除。

    原因：

    pendingRemovalEntries 将被移除。

  • 重大更改 MergeQueue.mergingEntries 将发生变更。
    描述：

    mergingEntries 将被移除。

    原因：

    mergingEntries 将被移除。

  • 重大更改 MergeQueue.mergeMethod 将发生变更。
    描述：

    mergeMethod 将被移除。请改用 configuration.merge_method。

    原因：

    mergeMethod 将被移除。

  • 重大更改 MergeQueue.headOid 将发生变更。
    描述：

    headOid 将被移除。请改用 entry.headOid。

    原因：

    headOid 将被移除。

  • 重大更改 Commit.pushedDate 将发生变更。
    描述：

    pushedDate 将被移除。

    原因：

    pushedDate 不再受支持。

计划于 2023-04-01 发布的变更

  • 重大更改 Repository.squashPrTitleUsedAsDefault 将发生变更。
    描述：

    squashPrTitleUsedAsDefault 将被移除。请改用 Repository.squashMergeCommitTitle。

    原因：

    squashPrTitleUsedAsDefault 将被移除。

  • 重大更改 ProjectV2View.verticalGroupBy 将发生变更。
    描述：

    verticalGroupBy 将被移除。请查看 ProjectV2View#vertical_group_by_fields API 作为功能更强大的替代方案的示例。

    原因：

    ProjectV2View#vertical_group_by API 已弃用，取而代之的是功能更强大的 ProjectV2View#vertical_group_by_fields API。

  • 重大更改 ProjectV2View.sortBy 将发生变更。
    描述：

    sortBy 将被移除。请查看 ProjectV2View#sort_by_fields API 作为功能更强大的替代方案的示例。

    原因：

    ProjectV2View#sort_by API 已弃用，取而代之的是功能更强大的 ProjectV2View#sort_by_fields API。

  • 重大更改 ProjectV2View.groupBy 将发生变更。
    描述：

    groupBy 将被移除。请查看 ProjectV2View#group_by_fields API 作为功能更强大的替代方案的示例。

    原因：

    ProjectV2View#order_by API 已弃用，取而代之的是功能更强大的 ProjectV2View#group_by_field API。

计划于 2023-02-10 发布的变更

  • 重大更改 PackageType.MAVEN 将发生变更。
    描述：

    MAVEN 将被移除。

    原因：

    MAVEN 将从该枚举中移除，因为此类型将迁移到仅供 Packages REST API 使用。

计划于 2023-01-01 发布的变更

  • 重大更改 ProjectV2View.visibleFields 将发生变更。
    描述：

    visibleFields 将被移除。请查看 ProjectV2View#fields API 作为功能更强大的替代方案的示例。

    原因：

    ProjectV2View#visibleFields API 已弃用，取而代之的是功能更强大的 ProjectV2View#fields API。

  • 重大更改 Commit.changedFiles 将发生变更。
    说明：

    changedFiles 将被移除。请使用 changedFilesIfAvailable 代替。

    原因：

    changedFiles 将被移除。

计划于 2022-12-28 发布变更

  • 重大更改 PackageType.RUBYGEMS 将发生变更。
    说明：

    RUBYGEMS 将被移除。

    原因：

    RUBYGEMS 将从该枚举中移除，因为此类型将迁移为仅供 Packages REST API 使用。

计划于 2022-11-21 发布变更

  • 重大更改 PackageType.NUGET 将发生变更。
    说明：

    NUGET 将被移除。

    原因：

    NUGET 将从该枚举中移除，因为此类型将迁移为仅供 Packages REST API 使用。

  • 重大更改 PackageType.NPM 将发生变更。
    说明：

    NPM 将被移除。

    原因：

    NPM 将从该枚举中移除，因为此类型将迁移为仅供 Packages REST API 使用。

计划于 2022-10-01 发布变更

  • 重大更改 RemovePullRequestFromMergeQueueInput.branch 将发生变更。
    说明：

    branch 将被移除。

    原因：

    从合并队列中移除 PR 是针对基分支进行的，branch 参数现在已无作用。

  • 重大更改 DependencyGraphDependency.packageLabel 将发生变更。
    说明：

    packageLabel 将被移除。请使用规范化的 packageName 字段代替。

    原因：

    packageLabel 将被移除。

计划于 2022-07-01 发布变更

  • 重大更改 Query.sponsorables.dependencyEcosystem 将发生变更。
    说明：

    dependencyEcosystem 将被移除。请使用 ecosystem 参数代替。

    原因：

    类型将从 SecurityAdvisoryEcosystem 切换到 DependencyGraphEcosystem。

  • 重大更改 AddPullRequestToMergeQueueInput.branch 将发生变更。
    说明：

    branch 将被移除。

    原因：

    将 PR 添加到合并队列中是针对基分支进行的，branch 参数现在已无作用。

计划于 2021-10-01 发布变更

  • 重大更改 ReactionGroup.users 将发生变更。
    说明：

    users 将被移除。请使用 reactors 字段代替。

    原因：

    反应者现在可以是虚拟用户、机器人和组织。

计划于 2021-06-21 发布变更

  • 重大更改 PackageType.DOCKER 将发生变更。
    说明：

    DOCKER 将被移除。

    原因：

    DOCKER 将从该枚举中移除，因为此类型将迁移为仅供 Packages REST API 使用。

计划于 2021-01-01 发布变更

  • 重大更改 MergeStateStatus.DRAFT 将发生变更。
    说明：

    DRAFT 将被移除。请使用 PullRequest.isDraft 代替。

    原因：

    DRAFT 状态将从该枚举中移除，应使用 isDraft 代替。

计划于 2020-10-01 发布变更

  • 重大更改 Sponsorship.sponsor 将发生变更。
    说明：

    sponsor 将被移除。请使用 Sponsorship.sponsorEntity 代替。

    原因：

    Sponsorship.sponsor 将被移除。

  • 重大更改 PullRequest.timeline 将发生变更。
    说明：

    timeline 将被移除。请使用 PullRequest.timelineItems 代替。

    原因：

    timeline 将被移除。

  • 重大更改 Issue.timeline 将发生变更。
    说明：

    timeline 将被移除。请使用 Issue.timelineItems 代替。

    原因：

    timeline 将被移除。

计划于 2020-04-01 发布变更

  • 重大更改 Sponsorship.maintainer 将发生变更。
    说明：

    maintainer 将被移除。请使用 Sponsorship.sponsorable 代替。

    原因：

    Sponsorship.maintainer 将被移除。

计划于 2020-01-01 发布变更

  • 重大更改 UnassignedEvent.user 将发生变更。
    说明：

    user 将被移除。请使用 assignee 字段代替。

    原因：

    受让人现在可以是虚拟用户。

  • 重大更改 AssignedEvent.user 将发生变更。
    说明：

    user 将被移除。请使用 assignee 字段代替。

    原因：

    受让人现在可以是虚拟用户。

计划于 2019-04-01 发布变更

  • 重大更改 LegacyMigration.uploadUrlTemplate 将发生变更。
    说明：

    uploadUrlTemplate 将被移除。请使用 uploadUrl 代替。

    原因：

    uploadUrlTemplate 将被移除，因为它不是标准 URL 并且增加了额外的用户步骤。