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-09-23

  • September 23, 2020
  • Avatar for hubot hubot

The following changes will be made to the schema:

  • On member EnterprisePendingMemberInvitationEdge.isUnlicensed: isUnlicensed will be removed. Effective 2020-07-01.
  • On member EnterpriseMemberEdge.isUnlicensed: isUnlicensed will be removed. Effective 2021-01-01.
  • On member EnterpriseOutsideCollaboratorEdge.isUnlicensed: isUnlicensed will be removed. Effective 2021-01-01.
  • On member EnterprisePendingCollaboratorEdge.isUnlicensed: isUnlicensed will be removed. Effective 2021-01-01.
  • On member MergeStateStatus.DRAFT: DRAFT will be removed. Use PullRequest.isDraft instead. Effective 2021-01-01.

The GraphQL schema includes these changes:

  • Field Blob.isBinary changed type from Boolean! to Boolean
  • Field Ref.target changed type from GitObject! to GitObject
  • Union member BaseRefDeletedEvent was added to Union type PullRequestTimelineItem
  • Enum value BASE_REF_DELETED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member BaseRefDeletedEvent was added to Union type PullRequestTimelineItems
  • Enum value PUBLIC_PRIVATE was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value PUBLIC_INTERNAL was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value PRIVATE_INTERNAL was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value PRIVATE was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value NONE was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value INTERNAL was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value MANNEQUIN was added to enum CommentAuthorAssociation
  • Field path was added to object type TreeEntry
  • Field isGenerated was added to object type TreeEntry
  • Field extension was added to object type TreeEntry
  • Field used was added to object type RateLimit
  • Field asCodeOwner was added to object type ReviewRequest
  • Field viewerViewedState was added to object type PullRequestChangedFile
  • Field unmarkFileAsViewed was added to object type Mutation
  • Field markFileAsViewed was added to object type Mutation
  • Input field authorEmail was added to input object type MergePullRequestInput
  • Input field authorEmail was added to input object type MergeBranchInput
  • Field isCrossRepository was added to object type UnmarkedAsDuplicateEvent
  • Field duplicate was added to object type UnmarkedAsDuplicateEvent
  • Field canonical was added to object type UnmarkedAsDuplicateEvent
  • Field isCrossRepository was added to object type MarkedAsDuplicateEvent
  • Field duplicate was added to object type MarkedAsDuplicateEvent
  • Field canonical was added to object type MarkedAsDuplicateEvent
  • Field groups was added to object type ExternalIdentityScimAttributes
  • Field givenName was added to object type ExternalIdentityScimAttributes
  • Field familyName was added to object type ExternalIdentityScimAttributes
  • Field emails was added to object type ExternalIdentityScimAttributes
  • Field username was added to object type ExternalIdentitySamlAttributes
  • Field groups was added to object type ExternalIdentitySamlAttributes
  • Field givenName was added to object type ExternalIdentitySamlAttributes
  • Field familyName was added to object type ExternalIdentitySamlAttributes
  • Field emails was added to object type ExternalIdentitySamlAttributes
  • Field isInOrganization was added to object type RepositoryInfo
  • Field permalink was added to object type RepositoryInvitation
  • Input field issueTemplate was added to input object type CreateIssueInput
  • Field combinedContexts was added to object type Status
  • Field deletedCommentAuthor was added to object type CommentDeletedEvent
  • Field pullRequest was added to object type BaseRefChangedEvent
  • Field previousRefName was added to object type BaseRefChangedEvent
  • Field currentRefName was added to object type BaseRefChangedEvent
  • Field stargazerCount was added to object type Gist
  • Field refUpdateRule was added to object type Ref
  • Field branchProtectionRule was added to object type Ref
  • Argument query: String added to field Repository.milestones
  • Field viewerPossibleCommitEmails was added to object type Repository
  • Field viewerDefaultMergeMethod was added to object type Repository
  • Field viewerDefaultCommitEmail was added to object type Repository
  • Field securityPolicyUrl was added to object type Repository
  • Field issueTemplates was added to object type Repository
  • Field isUserConfigurationRepository was added to object type Repository
  • Field isSecurityPolicyEnabled was added to object type Repository
  • Field isEmpty was added to object type Repository
  • Field isBlankIssuesEnabled was added to object type Repository
  • Field contactLinks was added to object type Repository
  • Field stargazerCount was added to object type Repository
  • Field isInOrganization was added to object type Repository
  • Field viewerCanReply was added to object type PullRequestReviewThread
  • Field path was added to object type PullRequestReviewThread
  • Field isOutdated was added to object type PullRequestReviewThread
  • Field isCollapsed was added to object type PullRequestReviewThread
  • Input field AddPullRequestReviewThreadInput.pullRequestReviewId changed type from ID! to ID
  • Input field pullRequestId was added to input object type AddPullRequestReviewThreadInput
  • Field authorCanPushToRepository was added to object type PullRequestReview
  • Field progressPercentage was added to object type Milestone
  • Enum value MergeStateStatus.DRAFT was deprecated with reason DRAFT state will be removed from this enum andisDraftshould be used instead Use PullRequest.isDraft instead. Removal on 2021-01-01 UTC.
  • Field viewerMergeHeadlineText was added to object type PullRequest
  • Field viewerMergeBodyText was added to object type PullRequest
  • Field viewerCanDeleteHeadRef was added to object type PullRequest
  • Field latestReviews was added to object type PullRequest
  • Field latestOpinionatedReviews was added to object type PullRequest
  • Field isReadByViewer was added to object type PullRequest
  • Field progress was added to object type Project
  • Field file was added to object type Commit
  • Field authors was added to object type Commit
  • Field isReadByViewer was added to object type Issue
  • Field bodyUrl was added to object type Issue
  • Field bodyResourcePath was added to object type Issue
  • Field stargazerCount was added to object type Starrable
  • Field stargazerCount was added to object type Topic
  • Type RepositoryContactLink was added
  • Type RefUpdateRule was added
  • Type ProjectProgress was added
  • Type UnmarkFileAsViewedInput was added
  • Type UnmarkFileAsViewedPayload was added
  • Type MarkFileAsViewedPayload was added
  • Type MarkFileAsViewedInput was added
  • Type GitActorEdge was added
  • Type FileViewedState was added
  • Type UserEmailMetadata was added
  • Type GitActorConnection was added
  • Type BaseRefDeletedEvent was added
  • Type IssueTemplate was added

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"}