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-07-19

The following changes will be made to the schema:

  • On member AssignedEvent.user: user will be removed. Use the assignee field instead. Effective 2020-01-01.
  • On member UnassignedEvent.user: user will be removed. Use the assignee field instead. Effective 2020-01-01.

The GraphQL schema includes these changes:

  • Argument ignoreTimeRange: Boolean was removed from field ContributionsCollection.joinedGitHubContribution
  • Argument ignoreTimeRange: Boolean was removed from field ContributionsCollection.firstRepositoryContribution
  • Argument ignoreTimeRange: Boolean was removed from field ContributionsCollection.firstPullRequestContribution
  • Argument ignoreTimeRange: Boolean was removed from field ContributionsCollection.firstIssueContribution
  • Field messageHtml was removed from object type ReviewDismissedEvent
  • Field message was removed from object type ReviewDismissedEvent
  • Field members was removed from object type Organization
  • Gist object implements UniformResourceLocatable interface
  • Field assignee was added to object type UnassignedEvent
  • Field assignee was added to object type AssignedEvent
  • Field url was added to object type Gist
  • Field resourcePath was added to object type Gist
  • Field savedReplies was added to object type User
  • Field sponsorsListing was added to object type Query
  • Type SponsorsListing was added
  • Type SavedReplyOrderField was added
  • Type SavedReplyOrder was added
  • Type SavedReply was added
  • Type SavedReplyEdge was added
  • Type SavedReplyConnection was added
  • Type Assignee was added

GraphQL Schema Changes for 2019-07-17

The GraphQL schema includes these changes:

  • Type BusinessAuditEntryData was removed
  • Input field template was added to input object type CreateProjectInput
  • Field updateRepository was added to object type Mutation
  • Field mergeBranch was added to object type Mutation
  • Type UpdateRepositoryInput was added
  • Type UpdateRepositoryPayload was added
  • Type MergeBranchInput was added
  • Type MergeBranchPayload was added
  • Type ProjectTemplate was added

The Audit Log preview includes these changes:

  • Field businessUrl was removed from object type RepositoryVisibilityChangeEnableAuditEntry
  • Field businessSlug was removed from object type RepositoryVisibilityChangeEnableAuditEntry
  • Field businessResourcePath was removed from object type RepositoryVisibilityChangeEnableAuditEntry
  • RepositoryVisibilityChangeEnableAuditEntry object type no longer implements BusinessAuditEntryData interface
  • Field businessUrl was removed from object type RepositoryVisibilityChangeDisableAuditEntry
  • Field businessSlug was removed from object type RepositoryVisibilityChangeDisableAuditEntry
  • Field businessResourcePath was removed from object type RepositoryVisibilityChangeDisableAuditEntry
  • RepositoryVisibilityChangeDisableAuditEntry object type no longer implements BusinessAuditEntryData interface
  • Field businessUrl was removed from object type PrivateRepositoryForkingEnableAuditEntry
  • Field businessSlug was removed from object type PrivateRepositoryForkingEnableAuditEntry
  • Field businessResourcePath was removed from object type PrivateRepositoryForkingEnableAuditEntry
  • PrivateRepositoryForkingEnableAuditEntry object type no longer implements BusinessAuditEntryData interface
  • Field businessUrl was removed from object type PrivateRepositoryForkingDisableAuditEntry
  • Field businessSlug was removed from object type PrivateRepositoryForkingDisableAuditEntry
  • Field businessResourcePath was removed from object type PrivateRepositoryForkingDisableAuditEntry
  • PrivateRepositoryForkingDisableAuditEntry object type no longer implements BusinessAuditEntryData interface
  • Field businessUrl was removed from object type OrgInviteToBusinessAuditEntry
  • Field businessSlug was removed from object type OrgInviteToBusinessAuditEntry
  • Field businessResourcePath was removed from object type OrgInviteToBusinessAuditEntry
  • OrgInviteToBusinessAuditEntry object type no longer implements BusinessAuditEntryData interface
  • Field businessUrl was removed from object type MembersCanDeleteReposEnableAuditEntry
  • Field businessSlug was removed from object type MembersCanDeleteReposEnableAuditEntry
  • Field businessResourcePath was removed from object type MembersCanDeleteReposEnableAuditEntry
  • MembersCanDeleteReposEnableAuditEntry object type no longer implements BusinessAuditEntryData interface
  • Field businessUrl was removed from object type MembersCanDeleteReposDisableAuditEntry
  • Field businessSlug was removed from object type MembersCanDeleteReposDisableAuditEntry
  • Field businessResourcePath was removed from object type MembersCanDeleteReposDisableAuditEntry
  • MembersCanDeleteReposDisableAuditEntry object type no longer implements BusinessAuditEntryData interface
  • Field businessUrl was removed from object type MembersCanDeleteReposClearAuditEntry
  • Field businessSlug was removed from object type MembersCanDeleteReposClearAuditEntry
  • Field businessResourcePath was removed from object type MembersCanDeleteReposClearAuditEntry
  • MembersCanDeleteReposClearAuditEntry object type no longer implements BusinessAuditEntryData interface
  • RepositoryVisibilityChangeEnableAuditEntry object implements EnterpriseAuditEntryData interface
  • RepositoryVisibilityChangeDisableAuditEntry object implements EnterpriseAuditEntryData interface
  • PrivateRepositoryForkingEnableAuditEntry object implements EnterpriseAuditEntryData interface
  • PrivateRepositoryForkingDisableAuditEntry object implements EnterpriseAuditEntryData interface
  • OrgInviteToBusinessAuditEntry object implements EnterpriseAuditEntryData interface
  • MembersCanDeleteReposEnableAuditEntry object implements EnterpriseAuditEntryData interface
  • MembersCanDeleteReposDisableAuditEntry object implements EnterpriseAuditEntryData interface
  • MembersCanDeleteReposClearAuditEntry object implements EnterpriseAuditEntryData interface
  • Field enterpriseUrl was added to object type RepositoryVisibilityChangeEnableAuditEntry
  • Field enterpriseSlug was added to object type RepositoryVisibilityChangeEnableAuditEntry
  • Field enterpriseResourcePath was added to object type RepositoryVisibilityChangeEnableAuditEntry
  • Field enterpriseUrl was added to object type RepositoryVisibilityChangeDisableAuditEntry
  • Field enterpriseSlug was added to object type RepositoryVisibilityChangeDisableAuditEntry
  • Field enterpriseResourcePath was added to object type RepositoryVisibilityChangeDisableAuditEntry
  • Field enterpriseUrl was added to object type PrivateRepositoryForkingEnableAuditEntry
  • Field enterpriseSlug was added to object type PrivateRepositoryForkingEnableAuditEntry
  • Field enterpriseResourcePath was added to object type PrivateRepositoryForkingEnableAuditEntry
  • Field enterpriseUrl was added to object type PrivateRepositoryForkingDisableAuditEntry
  • Field enterpriseSlug was added to object type PrivateRepositoryForkingDisableAuditEntry
  • Field enterpriseResourcePath was added to object type PrivateRepositoryForkingDisableAuditEntry
  • Field enterpriseUrl was added to object type OrgInviteToBusinessAuditEntry
  • Field enterpriseSlug was added to object type OrgInviteToBusinessAuditEntry
  • Field enterpriseResourcePath was added to object type OrgInviteToBusinessAuditEntry
  • Field enterpriseUrl was added to object type MembersCanDeleteReposEnableAuditEntry
  • Field enterpriseSlug was added to object type MembersCanDeleteReposEnableAuditEntry
  • Field enterpriseResourcePath was added to object type MembersCanDeleteReposEnableAuditEntry
  • Field enterpriseUrl was added to object type MembersCanDeleteReposDisableAuditEntry
  • Field enterpriseSlug was added to object type MembersCanDeleteReposDisableAuditEntry
  • Field enterpriseResourcePath was added to object type MembersCanDeleteReposDisableAuditEntry
  • Field enterpriseUrl was added to object type MembersCanDeleteReposClearAuditEntry
  • Field enterpriseSlug was added to object type MembersCanDeleteReposClearAuditEntry
  • Field enterpriseResourcePath was added to object type MembersCanDeleteReposClearAuditEntry
  • Type EnterpriseAuditEntryData was added

GraphQL Schema Changes for 2019-07-04

The GraphQL schema includes these changes:

  • Enum value READY_FOR_REVIEW_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member ReadyForReviewEvent was added to Union type PullRequestTimelineItems
  • Type ReadyForReviewEvent was added

GraphQL Schema Changes for 2019-06-28

The following changes will be made to the schema:

  • On member Organization.pinnedRepositories: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead. Effective 2019-10-01.
  • On member RepositoryOwner.pinnedRepositories: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead. Effective 2019-10-01.
  • On member RepositoryVulnerabilityAlert.affectedRange: affectedRange will be removed. Use securityVulnerability.vulnerableVersionRange instead. Effective 2019-10-01.
  • On member RepositoryVulnerabilityAlert.externalIdentifier: externalIdentifier will be removed. Use securityAdvisory.identifiers instead. Effective 2019-10-01.
  • On member RepositoryVulnerabilityAlert.externalReference: externalReference will be removed. Use securityAdvisory.references instead. Effective 2019-10-01.
  • On member RepositoryVulnerabilityAlert.fixedIn: fixedIn will be removed. Use securityVulnerability.firstPatchedVersion instead. Effective 2019-10-01.
  • On member RepositoryVulnerabilityAlert.packageName: packageName will be removed. Use securityVulnerability.package instead. Effective 2019-10-01.
  • On member User.pinnedRepositories: pinnedRepositories will be removed. Use ProfileOwner.pinnedItems instead. Effective 2019-10-01.

The GraphQL schema includes these changes:

  • Field updateRef was added to object type Mutation
  • Field deleteRef was added to object type Mutation
  • Field createRef was added to object type Mutation
  • Type UpdateRefInput was added
  • Type UpdateRefPayload was added
  • Type DeleteRefInput was added
  • Type DeleteRefPayload was added
  • Type CreateRefInput was added
  • Type CreateRefPayload was added

GraphQL Schema Changes for 2019-06-26

The GraphQL schema includes these changes:

  • Field createRepository was added to object type Mutation
  • Type CreateRepositoryInput was added
  • Type CreateRepositoryPayload was added

GraphQL Schema Changes for 2019-06-25

The GraphQL schema includes these changes:

  • Field PublicKey.updatedAt changed type from DateTime! to DateTime
  • Field PublicKey.isReadOnly changed type from Boolean! to Boolean
  • Field PublicKey.createdAt changed type from DateTime! to DateTime
  • Field PublicKey.fingerprint changed type from String to String!
  • Field issuePrioritiesDebug was added to object type Milestone

GraphQL Schema Changes for 2019-06-19

The GraphQL schema includes these changes:

  • Union member App was added to Union type SearchResultItem
  • Field cloneTemplateRepository was added to object type Mutation
  • Field isTemplate was added to object type RepositoryInfo
  • Field templateRepository was added to object type Repository
  • Field isTemplate was added to object type Repository
  • Type RepositoryVisibility was added
  • Type CloneTemplateRepositoryInput was added
  • Type CloneTemplateRepositoryPayload was added

GraphQL Schema Changes for 2019-06-14

The following changes will be made to the schema:

  • On member ContributionOrder.field: field will be removed. Only one order field is supported. Effective 2019-10-01.

The GraphQL schema includes these changes:

  • Input field ContributionOrder.field changed type from ContributionOrderField! to ContributionOrderField

GraphQL Schema Changes for 2019-06-13

The GraphQL schema includes these changes:

  • Argument oid: GitObjectID added to field Gist.files
  • Field forks was added to object type Gist

GraphQL Schema Changes for 2019-06-12

The GraphQL schema includes these changes:

  • Enum value USER was added to enum PinnableItemType
  • Enum value TEAM was added to enum PinnableItemType
  • Enum value PULL_REQUEST was added to enum PinnableItemType
  • Enum value PROJECT was added to enum PinnableItemType
  • Enum value ORGANIZATION was added to enum PinnableItemType
  • Field requiresCodeOwnerReviews was added to object type BranchProtectionRule

The Labels Preview preview includes these changes:

  • Input field description was added to input object type UpdateLabelInput
  • Input field description was added to input object type CreateLabelInput

Subscribe to the RSS feed