破壊的変更について
破壊的変更は、インテグレーターからのアクションが必要になるかもしれない変更です。 これらの変更は、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. UseuploadUrl
instead.理由:
uploadUrlTemplate
is being removed because it is not a standard URL and adds an extra user step.
- 破壊的変更が
Organization.members
に対して行われます。説明:
members
will be removed. UseOrganization.membersWithRole
instead.理由:
The
members
field is deprecated and will be removed soon.
2019-07-01にスケジュールされた変更
- 破壊的変更が
ContributionsCollection.firstIssueContribution.ignoreTimeRange
に対して行われます。説明:
ignoreTimeRange
will be removed. Use aContributionsCollection
starting sufficiently far back理由:
ignore_time_range will be removed
- 破壊的変更が
ContributionsCollection.firstPullRequestContribution.ignoreTimeRange
に対して行われます。説明:
ignoreTimeRange
will be removed. Use aContributionsCollection
starting sufficiently far back理由:
ignore_time_range will be removed
- 破壊的変更が
ContributionsCollection.firstRepositoryContribution.ignoreTimeRange
に対して行われます。説明:
ignoreTimeRange
will be removed. Use aContributionsCollection
starting sufficiently far back理由:
ignore_time_range will be removed
- 破壊的変更が
ContributionsCollection.joinedGitHubContribution.ignoreTimeRange
に対して行われます。説明:
ignoreTimeRange
will be removed. Use aContributionsCollection
starting sufficiently far back理由:
ignore_time_range will be removed
- 破壊的変更が
ReviewDismissedEvent.message
に対して行われます。説明:
message
will be removed. UsedismissalMessage
instead.理由:
message
is being removed because it not nullable, whereas the underlying field is optional.
- 破壊的変更が
ReviewDismissedEvent.messageHtml
に対して行われます。説明:
messageHtml
will be removed. UsedismissalMessageHTML
instead.理由:
messageHtml
is being removed because it not nullable, whereas the underlying field is optional.
2019-10-01にスケジュールされた変更
- 破壊的変更が
ContributionOrder.field
に対して行われます。説明:
field
will be removed. Only one order field is supported.理由:
field
will be removed.
- 破壊的変更が
Issue.timeline
に対して行われます。説明:
timeline
will be removed. Use Issue.timelineItems instead.理由:
timeline
will be removed
- 破壊的変更が
Organization.pinnedRepositories
に対して行われます。説明:
pinnedRepositories
will be removed. Use ProfileOwner.pinnedItems instead.理由:
pinnedRepositories will be removed
- 破壊的変更が
PullRequest.timeline
に対して行われます。説明:
timeline
will be removed. Use PullRequest.timelineItems instead.理由:
timeline
will be removed
- 破壊的変更が
RepositoryOwner.pinnedRepositories
に対して行われます。説明:
pinnedRepositories
will be removed. Use ProfileOwner.pinnedItems instead.理由:
pinnedRepositories will be removed
- 破壊的変更が
User.pinnedRepositories
に対して行われます。説明:
pinnedRepositories
will be removed. Use ProfileOwner.pinnedItems instead.理由:
pinnedRepositories will be removed