ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

破壊的変更

最近の、及び今後のGitHub GraphQL APIに対する破壊的変更について学んでください。

ここには以下の内容があります:

破壊的変更について

破壊的変更は、インテグレーターからのアクションが必要になるかもしれない変更です。 これらの変更は、2つに分類されます。

  • 破壊的: GraphQL APIに対する既存のクエリを損なう変更。 たとえば、フィールドの削除は破壊的変更です。
  • 危険: 既存のクエリを損なうことはないものの、クライアントの実行時の振る舞いに影響するかもしれない変更です。 enum値の追加は危険な変更の例です。

私たちは、インテグレーターに安定したAPIを提供するよう努めています。 新しい機能が進化を続けている場合、それはスキーマプレビューの背後でリリースしています。

今後の破壊的変更のアナウンスは、遅くてもGraphQLスキーマに対して変更を行う3ヶ月前にアナウンスを行い、インテグレーターに必要な調整を行う時間を提供します。 変更は、四半期の初日(1月1日、4月1日、7月1日、10月1日)に適用されます。 たとえば、変更を1月115日にアナウンスした場合、その変更は7月1日に行われます。

2019-04-01にスケジュールされた変更

  • 破壊的変更が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にスケジュールされた変更

  • 破壊的変更がAssignedEvent.userに対して行われます。

    説明:

    user will be removed. Use the assignee field instead.

    理由:

    Assignees can now be mannequins.

  • 破壊的変更が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

  • 破壊的変更が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

  • 破壊的変更がUnassignedEvent.userに対して行われます。

    説明:

    user will be removed. Use the assignee field instead.

    理由:

    Assignees can now be mannequins.

2020-04-01にスケジュールされた変更

  • 破壊的変更がQuery.sponsorsListingに対して行われます。

    説明:

    sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead.

    理由:

    Query.sponsorsListing will be removed.

  • 破壊的変更がSponsorship.maintainerに対して行われます。

    説明:

    maintainer will be removed. Use Sponsorship.sponsorable instead.

    理由:

    Sponsorship.maintainer will be removed.

2020-07-01にスケジュールされた変更

  • 破壊的変更がEnterprisePendingMemberInvitationEdge.isUnlicensedに対して行われます。

    説明:

    isUnlicensed will be removed.

    理由:

    All pending members consume a license

2020-10-01にスケジュールされた変更

  • 破壊的変更がEnterpriseOwnerInfo.pendingCollaboratorsに対して行われます。

    説明:

    pendingCollaborators will be removed. Use the pendingCollaboratorInvitations field instead.

    理由:

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

  • 破壊的変更がIssue.timelineに対して行われます。

    説明:

    timeline will be removed. Use Issue.timelineItems instead.

    理由:

    timeline will be removed

  • 破壊的変更がPullRequest.timelineに対して行われます。

    説明:

    timeline will be removed. Use PullRequest.timelineItems instead.

    理由:

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

  • 破壊的変更がSponsorship.sponsorに対して行われます。

    説明:

    sponsor will be removed. Use Sponsorship.sponsorEntity instead.

    理由:

    Sponsorship.sponsor will be removed.

2021-01-01にスケジュールされた変更

  • 破壊的変更がEnterpriseMemberEdge.isUnlicensedに対して行われます。

    説明:

    isUnlicensed will be removed.

    理由:

    All members consume a license

  • 破壊的変更がEnterpriseOutsideCollaboratorEdge.isUnlicensedに対して行われます。

    説明:

    isUnlicensed will be removed.

    理由:

    All outside collaborators consume a license

  • 破壊的変更がEnterprisePendingCollaboratorEdge.isUnlicensedに対して行われます。

    説明:

    isUnlicensed will be removed.

    理由:

    All pending collaborators consume a license

  • 破壊的変更がMergeStateStatus.DRAFTに対して行われます。

    説明:

    DRAFT will be removed. Use PullRequest.isDraft instead.

    理由:

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

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.