Breaking Changes

Breaking changes are any changes that might require action from our integrators. We divide these changes into two categories:

  • Breaking: Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
  • Dangerous: Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.

We strive to provide stable APIs for our integrators. When a new feature is still evolving, we release it behind a schema preview.

We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st.

Changes scheduled for 2019-10-01

  • Breaking A change will be made to ContributionOrder.field.

    Description: field will be removed. Only one order field is supported.

    Reason: field will be removed.

  • Breaking A change will be made to Issue.timeline.

    Description: timeline will be removed. Use Issue.timelineItems instead.

    Reason: timeline will be removed

  • Breaking A change will be made to MarketplaceListing.hasApprovalBeenRequested.

    Description: hasApprovalBeenRequested will be removed. Use isVerificationPendingFromDraft instead.

    Reason: hasApprovalBeenRequested will be removed.

  • Breaking A change will be made to MarketplaceListing.isApproved.

    Description: isApproved will be removed. Use isPublic instead.

    Reason: isApproved will be removed.

  • Breaking A change will be made to MarketplaceListing.isDelisted.

    Description: isDelisted will be removed. Use isArchived instead.

    Reason: isDelisted will be removed.

  • Breaking A change will be made to Organization.pinnedRepositories.

    Description: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

    Reason: pinnedRepositories will be removed

  • Breaking A change will be made to PullRequest.timeline.

    Description: timeline will be removed. Use PullRequest.timelineItems instead.

    Reason: timeline will be removed

  • Breaking A change will be made to RepositoryOwner.pinnedRepositories.

    Description: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

    Reason: pinnedRepositories will be removed

  • Breaking A change will be made to RepositoryVulnerabilityAlert.affectedRange.

    Description: affectedRange will be removed. Use securityVulnerability.vulnerableVersionRange instead.

    Reason: advisory specific fields are being removed from repositoryVulnerabilityAlert objects

  • Breaking A change will be made to RepositoryVulnerabilityAlert.externalIdentifier.

    Description: externalIdentifier will be removed. Use securityAdvisory.identifiers instead.

    Reason: advisory specific fields are being removed from repositoryVulnerabilityAlert objects

  • Breaking A change will be made to RepositoryVulnerabilityAlert.externalReference.

    Description: externalReference will be removed. Use securityAdvisory.references instead.

    Reason: advisory specific fields are being removed from repositoryVulnerabilityAlert objects

  • Breaking A change will be made to RepositoryVulnerabilityAlert.fixedIn.

    Description: fixedIn will be removed. Use securityVulnerability.firstPatchedVersion instead.

    Reason: advisory specific fields are being removed from repositoryVulnerabilityAlert objects

  • Breaking A change will be made to RepositoryVulnerabilityAlert.packageName.

    Description: packageName will be removed. Use securityVulnerability.package instead.

    Reason: advisory specific fields are being removed from repositoryVulnerabilityAlert objects

  • Breaking A change will be made to User.pinnedRepositories.

    Description: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead.

    Reason: pinnedRepositories will be removed

Changes scheduled for 2020-01-01

  • Breaking A change will be made to AssignedEvent.user.

    Description: user will be removed. Use the assignee field instead.

    Reason: Assignees can now be mannequins.

  • Breaking A change will be made to EnterpriseBillingInfo.availableSeats.

    Description: availableSeats will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.

    Reason: availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned

  • Breaking A change will be made to EnterpriseBillingInfo.seats.

    Description: seats will be removed. Use EnterpriseBillingInfo.totalLicenses instead.

    Reason: seats will be replaced with totalLicenses to provide more clarity on the value being returned

  • Breaking A change will be made to UnassignedEvent.user.

    Description: user will be removed. Use the assignee field instead.

    Reason: Assignees can now be mannequins.

Changes scheduled for 2020-04-01

  • Breaking A change will be made to Query.sponsorsListing.

    Description: sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead.

    Reason: Query.sponsorsListing will be removed.