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

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2021-03-02. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

破壊的変更

最近の、及び今後の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.

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

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

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

    説明:

    registryPackages will be removed. Use the PackageOwner object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackagesForQuery will be removed. Use the PackageSearch object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    color will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    latestVersion will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    name will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    nameWithOwner will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    packageFileByGuid will be removed. Use the Package object.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    packageFileBySha256 will be removed. Use the Package object.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    packageType will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    preReleaseVersions will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackageType will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    repository will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    statistics will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    tags will be removed. Use the Package object.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    topics will be removed. Use the Package object.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    version will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    versionByPlatform will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    versionBySha256 will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    versions will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    versionsByMetadatum will be removed. Use the Package object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    dependencyType will be removed. Use the PackageDependency object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    name will be removed. Use the PackageDependency object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    version will be removed. Use the PackageDependency object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    guid will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    md5 will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    metadataUrl will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    name will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    packageVersion will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    sha1 will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    sha256 will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    size will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    url will be removed. Use the PackageFile object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackages will be removed. Use the PackageOwner object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackagesForQuery will be removed. Use the PackageSearch object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsThisMonth will be removed. Use the PackageStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsThisWeek will be removed. Use the PackageStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsThisYear will be removed. Use the PackageStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsToday will be removed. Use the PackageStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsTotalCount will be removed. Use the PackageStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    name will be removed. Use the PackageTag object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    version will be removed. Use the PackageTag object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    dependencies will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    fileByName will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    files will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    installationCommand will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    manifest will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    platform will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    preRelease will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    readme will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    readmeHtml will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackage will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    release will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    sha256 will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    size will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    statistics will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    summary will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    updatedAt will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    version will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    viewerCanEdit will be removed. Use the PackageVersion object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsThisMonth will be removed. Use the PackageVersionStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsThisWeek will be removed. Use the PackageVersionStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsThisYear will be removed. Use the PackageVersionStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsToday will be removed. Use the PackageVersionStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    downloadsTotalCount will be removed. Use the PackageVersionStatistics object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackages will be removed. Use the PackageOwner object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackagesForQuery will be removed. Use the PackageSearch object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    maintainer will be removed. Use Sponsorship.sponsorable instead.

    理由:

    Sponsorship.maintainer will be removed.

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

    説明:

    registryPackages will be removed. Use the PackageOwner object instead.

    理由:

    Renaming GitHub Packages fields and objects.

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

    説明:

    registryPackagesForQuery will be removed. Use the PackageSearch object instead.

    理由:

    Renaming GitHub Packages fields and objects.