我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

重大变更

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

本文内容

关于重大变更

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

  • 重大:会改变 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.

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

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

    描述:

    user will be removed. Use the assignee field instead.

    原因:

    Assignees can now be mannequins.

  • 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 将对 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 将对 UnassignedEvent.user 进行变更。.

    描述:

    user will be removed. Use the assignee field instead.

    原因:

    Assignees can now be mannequins.

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

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

    描述:

    maintainer will be removed. Use Sponsorship.sponsorable instead.

    原因:

    Sponsorship.maintainer will be removed.

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

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

    描述:

    isUnlicensed will be removed.

    原因:

    All pending members consume a license

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

  • 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.

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

    描述:

    timeline will be removed. Use Issue.timelineItems instead.

    原因:

    timeline will be removed

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

    描述:

    timeline will be removed. Use PullRequest.timelineItems instead.

    原因:

    timeline will be removed

  • Breaking 将对 RepositoryCollaboratorEdge.permission 进行变更。.

    描述:

    Type for permission will change from RepositoryPermission! to String.

    原因:

    This field may return additional values

  • Breaking 将对 RepositoryInvitation.permission 进行变更。.

    描述:

    Type for permission will change from RepositoryPermission! to String.

    原因:

    This field may return additional values

  • 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 将对 Sponsorship.sponsor 进行变更。.

    描述:

    sponsor will be removed. Use Sponsorship.sponsorEntity instead.

    原因:

    Sponsorship.sponsor will be removed.

  • Breaking 将对 TeamRepositoryEdge.permission 进行变更。.

    描述:

    Type for permission will change from RepositoryPermission! to String.

    原因:

    This field may return additional values

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

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

    描述:

    isUnlicensed will be removed.

    原因:

    All members consume a license

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

    描述:

    isUnlicensed will be removed.

    原因:

    All outside collaborators consume a license

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

    描述:

    isUnlicensed will be removed.

    原因:

    All pending collaborators consume a license

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。