重大变更

关于重大变更

重大变更是指可能需要集成商采取行动的任何变更。 我们将这些变更分为两类：

• 重大：会改变 GraphQL API 的现有查询的变更。 例如，删除字段就是重大变更。
• 危险：不会改变现有查询，但会影响客户端运行时的行为的变更。 添加枚举值就是一个危险变更示例。

我们努力为集成商提供稳定的 API。 当某项新功能还处于演进阶段时，我们将在架构预览模式下发布此功能。

我们将在更改 GraphQL 架构前至少三个月宣布即将发生的重大变更，以便给集成商预留进行必要调整的时间。 变更在季度第一天（1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日）生效。 例如，如果我们在 1 月 15 日宣布变更，将在 7 月 1 日执行。

安排在 2020-10-01 进行变更

• Breaking 将对 PullRequest.timeline 进行变更。.

  描述：

  timeline will be removed. Use PullRequest.timelineItems instead.

  原因：

  timeline will be removed

• Breaking 将对 Issue.timeline 进行变更。.

  描述：

  timeline will be removed. Use Issue.timelineItems instead.

  原因：

  timeline will be removed

安排在 2020-04-01 进行变更

• Breaking 将对 User.registryPackagesForQuery 进行变更。.

  描述：

  registryPackagesForQuery will be removed. Use the PackageSearch object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 User.registryPackages 进行变更。.

  描述：

  registryPackages will be removed. Use the PackageOwner object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 Sponsorship.maintainer 进行变更。.

  描述：

  maintainer will be removed. Use Sponsorship.sponsorable instead.

  原因：

  Sponsorship.maintainer will be removed.

• Breaking 将对 Repository.registryPackagesForQuery 进行变更。.

  描述：

  registryPackagesForQuery will be removed. Use the PackageSearch object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 Repository.registryPackages 进行变更。.

  描述：

  registryPackages will be removed. Use the PackageOwner object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersionStatistics.downloadsTotalCount 进行变更。.

  描述：

  downloadsTotalCount will be removed. Use the PackageVersionStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersionStatistics.downloadsToday 进行变更。.

  描述：

  downloadsToday will be removed. Use the PackageVersionStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersionStatistics.downloadsThisYear 进行变更。.

  描述：

  downloadsThisYear will be removed. Use the PackageVersionStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersionStatistics.downloadsThisWeek 进行变更。.

  描述：

  downloadsThisWeek will be removed. Use the PackageVersionStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersionStatistics.downloadsThisMonth 进行变更。.

  描述：

  downloadsThisMonth will be removed. Use the PackageVersionStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.viewerCanEdit 进行变更。.

  描述：

  viewerCanEdit will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.version 进行变更。.

  描述：

  version will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.updatedAt 进行变更。.

  描述：

  updatedAt will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.summary 进行变更。.

  描述：

  summary will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.statistics 进行变更。.

  描述：

  statistics will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.size 进行变更。.

  描述：

  size will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.sha256 进行变更。.

  描述：

  sha256 will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.release 进行变更。.

  描述：

  release will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.registryPackage 进行变更。.

  描述：

  registryPackage will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.readmeHtml 进行变更。.

  描述：

  readmeHtml will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.readme 进行变更。.

  描述：

  readme will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.preRelease 进行变更。.

  描述：

  preRelease will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.platform 进行变更。.

  描述：

  platform will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.manifest 进行变更。.

  描述：

  manifest will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.installationCommand 进行变更。.

  描述：

  installationCommand will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.files 进行变更。.

  描述：

  files will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.fileByName 进行变更。.

  描述：

  fileByName will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.dependencies 进行变更。.

  描述：

  dependencies will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageVersion.deleted 进行变更。.

  描述：

  deleted will be removed. Use the PackageVersion object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageTag.version 进行变更。.

  描述：

  version will be removed. Use the PackageTag object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageTag.name 进行变更。.

  描述：

  name will be removed. Use the PackageTag object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageStatistics.downloadsTotalCount 进行变更。.

  描述：

  downloadsTotalCount will be removed. Use the PackageStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageStatistics.downloadsToday 进行变更。.

  描述：

  downloadsToday will be removed. Use the PackageStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageStatistics.downloadsThisYear 进行变更。.

  描述：

  downloadsThisYear will be removed. Use the PackageStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageStatistics.downloadsThisWeek 进行变更。.

  描述：

  downloadsThisWeek will be removed. Use the PackageStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageStatistics.downloadsThisMonth 进行变更。.

  描述：

  downloadsThisMonth will be removed. Use the PackageStatistics object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageSearch.registryPackagesForQuery 进行变更。.

  描述：

  registryPackagesForQuery will be removed. Use the PackageSearch object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageOwner.registryPackages 进行变更。.

  描述：

  registryPackages will be removed. Use the PackageOwner object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.url 进行变更。.

  描述：

  url will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.size 进行变更。.

  描述：

  size will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.sha256 进行变更。.

  描述：

  sha256 will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.sha1 进行变更。.

  描述：

  sha1 will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.packageVersion 进行变更。.

  描述：

  packageVersion will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.name 进行变更。.

  描述：

  name will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.metadataUrl 进行变更。.

  描述：

  metadataUrl will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.md5 进行变更。.

  描述：

  md5 will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageFile.guid 进行变更。.

  描述：

  guid will be removed. Use the PackageFile object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageDependency.version 进行变更。.

  描述：

  version will be removed. Use the PackageDependency object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageDependency.name 进行变更。.

  描述：

  name will be removed. Use the PackageDependency object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackageDependency.dependencyType 进行变更。.

  描述：

  dependencyType will be removed. Use the PackageDependency object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.versionsByMetadatum 进行变更。.

  描述：

  versionsByMetadatum will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.versions 进行变更。.

  描述：

  versions will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.versionBySha256 进行变更。.

  描述：

  versionBySha256 will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.versionByPlatform 进行变更。.

  描述：

  versionByPlatform will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.version 进行变更。.

  描述：

  version will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.topics 进行变更。.

  描述：

  topics will be removed. Use the Package object.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.tags 进行变更。.

  描述：

  tags will be removed. Use the Package object.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.statistics 进行变更。.

  描述：

  statistics will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.repository 进行变更。.

  描述：

  repository will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.registryPackageType 进行变更。.

  描述：

  registryPackageType will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.preReleaseVersions 进行变更。.

  描述：

  preReleaseVersions will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.packageType 进行变更。.

  描述：

  packageType will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.packageFileBySha256 进行变更。.

  描述：

  packageFileBySha256 will be removed. Use the Package object.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.packageFileByGuid 进行变更。.

  描述：

  packageFileByGuid will be removed. Use the Package object.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.nameWithOwner 进行变更。.

  描述：

  nameWithOwner will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.name 进行变更。.

  描述：

  name will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.latestVersion 进行变更。.

  描述：

  latestVersion will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 RegistryPackage.color 进行变更。.

  描述：

  color will be removed. Use the Package object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 Organization.registryPackagesForQuery 进行变更。.

  描述：

  registryPackagesForQuery will be removed. Use the PackageSearch object instead.

  原因：

  Renaming GitHub Packages fields and objects.

• Breaking 将对 Organization.registryPackages 进行变更。.

  描述：

  registryPackages will be removed. Use the PackageOwner object instead.

  原因：

  Renaming GitHub Packages fields and objects.

安排在 2020-01-01 进行变更

• Breaking 将对 UnassignedEvent.user 进行变更。.

  描述：

  user will be removed. Use the assignee field instead.

  原因：

  Assignees can now be mannequins.

• Breaking 将对 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

• Breaking 将对 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

• Breaking 将对 AssignedEvent.user 进行变更。.

  描述：

  user will be removed. Use the assignee field instead.

  原因：

  Assignees can now be mannequins.

安排在 2019-10-01 进行变更

• Breaking 将对 User.pinnedRepositories 进行变更。.

  描述：

  pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

  原因：

  pinnedRepositories will be removed

• Breaking 将对 RepositoryOwner.pinnedRepositories 进行变更。.

  描述：

  pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

  原因：

  pinnedRepositories will be removed

• Breaking 将对 Organization.pinnedRepositories 进行变更。.

  描述：

  pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

  原因：

  pinnedRepositories will be removed

• Breaking 将对 ContributionOrder.field 进行变更。.

  描述：

  field will be removed. Only one order field is supported.

  原因：

  field will be removed.

安排在 2019-04-01 进行变更

• Breaking 将对 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.