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

The GraphQL schema includes these changes:

  • Type IssueOrPullRequestEdge was removed
  • Default value for argument affiliations on field RepositoryOwner.repositories changed from ["OWNER", "COLLABORATOR"] to __no_default__
  • Default value for argument affiliations on field RepositoryOwner.pinnedRepositories changed from ["OWNER", "COLLABORATOR"] to __no_default__
  • Default value for argument affiliations on field Organization.repositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field Organization.pinnedRepositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field User.watching changed from ["OWNER", "COLLABORATOR", "ORGANIZATION_MEMBER"] to ``
  • Default value for argument affiliations on field User.repositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field User.pinnedRepositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field Repository.forks changed from ["OWNER", "COLLABORATOR"] to ``
  • Field submodule was added to object type TreeEntry
  • Field reviewDecision was added to object type ReviewStatusHovercardContext
  • Field permalink was added to object type SecurityAdvisory
  • Field updateIpAllowListEntry was added to object type Mutation
  • Field updateIpAllowListEnabledSetting was added to object type Mutation
  • Field setEnterpriseIdentityProvider was added to object type Mutation
  • Field removeEnterpriseIdentityProvider was added to object type Mutation
  • Field deleteIpAllowListEntry was added to object type Mutation
  • Field createIpAllowListEntry was added to object type Mutation
  • Field ipAllowListEntries was added to object type EnterpriseOwnerInfo
  • Field ipAllowListEnabledSetting was added to object type EnterpriseOwnerInfo
  • Field submodules was added to object type Repository
  • Field reviewDecision was added to object type PullRequest
  • Field submodules was added to object type Commit
  • Field slug was added to object type Enterprise
  • Type SubmoduleEdge was added
  • Type PullRequestReviewDecision was added
  • Type UpdateIpAllowListEntryInput was added
  • Type UpdateIpAllowListEntryPayload was added
  • Type UpdateIpAllowListEnabledSettingInput was added
  • Type UpdateIpAllowListEnabledSettingPayload was added
  • Type SetEnterpriseIdentityProviderInput was added
  • Type SetEnterpriseIdentityProviderPayload was added
  • Type RemoveEnterpriseIdentityProviderInput was added
  • Type RemoveEnterpriseIdentityProviderPayload was added
  • Type IpAllowListEntryOrderField was added
  • Type IpAllowListEntryEdge was added
  • Type IpAllowListOwner was added
  • Type IpAllowListEntryOrder was added
  • Type IpAllowListEntryConnection was added
  • Type IpAllowListEnabledSettingValue was added
  • Type DeleteIpAllowListEntryPayload was added
  • Type DeleteIpAllowListEntryInput was added
  • Type CreateIpAllowListEntryPayload was added
  • Type IpAllowListEntry was added
  • Type CreateIpAllowListEntryInput was added
  • Type Submodule was added
  • Type SubmoduleConnection was added

GraphQL Schema Changes for 2020-03-10

The GraphQL schema includes these changes:

  • Type MentionableItemEdge was removed
  • Type MentionableItem was removed
  • Field statusCheckRollup was added to object type Commit
  • Type StatusCheckRollupContext was added
  • Type StatusCheckRollupContextEdge was added
  • Type StatusCheckRollupContextConnection was added
  • Type StatusCheckRollup was added

GraphQL Schema Changes for 2020-03-05

The GraphQL schema includes these changes:

  • Field actor was added to object type RequestReviewsPayload
  • Type MentionableItemEdge was added
  • Type MentionableItem was added

GraphQL Schema Changes for 2020-02-19

  • February 19, 2020
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Type PackageType was added

The GitHub Packages preview includes these changes:

  • Field packageType was added to object type Package

GraphQL Schema Changes for 2020-02-12

  • February 12, 2020
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Field deleteDeployment was added to object type Mutation
  • Type DeleteDeploymentInput was added
  • Type DeleteDeploymentPayload was added

GraphQL Schema Changes for 2020-02-05

The GraphQL schema includes these changes:

  • Type EnterpriseOrderField was removed
  • Type CollectionItemContent was removed
  • Enum value UNMARKED_AS_DUPLICATE_EVENT was added to enum PullRequestTimelineItemsItemType
  • Enum value DISCONNECTED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Enum value CONNECTED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member UnmarkedAsDuplicateEvent was added to Union type PullRequestTimelineItems
  • Union member DisconnectedEvent was added to Union type PullRequestTimelineItems
  • Union member ConnectedEvent was added to Union type PullRequestTimelineItems
  • Enum value UNMARKED_AS_DUPLICATE_EVENT was added to enum IssueTimelineItemsItemType
  • Enum value DISCONNECTED_EVENT was added to enum IssueTimelineItemsItemType
  • Enum value CONNECTED_EVENT was added to enum IssueTimelineItemsItemType
  • Union member UnmarkedAsDuplicateEvent was added to Union type IssueTimelineItems
  • Union member DisconnectedEvent was added to Union type IssueTimelineItems
  • Union member ConnectedEvent was added to Union type IssueTimelineItems
  • Input field SubmitPullRequestReviewInput.pullRequestReviewId changed type from ID! to ID
  • Input field pullRequestId was added to input object type SubmitPullRequestReviewInput
  • Input field AddPullRequestReviewCommentInput.pullRequestReviewId changed type from ID! to ID
  • Input field pullRequestId was added to input object type AddPullRequestReviewCommentInput
  • Field originalEnvironment was added to object type Deployment
  • Field latestEnvironment was added to object type Deployment
  • Field checksUrl was added to object type PullRequest
  • Field checksResourcePath was added to object type PullRequest
  • Type UnmarkedAsDuplicateEvent was added
  • Type DisconnectedEvent was added
  • Type ConnectedEvent was added

The Checks preview includes these changes:

  • Enum value STALE was added to enum CheckConclusionState
  • Enum value SKIPPED was added to enum CheckConclusionState

GraphQL Schema Changes for 2020-01-09

The GraphQL schema includes these changes:

  • Enum value DUPLICATE was added to enum ReportedContentClassifiers
  • Field deleteBranchOnMerge was added to object type Repository

GraphQL Schema Changes for 2020-01-06

The following changes will be made to the schema:

  • On member Sponsorship.maintainer: maintainer will be removed. Use Sponsorship.sponsorable instead. Effective 2020-04-01.

The GraphQL schema includes these changes:

  • Field sponsorable was added to object type Sponsorship

GraphQL Schema Changes for 2019-12-16

  • December 16, 2019
  • Avatar for hubot 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
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Field createdAt was added to object type RepositoryVulnerabilityAlert