跳至主要内容

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

关于重大变更

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

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

我们将在对 GraphQL 架构进行变更之前至少三个月宣布即将发生的重大变更,以便集成商有时间进行必要的调整。变更将在一个季度的第一天生效(1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日)。例如,如果我们在 1 月 15 日宣布变更,则该变更将在 7 月 1 日生效。

计划于 2024-07-01 进行的变更

  • 重大变更 将对 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 将被移除。请使用 linestartLine 字段代替,它们代表文件行号而不是 diff 行号。

    原因:

    我们正在逐步淘汰针对 PR 评论的 diff 相对定位。

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

    originalPosition 将被移除。

    原因:

    我们正在逐步淘汰针对 PR 评论的 diff 相对定位。

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

    comments 将被移除。请使用 threads 参数代替。

    原因:

    我们正在弃用使用 diff 相对定位的评论字段。

  • 重大变更 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 将被移除。请使用 addPullRequestReviewThreadaddPullRequestReviewThreadReply 代替。

    原因:

    我们正在弃用 addPullRequestReviewComment 变异。

  • 重大变更 将对 AddPullRequestReviewCommentInput.body 进行更改。
    描述:

    body 将被移除。请使用 addPullRequestReviewThreadaddPullRequestReviewThreadReply 代替。

    原因:

    我们正在弃用 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 并且会增加额外的用户步骤。