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 2018-06-14

The GraphQL schema includes these changes:

  • Field unlockLockable was added to object type Mutation
  • Type UnlockLockableInput was added
  • Type UnlockLockablePayload was added

GraphQL Schema Changes for 2018-06-12

The GraphQL schema includes these changes:

  • Field subject was added to object type ReviewRequestedEvent
  • Field subject was added to object type ReviewRequestRemovedEvent
  • Field isCrossReference was added to object type ReferencedEvent
  • Field commit was added to object type ClosedEvent
  • Field reviewer was added to object type ReviewRequest
  • Field license was added to object type RepositoryInfo
  • Field license was added to object type Repository
  • Field contributedRepositories was added to object type User
  • Field projectColumn was added to object type ProjectCard
  • Type TopicConnection was added
  • Type RepositoryInvitationEdge was added
  • Type RepositoryCollaboratorAffiliation was added
  • Type PullRequestPubSubTopic was added
  • Type IssuePubSubTopic was added
  • Type DefaultRepositoryPermissionField was added
  • Type Date was added
  • Type MergeStateStatus was added

The Team discussions preview includes these changes:

  • Field updateTeamDiscussionComment was added to object type Mutation
  • Field updateTeamDiscussion was added to object type Mutation
  • Field deleteTeamDiscussionComment was added to object type Mutation
  • Field deleteTeamDiscussion was added to object type Mutation
  • Field createTeamDiscussionComment was added to object type Mutation
  • Field createTeamDiscussion was added to object type Mutation
  • Field discussionsUrl was added to object type Team
  • Field discussionsResourcePath was added to object type Team
  • Field discussions was added to object type Team
  • Field discussion was added to object type Team
  • Type UpdateTeamDiscussionCommentInput was added
  • Type UpdateTeamDiscussionCommentPayload was added
  • Type UpdateTeamDiscussionInput was added
  • Type UpdateTeamDiscussionPayload was added
  • Type DeleteTeamDiscussionCommentInput was added
  • Type DeleteTeamDiscussionCommentPayload was added
  • Type DeleteTeamDiscussionInput was added
  • Type DeleteTeamDiscussionPayload was added
  • Type CreateTeamDiscussionCommentInput was added
  • Type CreateTeamDiscussionCommentPayload was added
  • Type CreateTeamDiscussionInput was added
  • Type CreateTeamDiscussionPayload was added
  • Type TeamDiscussionOrderField was added
  • Type TeamDiscussionOrder was added
  • Type TeamDiscussionEdge was added
  • Type TeamDiscussionConnection was added
  • Type TeamDiscussionCommentOrderField was added
  • Type TeamDiscussionCommentOrder was added
  • Type TeamDiscussionComment was added
  • Type TeamDiscussionCommentEdge was added
  • Type TeamDiscussionCommentConnection was added
  • Type TeamDiscussion was added

The Protected Branch: Multiple Required Approving Reviews preview includes these changes:

  • Field requiredApprovingReviewCount was added to object type ProtectedBranch

The Protected Branch: Required Signatures preview includes these changes:

  • Field hasRequiredSignatures was added to object type ProtectedBranch

The MergeInfoPreview - More detailed information about a pull request's merge state. preview includes these changes:

  • Field mergeStateStatus was added to object type PullRequest
  • Field canBeRebased was added to object type PullRequest

The Repository Vulnerability Alerts preview includes these changes:

  • Field vulnerabilityAlerts was added to object type Repository
  • Type RepositoryVulnerabilityAlert was added
  • Type RepositoryVulnerabilityAlertEdge was added
  • Type RepositoryVulnerabilityAlertConnection was added

The Access to a Repositories Dependency Graph preview includes these changes:

  • Field dependencyGraphManifests was added to object type Repository
  • Type DependencyGraphDependency was added
  • Type DependencyGraphDependencyEdge was added
  • Type DependencyGraphDependencyConnection was added
  • Type DependencyGraphManifest was added
  • Type DependencyGraphManifestEdge was added
  • Type DependencyGraphManifestConnection was added

The Hovercards preview includes these changes:

  • Field hovercard was added to object type User
  • Type OrganizationsHovercardContext was added
  • Type OrganizationTeamsHovercardContext was added
  • Type GenericHovercardContext was added
  • Type HovercardContext was added
  • Type Hovercard was added

GraphQL Schema Changes for 2018-06-11

The GraphQL schema includes these changes:

  • Default value for argument affiliations on field User.watching changed from ["OWNER", "COLLABORATOR"] to ["OWNER", "COLLABORATOR", "ORGANIZATION_MEMBER"]

GraphQL Schema Changes for 2018-05-30

The GraphQL schema includes these changes:

  • Field editedAt was added to object type UserContentEdit

GraphQL Schema Changes for 2018-05-25

The GraphQL schema includes these changes:

  • Field TextMatch.highlights changed type from [TextMatchHighlight]! to [TextMatchHighlight!]!
  • Type MergeStateStatus was added

The MergeInfoPreview - More detailed information about a pull request's merge state. preview includes these changes:

  • Field mergeStateStatus was added to object type PullRequest
  • Field canBeRebased was added to object type PullRequest

GraphQL Schema Changes for 2018-05-18

The GraphQL schema includes these changes:

  • License object implements Node interface

GraphQL Schema Changes for 2018-05-17

The GraphQL schema includes these changes:

  • MarketplaceCategory object implements Node interface
  • Field id was added to object type MarketplaceCategory

GraphQL Schema Changes for 2018-05-09

The GraphQL schema includes these changes:

  • Field includesCreatedEdit was added to object type GistComment
  • Field includesCreatedEdit was added to object type PullRequestReviewComment
  • Field includesCreatedEdit was added to object type PullRequestReview
  • Field includesCreatedEdit was added to object type IssueComment
  • Field includesCreatedEdit was added to object type PullRequest
  • Field includesCreatedEdit was added to object type Comment
  • Field includesCreatedEdit was added to object type CommitComment
  • Field includesCreatedEdit was added to object type Issue
  • Argument excludeSubcategories: Boolean added to field Query.marketplaceCategories

The Team discussions preview includes these changes:

  • Field includesCreatedEdit was added to object type TeamDiscussionComment
  • Field includesCreatedEdit was added to object type TeamDiscussion

GraphQL Schema Changes for 2018-05-08

The GraphQL schema includes these changes:

  • ClosedEvent object implements UniformResourceLocatable interface
  • Field url was added to object type ClosedEvent
  • Field resourcePath was added to object type ClosedEvent

GraphQL Schema Changes for 2018-05-03

The Access to a Repositories Dependency Graph preview includes these changes:

  • Field totalCount was added to object type DependencyGraphDependencyConnection