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-16

December 16, 2019
hubot

The GraphQL schema includes these changes:

Field actor was added to object type UpdatePullRequestPayload
Field actor was added to object type UpdateIssuePayload
Field actor was added to object type UnlockLockablePayload
Field actor was added to object type MergePullRequestPayload
Field actor was added to object type LockLockablePayload
Argument orderBy: LabelOrder added to field Repository.labels
Argument orderBy: LabelOrder added to field Issue.labels
Argument orderBy: LabelOrder added to field Labelable.labels
Argument orderBy: LabelOrder added to field PullRequest.labels
Type LabelOrderField was added
Type LabelOrder was added

GraphQL Schema Changes for 2019-12-11

December 11, 2019
hubot

The GraphQL schema includes these changes:

Field createdAt was added to object type RepositoryVulnerabilityAlert

GraphQL Schema Changes for 2019-12-05

December 5, 2019
hubot

The GraphQL schema includes these changes:

Field createdAt was added to object type SponsorsListing

GraphQL Schema Changes for 2019-11-25

November 25, 2019
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.