重大变更

关于重大变更

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

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

我们努力为集成商提供稳定的 API。 当某项新功能还处于演进阶段时，我们将在架构预览模式下发布此功能。

我们将在更改 GraphQL 架构前至少三个月宣布即将发生的重大变更，以便给集成商预留进行必要调整的时间。 变更在季度第一天（1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日）生效。 例如，如果我们在 1 月 15 日宣布变更，将在 7 月 1 日执行。

安排在 2019-04-01 进行变更

• Breaking 将对 Migration.uploadUrlTemplate 进行变更。.

  描述：

  uploadUrlTemplate will be removed. Use uploadUrl instead.

  原因：

  uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

• Breaking 将对 Organization.members 进行变更。.

  描述：

  members will be removed. Use Organization.membersWithRole instead.

  原因：

  The members field is deprecated and will be removed soon.

安排在 2019-07-01 进行变更

• Breaking 将对 ContributionsCollection.firstIssueContribution.ignoreTimeRange 进行变更。.

  描述：

  ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back

  原因：

  ignore_time_range will be removed

• Breaking 将对 ContributionsCollection.firstPullRequestContribution.ignoreTimeRange 进行变更。.

  描述：

  ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back

  原因：

  ignore_time_range will be removed

• Breaking 将对 ContributionsCollection.firstRepositoryContribution.ignoreTimeRange 进行变更。.

  描述：

  ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back

  原因：

  ignore_time_range will be removed

• Breaking 将对 ContributionsCollection.joinedGitHubContribution.ignoreTimeRange 进行变更。.

  描述：

  ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back

  原因：

  ignore_time_range will be removed

• Breaking 将对 ReviewDismissedEvent.message 进行变更。.

  描述：

  message will be removed. Use dismissalMessage instead.

  原因：

  message is being removed because it not nullable, whereas the underlying field is optional.

• Breaking 将对 ReviewDismissedEvent.messageHtml 进行变更。.

  描述：

  messageHtml will be removed. Use dismissalMessageHTML instead.

  原因：

  messageHtml is being removed because it not nullable, whereas the underlying field is optional.

安排在 2019-10-01 进行变更

• Breaking 将对 ContributionOrder.field 进行变更。.

  描述：

  field will be removed. Only one order field is supported.

  原因：

  field will be removed.

• Breaking 将对 Issue.timeline 进行变更。.

  描述：

  timeline will be removed. Use Issue.timelineItems instead.

  原因：

  timeline will be removed

• Breaking 将对 Organization.pinnedRepositories 进行变更。.

  描述：

  pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

  原因：

  pinnedRepositories will be removed

• Breaking 将对 PullRequest.timeline 进行变更。.

  描述：

  timeline will be removed. Use PullRequest.timelineItems instead.

  原因：

  timeline will be removed

• Breaking 将对 RepositoryOwner.pinnedRepositories 进行变更。.

  描述：

  pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

  原因：

  pinnedRepositories will be removed

• Breaking 将对 User.pinnedRepositories 进行变更。.

  描述：

  pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

  原因：

  pinnedRepositories will be removed