破壊的変更について
破壊的変更は、インテグレーターからのアクションが必要になるかもしれない変更です。 これらの変更は、2つに分類されます。
- 破壊的: GraphQL APIに対する既存のクエリを損なう変更。 たとえば、フィールドの削除は破壊的変更です。
- 危険: 既存のクエリを損なうことはないものの、クライアントの実行時の振る舞いに影響するかもしれない変更です。 enum値の追加は危険な変更の例です。
私たちは、インテグレーターに安定したAPIを提供するよう努めています。 新しい機能が進化を続けている場合、それはスキーマプレビューの背後でリリースしています。
今後の破壊的変更のアナウンスは、遅くてもGraphQLスキーマに対して変更を行う3ヶ月前にアナウンスを行い、インテグレーターに必要な調整を行う時間を提供します。 変更は、四半期の初日(1月1日、4月1日、7月1日、10月1日)に適用されます。 たとえば、変更を1月115日にアナウンスした場合、その変更は7月1日に行われます。
2021-01-01にスケジュールされた変更
- 破壊的変更が
EnterprisePendingCollaboratorEdge.isUnlicensed
に対して行われます。説明:
isUnlicensed
will be removed.理由:
All pending collaborators consume a license
- 破壊的変更が
EnterpriseOutsideCollaboratorEdge.isUnlicensed
に対して行われます。説明:
isUnlicensed
will be removed.理由:
All outside collaborators consume a license
- 破壊的変更が
EnterpriseMemberEdge.isUnlicensed
に対して行われます。説明:
isUnlicensed
will be removed.理由:
All members consume a license
2020-10-01にスケジュールされた変更
- 破壊的変更が
TeamRepositoryEdge.permission
に対して行われます。説明:
Type for
permission
will change fromRepositoryPermission!
toString
.理由:
This field may return additional values
- 破壊的変更が
Sponsorship.sponsor
に対して行われます。説明:
sponsor
will be removed. UseSponsorship.sponsorEntity
instead.理由:
Sponsorship.sponsor
will be removed.
- 破壊的変更が
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.
- 破壊的変更が
RepositoryInvitation.permission
に対して行われます。説明:
Type for
permission
will change fromRepositoryPermission!
toString
.理由:
This field may return additional values
- 破壊的変更が
RepositoryCollaboratorEdge.permission
に対して行われます。説明:
Type for
permission
will change fromRepositoryPermission!
toString
.理由:
This field may return additional values
- 破壊的変更が
PullRequest.timeline
に対して行われます。説明:
timeline
will be removed. Use PullRequest.timelineItems instead.理由:
timeline
will be removed
- 破壊的変更が
Issue.timeline
に対して行われます。説明:
timeline
will be removed. Use Issue.timelineItems instead.理由:
timeline
will be removed
- 破壊的変更が
EnterpriseOwnerInfo.pendingCollaborators
に対して行われます。説明:
pendingCollaborators
will be removed. Use thependingCollaboratorInvitations
field instead.理由:
Repository invitations can now be associated with an email, not only an invitee.
2020-07-01にスケジュールされた変更
- 破壊的変更が
EnterprisePendingMemberInvitationEdge.isUnlicensed
に対して行われます。説明:
isUnlicensed
will be removed.理由:
All pending members consume a license
2020-04-01にスケジュールされた変更
- 破壊的変更が
Sponsorship.maintainer
に対して行われます。説明:
maintainer
will be removed. UseSponsorship.sponsorable
instead.理由:
Sponsorship.maintainer
will be removed.
2020-01-01にスケジュールされた変更
- 破壊的変更が
UnassignedEvent.user
に対して行われます。説明:
user
will be removed. Use theassignee
field instead.理由:
Assignees can now be mannequins.
- 破壊的変更が
EnterpriseBillingInfo.seats
に対して行われます。説明:
seats
will be removed. Use EnterpriseBillingInfo.totalLicenses instead.理由:
seats
will be replaced withtotalLicenses
to provide more clarity on the value being returned
- 破壊的変更が
EnterpriseBillingInfo.availableSeats
に対して行われます。説明:
availableSeats
will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.理由:
availableSeats
will be replaced withtotalAvailableLicenses
to provide more clarity on the value being returned
- 破壊的変更が
AssignedEvent.user
に対して行われます。説明:
user
will be removed. Use theassignee
field instead.理由:
Assignees can now be mannequins.
2019-04-01にスケジュールされた変更
- 破壊的変更が
Migration.uploadUrlTemplate
に対して行われます。説明:
uploadUrlTemplate
will be removed. UseuploadUrl
instead.理由:
uploadUrlTemplate
is being removed because it is not a standard URL and adds an extra user step.