关于重大变更
重大变更是指可能需要集成商采取行动的任何变更。 我们将这些变更分为两类:
- 重大:会改变 GraphQL API 的现有查询的变更。 例如,� 除字段就是重大变更。
- 危险:不会改变现有查询,但会影响客户端运行时的行为的变更。 添� 枚举值就是一个危险变更示例。
我们努力为集成商提供稳定的 API。 当某项新功能还处于演进阶段时,我们将在架构预览模式下发布此功能。
我们将在更改 GraphQL 架构前至少三个月宣布即将发生的重大变更,以便给集成商预留进行必要调整的时间。 变更在季度第一天(1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日)生效。 例如,如果我们在 1 月 15 日宣布变更,将在 7 月 1 日执行。
安排在 2021-01-01 进行变更
- Breaking 将对
MergeStateStatus.DRAFT进行变更。.描述:
DRAFTwill be removed. Use PullRequest.isDraft instead.原� :
DRAFT state will be removed from this enum and
isDraftshould be used instead
- Breaking 将对
EnterprisePendingCollaboratorEdge.isUnlicensed进行变更。.描述:
isUnlicensedwill be removed.原� :
All pending collaborators consume a license
- Breaking 将对
EnterpriseOutsideCollaboratorEdge.isUnlicensed进行变更。.描述:
isUnlicensedwill be removed.原� :
All outside collaborators consume a license
- Breaking 将对
EnterpriseMemberEdge.isUnlicensed进行变更。.描述:
isUnlicensedwill be removed.原� :
All members consume a license
安排在 2020-10-01 进行变更
- Breaking 将对
Sponsorship.sponsor进行变更。.描述:
sponsorwill be removed. UseSponsorship.sponsorEntityinstead.原� :
Sponsorship.sponsorwill be removed.
- Breaking 将对
RepositoryInvitationOrderField.INVITEE_LOGIN进行变更。.描述:
INVITEE_LOGINwill be removed.原� :
INVITEE_LOGINis no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.
- Breaking 将对
PullRequest.timeline进行变更。.描述:
timelinewill be removed. Use PullRequest.timelineItems instead.原� :
timelinewill be removed
- Breaking 将对
Issue.timeline进行变更。.描述:
timelinewill be removed. Use Issue.timelineItems instead.原� :
timelinewill be removed
- Breaking 将对
EnterpriseOwnerInfo.pendingCollaborators进行变更。.描述:
pendingCollaboratorswill be removed. Use thependingCollaboratorInvitationsfield instead.原� :
Repository invitations can now be associated with an email, not only an invitee.
安排在 2020-07-01 进行变更
- Breaking 将对
EnterprisePendingMemberInvitationEdge.isUnlicensed进行变更。.描述:
isUnlicensedwill be removed.原� :
All pending members consume a license
安排在 2020-04-01 进行变更
- Breaking 将对
Sponsorship.maintainer进行变更。.描述:
maintainerwill be removed. UseSponsorship.sponsorableinstead.原� :
Sponsorship.maintainerwill be removed.
安排在 2020-01-01 进行变更
- Breaking 将对
UnassignedEvent.user进行变更。.描述:
userwill be removed. Use theassigneefield instead.原� :
Assignees can now be mannequins.
- Breaking 将对
EnterpriseBillingInfo.seats进行变更。.描述:
seatswill be removed. Use EnterpriseBillingInfo.totalLicenses instead.原� :
seatswill be replaced withtotalLicensesto provide more clarity on the value being returned
- Breaking 将对
EnterpriseBillingInfo.availableSeats进行变更。.描述:
availableSeatswill be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.原� :
availableSeatswill be replaced withtotalAvailableLicensesto provide more clarity on the value being returned
- Breaking 将对
AssignedEvent.user进行变更。.描述:
userwill be removed. Use theassigneefield instead.原� :
Assignees can now be mannequins.
安排在 2019-04-01 进行变更
- Breaking 将对
LegacyMigration.uploadUrlTemplate进行变更。.描述:
uploadUrlTemplatewill be removed. UseuploadUrlinstead.原� :
uploadUrlTemplateis being removed because it is not a standard URL and adds an extra user step.