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 2020-06-26

The GraphQL schema includes these changes:

  • Type TopicEdge was removed
  • Type RegistryPackageVersionEdge was removed
  • Type RegistryPackageVersionStatistics was removed
  • Type RegistryPackageTagEdge was removed
  • Type RegistryPackageFileEdge was removed
  • Type RegistryPackageDependencyEdge was removed
  • Type RegistryPackageMetadatum was removed
  • Type TopicConnection was removed
  • Type RegistryPackageTag was removed
  • Type RegistryPackageTagConnection was removed
  • Type RegistryPackageStatistics was removed
  • Type RegistryPackageVersionConnection was removed
  • Type RegistryPackageType was removed
  • Type RegistryPackage was removed
  • Type RegistryPackageFileConnection was removed
  • Type RegistryPackageFile was removed
  • Type RegistryPackageDependencyType was removed
  • Type RegistryPackageDependency was removed
  • Type RegistryPackageDependencyConnection was removed
  • Type RegistryPackageVersion was removed

GraphQL Schema Changes for 2020-06-23

The GraphQL schema includes these changes:

  • Argument packageType: PackageType added to field Organization.packages
  • Argument packageType: PackageType added to field User.packages
  • Argument packageType: PackageType added to field PackageOwner.packages
  • Argument packageType: PackageType added to field Repository.packages

GraphQL Schema Changes for 2020-06-18

The GraphQL schema includes these changes:

  • Field databaseId was added to object type Team

GraphQL Schema Changes for 2020-06-05

The GraphQL schema includes these changes:

  • Enum value TWO_FACTOR_ACCOUNT_RECOVERY was added to enum OrgRemoveMemberAuditEntryReason

GraphQL Schema Changes for 2020-06-01

The following changes will be made to the schema:

  • On member Blob.isBinary: Type for isBinary will change from Boolean! to Boolean. Effective 2019-07-01.
  • On member Ref.target: Type for target will change from GitObject! to GitObject. Effective 2019-07-01.

The GraphQL schema includes these changes:

  • Field twitterUsername was added to object type Organization
  • Field twitterUsername was added to object type User

GraphQL Schema Changes for 2020-05-23

The GraphQL schema includes these changes:

  • Field ipAllowListEntries was added to object type Organization
  • Field ipAllowListEnabledSetting was added to object type Organization

GraphQL Schema Changes for 2020-05-21

The following changes will be made to the schema:

  • On member RepositoryCollaboratorEdge.permission: Type for permission will change from RepositoryPermission! to String. Effective 2020-10-01.
  • On member RepositoryInvitation.permission: Type for permission will change from RepositoryPermission! to String. Effective 2020-10-01.
  • On member TeamRepositoryEdge.permission: Type for permission will change from RepositoryPermission! to String. Effective 2020-10-01.

The GraphQL schema includes these changes:

  • Enum value AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Enum value AUTOMATIC_BASE_CHANGE_FAILED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member AutomaticBaseChangeSucceededEvent was added to Union type PullRequestTimelineItems
  • Union member AutomaticBaseChangeFailedEvent was added to Union type PullRequestTimelineItems
  • Type AutomaticBaseChangeSucceededEvent was added
  • Type AutomaticBaseChangeFailedEvent was added

GraphQL Schema Changes for 2020-05-19

The following changes will be made to the schema:

  • On member EnterpriseOwnerInfo.pendingCollaborators: pendingCollaborators will be removed. Use the pendingCollaboratorInvitations field instead. Effective 2020-10-01.
  • On member RepositoryInvitationOrderField.INVITEE_LOGIN: INVITEE_LOGIN will be removed. Effective 2020-10-01.

The GraphQL schema includes these changes:

  • Field RepositoryInvitation.invitee changed type from User! to User
  • Default value for argument orderBy on field EnterpriseOwnerInfo.pendingCollaborators changed from {"field"=>"INVITEE_LOGIN", "direction"=>"ASC"} to {"field"=>"CREATED_AT", "direction"=>"DESC"}
  • Enum value RepositoryInvitationOrderField.INVITEE_LOGIN was deprecated with reason `INVITEE_LOGIN is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee. Removal on 2020-10-01 UTC.`
  • Field email was added to object type RepositoryInvitation
  • Field pendingCollaboratorInvitations was added to object type EnterpriseOwnerInfo
  • Type RepositoryInvitationEdge was added
  • Type RepositoryInvitationConnection was added

GraphQL Schema Changes for 2020-05-13

The GraphQL schema includes these changes:

  • Field packageName was removed from object type RepositoryVulnerabilityAlert
  • Field fixedIn was removed from object type RepositoryVulnerabilityAlert
  • Field externalReference was removed from object type RepositoryVulnerabilityAlert
  • Field externalIdentifier was removed from object type RepositoryVulnerabilityAlert
  • Field affectedRange was removed from object type RepositoryVulnerabilityAlert
  • Field isDelisted was removed from object type MarketplaceListing
  • Field isApproved was removed from object type MarketplaceListing
  • Field hasApprovalBeenRequested was removed from object type MarketplaceListing
  • Field pinnedRepositories was removed from object type RepositoryOwner
  • Input field field was removed from input object type ContributionOrder
  • Field pinnedRepositories was removed from object type Organization
  • Field pinnedRepositories was removed from object type User
  • Type ContributionOrderField was removed
  • Default value for argument orderBy on field PullRequestReviewContributionsByRepository.contributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field PullRequestContributionsByRepository.contributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field IssueContributionsByRepository.contributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.repositoryContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.pullRequestReviewContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.pullRequestContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.issueContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}

GraphQL Schema Changes for 2020-05-12

The GraphQL schema includes these changes:

  • Field organizationVerifiedDomainEmails was added to object type User