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

The following changes will be made to the schema:

  • On member MarketplaceListing.hasApprovalBeenRequested: hasApprovalBeenRequested will be removed. Use isVerificationPendingFromDraft instead. Effective 2019-10-01.
  • On member MarketplaceListing.isApproved: isApproved will be removed. Use isPublic instead. Effective 2019-10-01.
  • On member MarketplaceListing.isDelisted: isDelisted will be removed. Use isArchived instead. Effective 2019-10-01.

The GraphQL schema includes these changes:

  • Field isArchived was added to object type MarketplaceListing

GraphQL Schema Changes for 2019-04-10

The GraphQL schema includes these changes:

  • Field permissionSources was added to object type RepositoryCollaboratorEdge
  • Type PermissionGranter was added
  • Type PermissionSource was added

GraphQL Schema Changes for 2019-04-04

The GraphQL schema includes these changes:

  • Enum value USER_BLOCKED_EVENT was added to enum IssueTimelineItemsItemType
  • Union member UserBlockedEvent was added to Union type IssueTimelineItems
  • Union member UserBlockedEvent was added to Union type IssueTimelineItem
  • Enum value USER_BLOCKED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member UserBlockedEvent was added to Union type PullRequestTimelineItems
  • Union member UserBlockedEvent was added to Union type PullRequestTimelineItem
  • Field isDisabled was added to object type Repository
  • Type UserBlockDuration was added
  • Type UserBlockedEvent was added

GraphQL Schema Changes for 2019-03-30

The following changes will be made to the schema:

  • On member Organization.pinnedRepositories: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead. Effective 2019-07-01.
  • On member RepositoryOwner.pinnedRepositories: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead. Effective 2019-07-01.
  • On member User.pinnedRepositories: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead. Effective 2019-07-01.

The GraphQL schema includes these changes:

  • User object implements ProfileOwner interface
  • Organization object implements ProfileOwner interface
  • Field viewerCanChangePinnedItems was added to object type User
  • Field pinnedItemsRemaining was added to object type User
  • Field pinnedItems was added to object type User
  • Field pinnableItems was added to object type User
  • Field itemShowcase was added to object type User
  • Field anyPinnableItems was added to object type User
  • Field viewerCanChangePinnedItems was added to object type Organization
  • Field pinnedItemsRemaining was added to object type Organization
  • Field pinnedItems was added to object type Organization
  • Field pinnableItems was added to object type Organization
  • Field itemShowcase was added to object type Organization
  • Field anyPinnableItems was added to object type Organization
  • Type PinnableItem was added
  • Type PinnableItemEdge was added
  • Type PinnableItemConnection was added
  • Type ProfileItemShowcase was added
  • Type PinnableItemType was added
  • Type ProfileOwner was added

GraphQL Schema Changes for 2019-03-29

The GraphQL schema includes these changes:

  • Field cloneProject was added to object type Mutation
  • Type CloneProjectInput was added
  • Type CloneProjectPayload was added

GraphQL Schema Changes for 2019-03-23

The following changes will be made to the schema:

  • On member Repository.protectedBranches: protectedBranches will be removed. Use Repository.branchProtectionRules instead. Effective 2019-01-01.
  • On member Migration.uploadUrlTemplate: uploadUrlTemplate will be removed. Use uploadUrl instead. Effective 2019-04-01.
  • On member Organization.members: members will be removed. Use Organization.membersWithRole instead. Effective 2019-04-01.
  • On member ContributionsCollection.firstIssueContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.
  • On member ContributionsCollection.firstPullRequestContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.
  • On member ContributionsCollection.firstRepositoryContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.
  • On member ContributionsCollection.joinedGitHubContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.
  • On member RepositoryVulnerabilityAlert.affectedRange: affectedRange will be removed. Use securityVulnerability.vulnerableVersionRange instead. Effective 2019-07-01.
  • On member RepositoryVulnerabilityAlert.externalIdentifier: externalIdentifier will be removed. Use securityAdvisory.identifiers instead. Effective 2019-07-01.
  • On member RepositoryVulnerabilityAlert.externalReference: externalReference will be removed. Use securityAdvisory.references instead. Effective 2019-07-01.
  • On member RepositoryVulnerabilityAlert.fixedIn: fixedIn will be removed. Use securityVulnerability.firstPatchedVersion instead. Effective 2019-07-01.
  • On member RepositoryVulnerabilityAlert.packageName: packageName will be removed. Use securityVulnerability.package instead. Effective 2019-07-01.
  • On member ReviewDismissedEvent.message: message will be removed. Use dismissalMessage instead. Effective 2019-07-01.
  • On member ReviewDismissedEvent.messageHtml: messageHtml will be removed. Use dismissalMessageHTML instead. Effective 2019-07-01.

GraphQL Schema Changes for 2019-03-21

The GraphQL schema includes these changes:

  • Field baseRepository was added to object type PullRequest

GraphQL Schema Changes for 2019-03-19

The following changes will be made to the schema:

  • On member ContributionsCollection.firstIssueContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.
  • On member ContributionsCollection.firstPullRequestContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.
  • On member ContributionsCollection.firstRepositoryContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.
  • On member ContributionsCollection.joinedGitHubContribution.ignoreTimeRange: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Effective 2019-07-01.

GraphQL Schema Changes for 2019-03-08

The GraphQL schema includes these changes:

  • Field associatedPullRequests was added to object type Commit
  • Type PullRequestOrder was added

GraphQL Schema Changes for 2019-03-06

The GraphQL schema includes these changes:

  • Field pullRequestReviewContributionsByRepository was added to object type ContributionsCollection
  • Field pullRequestContributionsByRepository was added to object type ContributionsCollection
  • Field issueContributionsByRepository was added to object type ContributionsCollection
  • Type PullRequestReviewContributionsByRepository was added
  • Type PullRequestContributionsByRepository was added
  • Type IssueContributionsByRepository was added

The Unified business identity preview includes these changes:

  • Field pendingCollaborators was added to object type BusinessAdminInfo
  • Field outsideCollaborators was added to object type BusinessAdminInfo
  • Field members was added to object type Business
  • Type BusinessMemberEdge was added
  • Type BusinessMemberConnection was added
  • Type RepositoryInvitationOrder was added
  • Type BusinessPendingCollaboratorEdge was added
  • Type BusinessPendingCollaboratorConnection was added
  • Type BusinessRepositoryInfoEdge was added
  • Type BusinessRepositoryInfoConnection was added
  • Type BusinessOutsideCollaboratorEdge was added
  • Type BusinessOutsideCollaboratorConnection was added