GraphQL API Schema Changes

The GraphQL schema change log is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes, schema previews, and upcoming breaking changes.

Breaking changes include changes that will break existing queries or could affect the runtime behavior of clients. For a list of breaking changes and when they will occur, see our breaking changes log.

GraphQL Schema Changes for 2019-12-05

The GraphQL schema includes these changes:

  • Field createdAt was added to object type SponsorsListing

GraphQL Schema Changes for 2019-11-25

  • November 25, 2019
  • Avatar for hubot hubot

The following changes will be made to the schema:

  • On member Organization.registryPackages: registryPackages will be removed. Use the PackageOwner object instead. Effective 2020-04-01.
  • On member Organization.registryPackagesForQuery: registryPackagesForQuery will be removed. Use the PackageSearch object instead. Effective 2020-04-01.
  • On member RegistryPackage.color: color will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.latestVersion: latestVersion will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.name: name will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.nameWithOwner: nameWithOwner will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.packageFileByGuid: packageFileByGuid will be removed. Use the Package object. Effective 2020-04-01.
  • On member RegistryPackage.packageFileBySha256: packageFileBySha256 will be removed. Use the Package object. Effective 2020-04-01.
  • On member RegistryPackage.packageType: packageType will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.preReleaseVersions: preReleaseVersions will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.registryPackageType: registryPackageType will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.repository: repository will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.statistics: statistics will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.tags: tags will be removed. Use the Package object. Effective 2020-04-01.
  • On member RegistryPackage.topics: topics will be removed. Use the Package object. Effective 2020-04-01.
  • On member RegistryPackage.version: version will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.versionByPlatform: versionByPlatform will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.versionBySha256: versionBySha256 will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.versions: versions will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackage.versionsByMetadatum: versionsByMetadatum will be removed. Use the Package object instead. Effective 2020-04-01.
  • On member RegistryPackageDependency.dependencyType: dependencyType will be removed. Use the PackageDependency object instead. Effective 2020-04-01.
  • On member RegistryPackageDependency.name: name will be removed. Use the PackageDependency object instead. Effective 2020-04-01.
  • On member RegistryPackageDependency.version: version will be removed. Use the PackageDependency object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.guid: guid will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.md5: md5 will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.metadataUrl: metadataUrl will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.name: name will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.packageVersion: packageVersion will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.sha1: sha1 will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.sha256: sha256 will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.size: size will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageFile.url: url will be removed. Use the PackageFile object instead. Effective 2020-04-01.
  • On member RegistryPackageOwner.registryPackages: registryPackages will be removed. Use the PackageOwner object instead. Effective 2020-04-01.
  • On member RegistryPackageSearch.registryPackagesForQuery: registryPackagesForQuery will be removed. Use the PackageSearch object instead. Effective 2020-04-01.
  • On member RegistryPackageStatistics.downloadsThisMonth: downloadsThisMonth will be removed. Use the PackageStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageStatistics.downloadsThisWeek: downloadsThisWeek will be removed. Use the PackageStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageStatistics.downloadsThisYear: downloadsThisYear will be removed. Use the PackageStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageStatistics.downloadsToday: downloadsToday will be removed. Use the PackageStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageStatistics.downloadsTotalCount: downloadsTotalCount will be removed. Use the PackageStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageTag.name: name will be removed. Use the PackageTag object instead. Effective 2020-04-01.
  • On member RegistryPackageTag.version: version will be removed. Use the PackageTag object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.deleted: deleted will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.dependencies: dependencies will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.fileByName: fileByName will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.files: files will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.installationCommand: installationCommand will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.manifest: manifest will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.platform: platform will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.preRelease: preRelease will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.readme: readme will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.readmeHtml: readmeHtml will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.registryPackage: registryPackage will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.release: release will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.sha256: sha256 will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.size: size will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.statistics: statistics will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.summary: summary will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.updatedAt: updatedAt will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.version: version will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersion.viewerCanEdit: viewerCanEdit will be removed. Use the PackageVersion object instead. Effective 2020-04-01.
  • On member RegistryPackageVersionStatistics.downloadsThisMonth: downloadsThisMonth will be removed. Use the PackageVersionStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageVersionStatistics.downloadsThisWeek: downloadsThisWeek will be removed. Use the PackageVersionStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageVersionStatistics.downloadsThisYear: downloadsThisYear will be removed. Use the PackageVersionStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageVersionStatistics.downloadsToday: downloadsToday will be removed. Use the PackageVersionStatistics object instead. Effective 2020-04-01.
  • On member RegistryPackageVersionStatistics.downloadsTotalCount: downloadsTotalCount will be removed. Use the PackageVersionStatistics object instead. Effective 2020-04-01.
  • On member Repository.registryPackages: registryPackages will be removed. Use the PackageOwner object instead. Effective 2020-04-01.
  • On member Repository.registryPackagesForQuery: registryPackagesForQuery will be removed. Use the PackageSearch object instead. Effective 2020-04-01.
  • On member User.registryPackages: registryPackages will be removed. Use the PackageOwner object instead. Effective 2020-04-01.
  • On member User.registryPackagesForQuery: registryPackagesForQuery will be removed. Use the PackageSearch object instead. Effective 2020-04-01.

The GitHub Packages preview includes these changes:

  • Field statistics was added to object type PackageVersion
  • Field statistics was added to object type Package
  • Type PackageStatistics was added
  • Type PackageVersionStatistics was added

GraphQL Schema Changes for 2019-11-22

  • November 22, 2019
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Field unarchiveRepository was added to object type Mutation
  • Field archiveRepository was added to object type Mutation
  • Field fundingLinks was added to object type Repository
  • Type UpdateTeamReviewAssignmentPayload was added
  • Type UnarchiveRepositoryInput was added
  • Type UnarchiveRepositoryPayload was added
  • Type ArchiveRepositoryInput was added
  • Type ArchiveRepositoryPayload was added
  • Type FundingPlatform was added
  • Type FundingLink was added

The Team Review Assignments Preview preview includes these changes:

  • Field updateTeamReviewAssignment was added to object type Mutation
  • Field reviewRequestDelegationNotifyTeam was added to object type Team
  • Field reviewRequestDelegationMemberCount was added to object type Team
  • Field reviewRequestDelegationEnabled was added to object type Team
  • Field reviewRequestDelegationAlgorithm was added to object type Team
  • Type UpdateTeamReviewAssignmentInput was added
  • Type TeamReviewAssignmentAlgorithm was added

GraphQL Schema Changes for 2019-11-19

  • November 19, 2019
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Field hasProjectsEnabled was added to object type RepositoryInfo
  • Field hasProjectsEnabled was added to object type Repository

GraphQL Schema Changes for 2019-11-06

The UpdateRefsPreview - Update multiple refs in a single operation. preview includes these changes:

  • Field updateRefs was added to object type Mutation
  • Type GitRefname was added
  • Type RefUpdate was added
  • Type UpdateRefsInput was added
  • Type UpdateRefsPayload was added

GraphQL Schema Changes for 2019-10-31

The following changes will be made to the schema:

  • On member Query.sponsorsListing: sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead. Effective 2020-04-01.

The GraphQL schema includes these changes:

  • Input field field was added to input object type SponsorshipOrder
  • Repository object implements PackageOwner interface
  • User object implements PackageOwner interface
  • Organization object implements PackageOwner interface
  • Field tiers was added to object type SponsorsListing
  • Field adminInfo was added to object type SponsorsTier
  • Field sponsorsListing was added to object type Sponsorable
  • Field sponsorsListing was added to object type User
  • Field sponsorsListing was added to object type Organization
  • Type SponsorsTierOrderField was added
  • Type SponsorsTierOrder was added
  • Type SponsorshipOrderField was added
  • Type SponsorsTierAdminInfo was added
  • Type SponsorsTierConnection was added
  • Type PackageVersionEdge was added
  • Type PackageVersionConnection was added
  • Type PackageFileEdge was added
  • Type PackageFileConnection was added
  • Type PackageEdge was added
  • Type PackageConnection was added

The GitHub Packages preview includes these changes:

  • Field packages was added to object type Repository
  • Field packages was added to object type User
  • Field packages was added to object type Organization
  • Type PackageTag was added
  • Type PackageVersionOrderField was added
  • Type PackageVersionOrder was added
  • Type PackageOrderField was added
  • Type PackageOrder was added
  • Type PackageFileOrderField was added
  • Type PackageFileOrder was added
  • Type PackageFile was added
  • Type PackageVersion was added
  • Type Package was added
  • Type PackageOwner was added

GraphQL Schema Changes for 2019-10-23

The GraphQL schema includes these changes:

  • Field tier was added to object type Sponsorship
  • Type SponsorsTierEdge was added
  • Type SponsorsTier was added

GraphQL Schema Changes for 2019-10-09

The GraphQL schema includes these changes:

  • Argument query: String added to field Repository.mentionableUsers

GraphQL Schema Changes for 2019-09-24

  • September 24, 2019
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Field unfollowUser was added to object type Mutation
  • Type UnfollowUserInput was added
  • Type UnfollowUserPayload was added

GraphQL Schema Changes for 2019-09-20

  • September 20, 2019
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Organization object implements Sponsorable interface
  • Field followUser was added to object type Mutation
  • Field sponsorshipsAsSponsor was added to object type Organization
  • Field sponsorshipsAsMaintainer was added to object type Organization
  • Type FollowUserInput was added
  • Type FollowUserPayload was added