重大变更

关于重大变更

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

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

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

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

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

• Breaking 将对 ReactionGroup.users 进行变更。.

  描述：

  users will be removed. Use the reactors field instead.

  原因：

  Reactors can now be mannequins, bots, and organizations.

安排在 2021-06-21 进行变更

• Breaking 将对 PackageType.DOCKER 进行变更。.

  描述：

  DOCKER will be removed.

  原因：

  DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

安排在 2021-01-01 进行变更

• Breaking 将对 MergeStateStatus.DRAFT 进行变更。.

  描述：

  DRAFT will be removed. Use PullRequest.isDraft instead.

  原因：

  DRAFT state will be removed from this enum and isDraft should be used instead

• Breaking 将对 EnterprisePendingCollaboratorEdge.isUnlicensed 进行变更。.

  描述：

  isUnlicensed will be removed.

  原因：

  All pending collaborators consume a license

• Breaking 将对 EnterpriseOutsideCollaboratorEdge.isUnlicensed 进行变更。.

  描述：

  isUnlicensed will be removed.

  原因：

  All outside collaborators consume a license

• Breaking 将对 EnterpriseMemberEdge.isUnlicensed 进行变更。.

  描述：

  isUnlicensed will be removed.

  原因：

  All members consume a license

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

• Breaking 将对 Sponsorship.sponsor 进行变更。.

  描述：

  sponsor will be removed. Use Sponsorship.sponsorEntity instead.

  原因：

  Sponsorship.sponsor will be removed.

• Breaking 将对 RepositoryInvitationOrderField.INVITEE_LOGIN 进行变更。.

  描述：

  INVITEE_LOGIN will be removed.

  原因：

  INVITEE_LOGIN is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.

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

  描述：

  timeline will be removed. Use PullRequest.timelineItems instead.

  原因：

  timeline will be removed

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

  描述：

  timeline will be removed. Use Issue.timelineItems instead.

  原因：

  timeline will be removed

• Breaking 将对 EnterpriseOwnerInfo.pendingCollaborators 进行变更。.

  描述：

  pendingCollaborators will be removed. Use the pendingCollaboratorInvitations field instead.

  原因：

  Repository invitations can now be associated with an email, not only an invitee.

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

• Breaking 将对 EnterprisePendingMemberInvitationEdge.isUnlicensed 进行变更。.

  描述：

  isUnlicensed will be removed.

  原因：

  All pending members consume a license

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

• Breaking 将对 Sponsorship.maintainer 进行变更。.

  描述：

  maintainer will be removed. Use Sponsorship.sponsorable instead.

  原因：

  Sponsorship.maintainer will be removed.

• Breaking 将对 Query.sponsorsListing 进行变更。.

  描述：

  sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead.

  原因：

  Query.sponsorsListing will be removed.

安排在 2020-01-01 进行变更

• Breaking 将对 UnassignedEvent.user 进行变更。.

  描述：

  user will be removed. Use the assignee field instead.

  原因：

  Assignees can now be mannequins.

• Breaking 将对 EnterpriseBillingInfo.seats 进行变更。.

  描述：

  seats will be removed. Use EnterpriseBillingInfo.totalLicenses instead.

  原因：

  seats will be replaced with totalLicenses to provide more clarity on the value being returned

• Breaking 将对 EnterpriseBillingInfo.availableSeats 进行变更。.

  描述：

  availableSeats will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.

  原因：

  availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned

• Breaking 将对 AssignedEvent.user 进行变更。.

  描述：

  user will be removed. Use the assignee field instead.

  原因：

  Assignees can now be mannequins.

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

• Breaking 将对 LegacyMigration.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.