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-10-16

The Access to GitHub Security Advisories preview includes these changes:

  • Field securityVulnerabilities was added to object type Query
  • Field securityAdvisory was added to object type Query
  • Field securityAdvisories was added to object type Query
  • Type SecurityAdvisoryOrderField was added
  • Type SecurityAdvisoryOrder was added
  • Type SecurityAdvisoryIdentifierType was added
  • Type SecurityAdvisoryIdentifierFilter was added
  • Type SecurityVulnerabilityOrderField was added
  • Type SecurityVulnerabilityOrder was added
  • Type SecurityAdvisoryEcosystem was added
  • Type SecurityAdvisoryPackage was added
  • Type SecurityAdvisoryPackageVersion was added
  • Type SecurityVulnerability was added
  • Type SecurityVulnerabilityEdge was added
  • Type SecurityVulnerabilityConnection was added
  • Type SecurityAdvisorySeverity was added
  • Type SecurityAdvisoryReference was added
  • Type SecurityAdvisoryIdentifier was added
  • Type SecurityAdvisory was added
  • Type SecurityAdvisoryEdge was added
  • Type SecurityAdvisoryConnection was added

GraphQL Schema Changes for 2018-10-12

The GraphQL schema includes these changes:

  • Field outdated was added to object type PullRequestReviewComment
  • Field onBehalfOf was added to object type PullRequestReview

GraphQL Schema Changes for 2018-10-11

The GraphQL schema includes these changes:

  • Field state was added to object type PullRequestReviewComment
  • Type PullRequestReviewCommentState was added

GraphQL Schema Changes for 2018-10-08

The following changes will be made to the schema:

  • On member PushAllowance.protectedBranch: protectedBranch will be removed. Use Repository.branchProtectionRule instead. Effective 2019-01-01.
  • On member Repository.protectedBranches: protectedBranches will be removed. Use Repository.branchProtectionRules instead. Effective 2019-01-01.
  • On member ReviewDismissalAllowance.protectedBranch: protectedBranch will be removed. Use ReviewDismissalAllowance.branchProtectionRule instead. Effective 2019-01-01.

GraphQL Schema Changes for 2018-09-26

  • September 26, 2018
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Field viewerCanApplySuggestion was added to object type PullRequest

GraphQL Schema Changes for 2018-09-25

  • September 25, 2018
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Field ref was added to object type Deployment

GraphQL Schema Changes for 2018-09-19

  • September 19, 2018
  • Avatar for hubot hubot

The Issues Preview preview includes these changes:

  • Field convertProjectCardNoteToIssue was added to object type Mutation
  • Type ConvertProjectCardNoteToIssueInput was added
  • Type ConvertProjectCardNoteToIssuePayload was added

GraphQL Schema Changes for 2018-09-14

  • September 14, 2018
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Enum value UNMARKED_AS_DUPLICATE_EVENT was removed from enum IssueTimelineItemsItemType
  • Enum value MARKED_AS_DUPLICATE_EVENT was removed from enum IssueTimelineItemsItemType
  • Enum value UNMARKED_AS_DUPLICATE_EVENT was removed from enum PullRequestTimelineItemsItemType
  • Enum value MARKED_AS_DUPLICATE_EVENT was removed from enum PullRequestTimelineItemsItemType

GraphQL Schema Changes for 2018-09-13

  • September 13, 2018
  • Avatar for hubot hubot

The Checks preview includes these changes:

  • Field app was added to object type CheckSuite

GraphQL Schema Changes for 2018-09-12

  • September 12, 2018
  • Avatar for hubot hubot

The GraphQL schema includes these changes:

  • Type UpdateIssueCommentInput was added
  • Type UpdateIssueCommentPayload was added
  • Type UpdateIssueInput was added
  • Type UpdateIssuePayload was added
  • Type UnmarkIssueAsDuplicateInput was added
  • Type UnmarkIssueAsDuplicatePayload was added
  • Type ReopenIssueInput was added
  • Type ReopenIssuePayload was added
  • Type RemoveLabelsFromLabelableInput was added
  • Type RemoveLabelsFromLabelablePayload was added
  • Type RemoveAssigneesFromAssignableInput was added
  • Type RemoveAssigneesFromAssignablePayload was added
  • Type DeleteIssueCommentInput was added
  • Type DeleteIssueCommentPayload was added
  • Type CreateIssueInput was added
  • Type CreateIssuePayload was added
  • Type CloseIssueInput was added
  • Type CloseIssuePayload was added
  • Type ClearLabelsFromLabelableInput was added
  • Type ClearLabelsFromLabelablePayload was added
  • Type AddLabelsToLabelableInput was added
  • Type AddLabelsToLabelablePayload was added
  • Type AddAssigneesToAssignableInput was added
  • Type AddAssigneesToAssignablePayload was added
  • Type IssueTimelineItemsItemType was added
  • Type IssueTimelineItems was added
  • Type IssueTimelineItemsEdge was added
  • Type IssueTimelineItemsConnection was added
  • Type PullRequestTimelineItemsItemType was added
  • Type PullRequestTimelineItems was added
  • Type PullRequestTimelineItemsEdge was added
  • Type PullRequestTimelineItemsConnection was added

The Issues Preview preview includes these changes:

  • Field updateIssueComment was added to object type Mutation
  • Field updateIssue was added to object type Mutation
  • Field unmarkIssueAsDuplicate was added to object type Mutation
  • Field reopenIssue was added to object type Mutation
  • Field removeLabelsFromLabelable was added to object type Mutation
  • Field removeAssigneesFromAssignable was added to object type Mutation
  • Field deleteIssueComment was added to object type Mutation
  • Field createIssue was added to object type Mutation
  • Field closeIssue was added to object type Mutation
  • Field clearLabelsFromLabelable was added to object type Mutation
  • Field addLabelsToLabelable was added to object type Mutation
  • Field addAssigneesToAssignable was added to object type Mutation
  • Argument filterBy: IssueFilters added to field Milestone.issues
  • Argument filterBy: IssueFilters added to field Label.issues
  • Field timelineItems was added to object type PullRequest
  • Argument filterBy: IssueFilters added to field Repository.issues
  • Argument filterBy: IssueFilters added to field User.issues
  • Field timelineItems was added to object type Issue
  • Type PullRequestRevisionMarker was added
  • Type PullRequestCommitCommentThread was added
  • Type IssueFilters was added

The Branch Protection Rules preview includes these changes:

  • Field updateBranchProtectionRule was added to object type Mutation
  • Field deleteBranchProtectionRule was added to object type Mutation
  • Field createBranchProtectionRule was added to object type Mutation
  • Field branchProtectionRule was added to object type ReviewDismissalAllowance
  • Field branchProtectionRule was added to object type PushAllowance
  • Field branchProtectionRules was added to object type Repository
  • Type UpdateBranchProtectionRuleInput was added
  • Type UpdateBranchProtectionRulePayload was added
  • Type DeleteBranchProtectionRuleInput was added
  • Type DeleteBranchProtectionRulePayload was added
  • Type CreateBranchProtectionRuleInput was added
  • Type CreateBranchProtectionRulePayload was added
  • Type BranchProtectionRuleConflict was added
  • Type BranchProtectionRuleConflictEdge was added
  • Type BranchProtectionRuleConflictConnection was added
  • Type BranchProtectionRule was added
  • Type BranchProtectionRuleEdge was added
  • Type BranchProtectionRuleConnection was added