破壊的変更について
破壊的変更は、インテグレーターからのアクションが必要になるかもしれない変更です。 これらの変更は、2つに分類されます。
- 破壊的: GraphQL APIに対する既存のクエリを損なう変更。 たとえば、フィールドの削除は破壊的変更です。
- 危険: 既存のクエリを損なうことはないものの、クライアントの実行時の振る舞いに影響するかもしれない変更です。 enum値の追加は危険な変更の例です。
私たちは、インテグレーターに安定したAPIを提供するよう努めています。 新しい機能が進化を続けている場合、それはスキーマプレビューの背後でリリースしています。
今後の破壊的変更のアナウンスは、遅くてもGraphQLスキーマに対して変更を行う3ヶ月前にアナウンスを行い、インテグレーターに必要な調整を行う時間を提供します。 変更は、四半期の初日(1月1日、4月1日、7月1日、10月1日)に適用されます。 たとえば、変更を1月115日にアナウンスした場合、その変更は7月1日に行われます。
2020-10-01にスケジュールされた変更
- 破壊的変更が
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にスケジュールされた変更
- 破壊的変更が
User.registryPackagesForQuery
に対して行われます。説明:
registryPackagesForQuery
will be removed. Use thePackageSearch
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
User.registryPackages
に対して行われます。説明:
registryPackages
will be removed. Use thePackageOwner
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
Sponsorship.maintainer
に対して行われます。説明:
maintainer
will be removed. UseSponsorship.sponsorable
instead.理由:
Sponsorship.maintainer
will be removed.
- 破壊的変更が
Repository.registryPackagesForQuery
に対して行われます。説明:
registryPackagesForQuery
will be removed. Use thePackageSearch
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
Repository.registryPackages
に対して行われます。説明:
registryPackages
will be removed. Use thePackageOwner
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersionStatistics.downloadsTotalCount
に対して行われます。説明:
downloadsTotalCount
will be removed. Use thePackageVersionStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersionStatistics.downloadsToday
に対して行われます。説明:
downloadsToday
will be removed. Use thePackageVersionStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersionStatistics.downloadsThisYear
に対して行われます。説明:
downloadsThisYear
will be removed. Use thePackageVersionStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersionStatistics.downloadsThisWeek
に対して行われます。説明:
downloadsThisWeek
will be removed. Use thePackageVersionStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersionStatistics.downloadsThisMonth
に対して行われます。説明:
downloadsThisMonth
will be removed. Use thePackageVersionStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.viewerCanEdit
に対して行われます。説明:
viewerCanEdit
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.version
に対して行われます。説明:
version
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.updatedAt
に対して行われます。説明:
updatedAt
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.summary
に対して行われます。説明:
summary
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.statistics
に対して行われます。説明:
statistics
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.size
に対して行われます。説明:
size
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.sha256
に対して行われます。説明:
sha256
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.release
に対して行われます。説明:
release
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.registryPackage
に対して行われます。説明:
registryPackage
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.readmeHtml
に対して行われます。説明:
readmeHtml
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.readme
に対して行われます。説明:
readme
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.preRelease
に対して行われます。説明:
preRelease
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.platform
に対して行われます。説明:
platform
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.manifest
に対して行われます。説明:
manifest
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.installationCommand
に対して行われます。説明:
installationCommand
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.files
に対して行われます。説明:
files
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.fileByName
に対して行われます。説明:
fileByName
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.dependencies
に対して行われます。説明:
dependencies
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageVersion.deleted
に対して行われます。説明:
deleted
will be removed. Use thePackageVersion
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageTag.version
に対して行われます。説明:
version
will be removed. Use thePackageTag
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageTag.name
に対して行われます。説明:
name
will be removed. Use thePackageTag
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageStatistics.downloadsTotalCount
に対して行われます。説明:
downloadsTotalCount
will be removed. Use thePackageStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageStatistics.downloadsToday
に対して行われます。説明:
downloadsToday
will be removed. Use thePackageStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageStatistics.downloadsThisYear
に対して行われます。説明:
downloadsThisYear
will be removed. Use thePackageStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageStatistics.downloadsThisWeek
に対して行われます。説明:
downloadsThisWeek
will be removed. Use thePackageStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageStatistics.downloadsThisMonth
に対して行われます。説明:
downloadsThisMonth
will be removed. Use thePackageStatistics
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageSearch.registryPackagesForQuery
に対して行われます。説明:
registryPackagesForQuery
will be removed. Use thePackageSearch
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageOwner.registryPackages
に対して行われます。説明:
registryPackages
will be removed. Use thePackageOwner
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.url
に対して行われます。説明:
url
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.size
に対して行われます。説明:
size
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.sha256
に対して行われます。説明:
sha256
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.sha1
に対して行われます。説明:
sha1
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.packageVersion
に対して行われます。説明:
packageVersion
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.name
に対して行われます。説明:
name
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.metadataUrl
に対して行われます。説明:
metadataUrl
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.md5
に対して行われます。説明:
md5
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageFile.guid
に対して行われます。説明:
guid
will be removed. Use thePackageFile
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageDependency.version
に対して行われます。説明:
version
will be removed. Use thePackageDependency
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageDependency.name
に対して行われます。説明:
name
will be removed. Use thePackageDependency
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackageDependency.dependencyType
に対して行われます。説明:
dependencyType
will be removed. Use thePackageDependency
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.versionsByMetadatum
に対して行われます。説明:
versionsByMetadatum
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.versions
に対して行われます。説明:
versions
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.versionBySha256
に対して行われます。説明:
versionBySha256
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.versionByPlatform
に対して行われます。説明:
versionByPlatform
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.version
に対して行われます。説明:
version
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.topics
に対して行われます。説明:
topics
will be removed. Use thePackage
object.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.tags
に対して行われます。説明:
tags
will be removed. Use thePackage
object.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.statistics
に対して行われます。説明:
statistics
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.repository
に対して行われます。説明:
repository
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.registryPackageType
に対して行われます。説明:
registryPackageType
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.preReleaseVersions
に対して行われます。説明:
preReleaseVersions
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.packageType
に対して行われます。説明:
packageType
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.packageFileBySha256
に対して行われます。説明:
packageFileBySha256
will be removed. Use thePackage
object.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.packageFileByGuid
に対して行われます。説明:
packageFileByGuid
will be removed. Use thePackage
object.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.nameWithOwner
に対して行われます。説明:
nameWithOwner
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.name
に対して行われます。説明:
name
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.latestVersion
に対して行われます。説明:
latestVersion
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
RegistryPackage.color
に対して行われます。説明:
color
will be removed. Use thePackage
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
Organization.registryPackagesForQuery
に対して行われます。説明:
registryPackagesForQuery
will be removed. Use thePackageSearch
object instead.理由:
Renaming GitHub Packages fields and objects.
- 破壊的変更が
Organization.registryPackages
に対して行われます。説明:
registryPackages
will be removed. Use thePackageOwner
object instead.理由:
Renaming GitHub Packages fields and objects.
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-10-01にスケジュールされた変更
- 破壊的変更が
User.pinnedRepositories
に対して行われます。説明:
pinnedRepositories
will be removed. Use ProfileOwner.pinnedItems instead.理由:
pinnedRepositories will be removed
- 破壊的変更が
RepositoryOwner.pinnedRepositories
に対して行われます。説明:
pinnedRepositories
will be removed. Use ProfileOwner.pinnedItems instead.理由:
pinnedRepositories will be removed
- 破壊的変更が
Organization.pinnedRepositories
に対して行われます。説明:
pinnedRepositories
will be removed. Use ProfileOwner.pinnedItems instead.理由:
pinnedRepositories will be removed
- 破壊的変更が
ContributionOrder.field
に対して行われます。説明:
field
will be removed. Only one order field is supported.理由:
field
will be removed.
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.