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

GraphQL Schema Changes for 2019-06-04

The following changes will be made to the schema:

  • On member Issue.timeline: timeline will be removed. Use Issue.timelineItems instead. Effective 2019-10-01.
  • On member PullRequest.timeline: timeline will be removed. Use PullRequest.timelineItems instead. Effective 2019-10-01.

GraphQL Schema Changes for 2019-05-31

The GraphQL schema includes these changes:

  • Input field expiresAt was added to input object type ChangeUserStatusInput
  • Field avatarUrl was added to object type StatusContext
  • Field expiresAt was added to object type UserStatus

GraphQL Schema Changes for 2019-05-29

The GraphQL schema includes these changes:

  • Enum value TRIAGE was added to enum RepositoryPermission
  • Enum value MAINTAIN was added to enum RepositoryPermission
  • Field openGraphImageUrl was added to object type Repository
  • Field openGraphImageUrl was added to object type RepositoryInfo
  • Field usesCustomOpenGraphImage was added to object type Repository
  • Field usesCustomOpenGraphImage was added to object type RepositoryInfo

GraphQL Schema Changes for 2019-05-23

The GraphQL schema includes these changes:

  • Type OrganizationAuditEntryEdge was added
  • Type OrganizationAuditEntryConnection was added

The Audit Log preview includes these changes:

  • Field auditLog was added to object type Organization
  • Type AuditLogOrderField was added
  • Type AuditLogOrder was added
  • Type TeamRemoveRepositoryAuditEntry was added
  • Type TeamRemoveMemberAuditEntry was added
  • Type TeamChangeParentTeamAuditEntry was added
  • Type TeamAddRepositoryAuditEntry was added
  • Type TeamAddMemberAuditEntry was added
  • Type RepositoryVisibilityChangeEnableAuditEntry was added
  • Type RepositoryVisibilityChangeDisableAuditEntry was added
  • Type RepoRemoveMemberAuditEntryVisibility was added
  • Type RepoRemoveMemberAuditEntry was added
  • Type RepoConfigUnlockAnonymousGitAccessAuditEntry was added
  • Type RepoConfigLockAnonymousGitAccessAuditEntry was added
  • Type RepoConfigEnableSockpuppetDisallowedAuditEntry was added
  • Type RepoConfigEnableContributorsOnlyAuditEntry was added
  • Type RepoConfigEnableCollaboratorsOnlyAuditEntry was added
  • Type RepoConfigEnableAnonymousGitAccessAuditEntry was added
  • Type RepoConfigDisableSockpuppetDisallowedAuditEntry was added
  • Type RepoConfigDisableContributorsOnlyAuditEntry was added
  • Type RepoConfigDisableCollaboratorsOnlyAuditEntry was added
  • Type RepoConfigDisableAnonymousGitAccessAuditEntry was added
  • Type RepoAddMemberAuditEntryVisibility was added
  • Type RepoAddMemberAuditEntry was added
  • Type RepoAccessAuditEntryVisibility was added
  • Type RepoAccessAuditEntry was added
  • Type PrivateRepositoryForkingEnableAuditEntry was added
  • Type PrivateRepositoryForkingDisableAuditEntry was added
  • Type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry was added
  • Type OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility was added
  • Type OrgUpdateMemberRepositoryCreationPermissionAuditEntry was added
  • Type OrgUpdateMemberAuditEntryPermission was added
  • Type OrgUpdateMemberAuditEntry was added
  • Type OrgUpdateDefaultRepositoryPermissionAuditEntryPermission was added
  • Type OrgUpdateDefaultRepositoryPermissionAuditEntry was added
  • Type OrgUnblockUserAuditEntry was added
  • Type TeamAuditEntryData was added
  • Type OrgRestoreMemberMembershipTeamAuditEntryData was added
  • Type RepositoryAuditEntryData was added
  • Type OrgRestoreMemberMembershipRepositoryAuditEntryData was added
  • Type OrgRestoreMemberMembershipOrganizationAuditEntryData was added
  • Type OrgRestoreMemberAuditEntryMembership was added
  • Type OrgRestoreMemberAuditEntry was added
  • Type OrgRemoveOutsideCollaboratorAuditEntryReason was added
  • Type OrgRemoveOutsideCollaboratorAuditEntryMembershipType was added
  • Type OrgRemoveOutsideCollaboratorAuditEntry was added
  • Type OrgRemoveMemberAuditEntryReason was added
  • Type OrgRemoveMemberAuditEntryMembershipType was added
  • Type OrgRemoveMemberAuditEntry was added
  • Type OrgRemoveBillingManagerAuditEntryReason was added
  • Type OrgRemoveBillingManagerAuditEntry was added
  • Type OrgOauthAppAccessRequestedAuditEntry was added
  • Type OrgOauthAppAccessDeniedAuditEntry was added
  • Type OrgOauthAppAccessApprovedAuditEntry was added
  • Type OrgInviteToBusinessAuditEntry was added
  • Type OrgInviteMemberAuditEntry was added
  • Type OrgEnableTwoFactorRequirementAuditEntry was added
  • Type OrgEnableSamlAuditEntry was added
  • Type OrgEnableOauthAppRestrictionsAuditEntry was added
  • Type OrgDisableTwoFactorRequirementAuditEntry was added
  • Type OrgDisableSamlAuditEntry was added
  • Type OrgDisableOauthAppRestrictionsAuditEntry was added
  • Type OrgConfigEnableCollaboratorsOnlyAuditEntry was added
  • Type OrgConfigDisableCollaboratorsOnlyAuditEntry was added
  • Type OrgBlockUserAuditEntry was added
  • Type OrgAddMemberAuditEntryPermission was added
  • Type OrgAddMemberAuditEntry was added
  • Type OrgAddBillingManagerAuditEntry was added
  • Type OauthApplicationCreateAuditEntryState was added
  • Type OauthApplicationAuditEntryData was added
  • Type OauthApplicationCreateAuditEntry was added
  • Type MembersCanDeleteReposEnableAuditEntry was added
  • Type MembersCanDeleteReposDisableAuditEntry was added
  • Type OrganizationAuditEntryData was added
  • Type BusinessAuditEntryData was added
  • Type PreciseDateTime was added
  • Type ActorLocation was added
  • Type AuditEntryActor was added
  • Type AuditEntry was added
  • Type MembersCanDeleteReposClearAuditEntry was added
  • Type OrganizationAuditEntry was added

GraphQL Schema Changes for 2019-05-13

The GraphQL schema includes these changes:

  • Enum value ISSUE was added to enum PinnableItemType
  • Field origin was added to object type SecurityAdvisory

GraphQL Schema Changes for 2019-05-09

The GraphQL schema includes these changes:

  • Union member Mannequin was added to Union type RequestedReviewer
  • Type Mannequin was added

GraphQL Schema Changes for 2019-04-23

The following changes will be made to the schema:

  • On member MarketplaceListing.hasApprovalBeenRequested: hasApprovalBeenRequested will be removed. Use isVerificationPendingFromDraft instead. Effective 2019-10-01.
  • On member MarketplaceListing.isApproved: isApproved will be removed. Use isPublic instead. Effective 2019-10-01.
  • On member MarketplaceListing.isDelisted: isDelisted will be removed. Use isArchived instead. Effective 2019-10-01.

The GraphQL schema includes these changes:

  • Field isArchived was added to object type MarketplaceListing