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

破壊的変更

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

破壊的変更について

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

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

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

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

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

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

    説明:

    fieldWithSettingId will be removed. Use fieldConstraintId instead

    理由:

    Renamed to fieldConstraintId to improve naming consistency.

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

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

    説明:

    dependencyEcosystem will be removed. Use the ecosystem argument instead.

    理由:

    The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

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

    説明:

    userAccounts will be removed. Use the Enterprise.members field instead.

    理由:

    The Enterprise.userAccounts field is being removed.

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

    説明:

    branch will be removed.

    理由:

    PRs are added to the merge queue for the base branch, the branch argument is now a no-op

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

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

    説明:

    defaultMergeQueue will be removed. Use Repository.mergeQueue instead.

    理由:

    defaultMergeQueue will be removed.

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

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

    説明:

    users will be removed. Use the reactors field instead.

    理由:

    Reactors can now be mannequins, bots, and organizations.

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

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

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

    説明:

    DRAFT will be removed. Use PullRequest.isDraft instead.

    理由:

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

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

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

    説明:

    sponsor will be removed. Use Sponsorship.sponsorEntity instead.

    理由:

    Sponsorship.sponsor will be removed.

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

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

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

    説明:

    maintainer will be removed. Use Sponsorship.sponsorable instead.

    理由:

    Sponsorship.maintainer will be removed.

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

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

    説明:

    user will be removed. Use the assignee field instead.

    理由:

    Assignees can now be mannequins.

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

    説明:

    user will be removed. Use the assignee field instead.

    理由:

    Assignees can now be mannequins.

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

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