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

The GraphQL schema includes these changes:

  • Union member App was added to Union type PushAllowanceActor

GraphQL Schema Changes for 2019-08-21

The GraphQL schema includes these changes:

  • Field shortDescriptionHTML was added to object type Release
  • Field descriptionHTML was added to object type Release

GraphQL Schema Changes for 2019-08-15

The GraphQL schema includes these changes:

  • Field removeEnterpriseIdentityProvider was removed from object type Mutation
  • Type RemoveEnterpriseIdentityProviderInput was removed
  • Type RemoveEnterpriseIdentityProviderPayload was removed
  • Enum value ARCHIVED was added to enum CommentCannotUpdateReason

GraphQL Schema Changes for 2019-08-13

The GraphQL schema includes these changes:

  • Field setEnterpriseIdentityProvider was removed from object type Mutation
  • Type SetEnterpriseIdentityProviderInput was removed
  • Type SetEnterpriseIdentityProviderPayload was removed

GraphQL Schema Changes for 2019-08-09

The GraphQL schema includes these changes:

  • Field transferIssue was added to object type Mutation
  • Type TransferIssueInput was added
  • Type TransferIssuePayload was added

GraphQL Schema Changes for 2019-08-08

The GraphQL schema includes these changes:

  • Union member RepoRemoveTopicAuditEntry was added to Union type OrganizationAuditEntry
  • Union member RepoDestroyAuditEntry was added to Union type OrganizationAuditEntry
  • Union member RepoCreateAuditEntry was added to Union type OrganizationAuditEntry
  • Union member RepoChangeMergeSettingAuditEntry was added to Union type OrganizationAuditEntry
  • Union member RepoArchivedAuditEntry was added to Union type OrganizationAuditEntry
  • Union member RepoAddTopicAuditEntry was added to Union type OrganizationAuditEntry
  • Type UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput was added
  • Type UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload was added
  • Type UpdateEnterpriseTeamDiscussionsSettingInput was added
  • Type UpdateEnterpriseTeamDiscussionsSettingPayload was added
  • Type UpdateEnterpriseRepositoryProjectsSettingInput was added
  • Type UpdateEnterpriseRepositoryProjectsSettingPayload was added
  • Type UpdateEnterpriseProfileInput was added
  • Type UpdateEnterpriseProfilePayload was added
  • Type UpdateEnterpriseOrganizationProjectsSettingInput was added
  • Type UpdateEnterpriseOrganizationProjectsSettingPayload was added
  • Type UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput was added
  • Type UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload was added
  • Type UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput was added
  • Type UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload was added
  • Type UpdateEnterpriseMembersCanMakePurchasesSettingInput was added
  • Type UpdateEnterpriseMembersCanMakePurchasesSettingPayload was added
  • Type UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput was added
  • Type UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload was added
  • Type UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput was added
  • Type UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload was added
  • Type UpdateEnterpriseMembersCanDeleteIssuesSettingInput was added
  • Type UpdateEnterpriseMembersCanDeleteIssuesSettingPayload was added
  • Type UpdateEnterpriseMembersCanCreateRepositoriesSettingInput was added
  • Type UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload was added
  • Type UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput was added
  • Type UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload was added
  • Type UpdateEnterpriseDefaultRepositoryPermissionSettingInput was added
  • Type UpdateEnterpriseDefaultRepositoryPermissionSettingPayload was added
  • Type UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput was added
  • Type UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload was added
  • Type UpdateEnterpriseAdministratorRoleInput was added
  • Type UpdateEnterpriseAdministratorRolePayload was added
  • Type UpdateEnterpriseActionExecutionCapabilitySettingInput was added
  • Type UpdateEnterpriseActionExecutionCapabilitySettingPayload was added
  • Type SetEnterpriseIdentityProviderInput was added
  • Type SetEnterpriseIdentityProviderPayload was added
  • Type RemoveEnterpriseOrganizationInput was added
  • Type RemoveEnterpriseOrganizationPayload was added
  • Type RemoveEnterpriseIdentityProviderInput was added
  • Type RemoveEnterpriseIdentityProviderPayload was added
  • Type RemoveEnterpriseAdminInput was added
  • Type RemoveEnterpriseAdminPayload was added
  • Type RegenerateEnterpriseIdentityProviderRecoveryCodesInput was added
  • Type RegenerateEnterpriseIdentityProviderRecoveryCodesPayload was added
  • Type InviteEnterpriseAdminInput was added
  • Type InviteEnterpriseAdminPayload was added
  • Type CreateEnterpriseOrganizationInput was added
  • Type CreateEnterpriseOrganizationPayload was added
  • Type CancelEnterpriseAdminInvitationInput was added
  • Type CancelEnterpriseAdminInvitationPayload was added
  • Type AcceptEnterpriseAdministratorInvitationInput was added
  • Type AcceptEnterpriseAdministratorInvitationPayload was added
  • Type EnterpriseUserAccountEdge was added
  • Type EnterpriseUserAccountConnection was added
  • Type IdentityProviderConfigurationState was added
  • Type EnterpriseAdministratorInvitationEdge was added
  • Type EnterpriseAdministratorInvitationConnection was added
  • Type EnterpriseRepositoryInfoEdge was added
  • Type EnterpriseRepositoryInfoConnection was added
  • Type EnterpriseServerUserAccountsUploadEdge was added
  • Type EnterpriseServerUserAccountsUploadConnection was added
  • Type EnterpriseServerUserAccountEmailEdge was added
  • Type EnterpriseServerUserAccountEmailConnection was added
  • Type EnterpriseServerUserAccountEdge was added
  • Type EnterpriseServerUserAccountConnection was added
  • Type EnterpriseServerInstallationEdge was added
  • Type EnterpriseServerInstallationConnection was added
  • Type RepoRemoveTopicAuditEntry was added
  • Type RepoDestroyAuditEntryVisibility was added
  • Type RepoDestroyAuditEntry was added
  • Type RepoCreateAuditEntryVisibility was added
  • Type RepoCreateAuditEntry was added
  • Type RepoChangeMergeSettingAuditEntryMergeType was added
  • Type RepoChangeMergeSettingAuditEntry was added
  • Type RepoArchivedAuditEntryVisibility was added
  • Type RepoArchivedAuditEntry was added
  • Type TopicAuditEntryData was added
  • Type RepoAddTopicAuditEntry was added

The Enterprise accounts preview includes these changes:

  • Field updateEnterpriseTwoFactorAuthenticationRequiredSetting was added to object type Mutation
  • Field updateEnterpriseTeamDiscussionsSetting was added to object type Mutation
  • Field updateEnterpriseRepositoryProjectsSetting was added to object type Mutation
  • Field updateEnterpriseProfile was added to object type Mutation
  • Field updateEnterpriseOrganizationProjectsSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanViewDependencyInsightsSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanUpdateProtectedBranchesSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanMakePurchasesSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanInviteCollaboratorsSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanDeleteRepositoriesSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanDeleteIssuesSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanCreateRepositoriesSetting was added to object type Mutation
  • Field updateEnterpriseMembersCanChangeRepositoryVisibilitySetting was added to object type Mutation
  • Field updateEnterpriseDefaultRepositoryPermissionSetting was added to object type Mutation
  • Field updateEnterpriseAllowPrivateRepositoryForkingSetting was added to object type Mutation
  • Field updateEnterpriseAdministratorRole was added to object type Mutation
  • Field updateEnterpriseActionExecutionCapabilitySetting was added to object type Mutation
  • Field setEnterpriseIdentityProvider was added to object type Mutation
  • Field removeEnterpriseOrganization was added to object type Mutation
  • Field removeEnterpriseIdentityProvider was added to object type Mutation
  • Field removeEnterpriseAdmin was added to object type Mutation
  • Field regenerateEnterpriseIdentityProviderRecoveryCodes was added to object type Mutation
  • Field inviteEnterpriseAdmin was added to object type Mutation
  • Field createEnterpriseOrganization was added to object type Mutation
  • Field cancelEnterpriseAdminInvitation was added to object type Mutation
  • Field acceptEnterpriseAdministratorInvitation was added to object type Mutation
  • Field enterpriseAdministratorInvitationByToken was added to object type Query
  • Field enterpriseAdministratorInvitation was added to object type Query
  • Field enterprise was added to object type Query
  • Type EnterpriseOrderField was added
  • Type ActionExecutionCapabilitySetting was added
  • Type EnterpriseEnabledSettingValue was added
  • Type SamlSignatureAlgorithm was added
  • Type SamlDigestAlgorithm was added
  • Type EnterpriseIdentityProvider was added
  • Type EnterprisePendingMemberInvitationEdge was added
  • Type EnterprisePendingMemberInvitationConnection was added
  • Type RepositoryInvitationOrderField was added
  • Type RepositoryInvitationOrder was added
  • Type EnterprisePendingCollaboratorEdge was added
  • Type EnterprisePendingCollaboratorConnection was added
  • Type EnterpriseAdministratorInvitationOrderField was added
  • Type EnterpriseAdministratorInvitationOrder was added
  • Type EnterpriseAdministratorInvitation was added
  • Type EnterpriseRepositoryInfo was added
  • Type EnterpriseOutsideCollaboratorEdge was added
  • Type EnterpriseOutsideCollaboratorConnection was added
  • Type EnterpriseMembersCanMakePurchasesSettingValue was added
  • Type OrganizationMembersCanCreateRepositoriesSettingValue was added
  • Type EnterpriseMembersCanCreateRepositoriesSettingValue was added
  • Type EnterpriseServerInstallationOrderField was added
  • Type EnterpriseServerInstallationOrder was added
  • Type EnterpriseServerUserAccountsUploadOrderField was added
  • Type EnterpriseServerUserAccountsUploadOrder was added
  • Type EnterpriseServerUserAccountsUploadSyncState was added
  • Type EnterpriseServerUserAccountsUpload was added
  • Type EnterpriseServerUserAccountOrderField was added
  • Type EnterpriseServerUserAccountOrder was added
  • Type EnterpriseServerUserAccountEmailOrderField was added
  • Type EnterpriseServerUserAccountEmailOrder was added
  • Type EnterpriseServerUserAccountEmail was added
  • Type EnterpriseServerUserAccount was added
  • Type EnterpriseServerInstallation was added
  • Type EnterpriseDefaultRepositoryPermissionSettingValue was added
  • Type EnterpriseEnabledDisabledSettingValue was added
  • Type EnterpriseAdministratorRole was added
  • Type EnterpriseAdministratorEdge was added
  • Type EnterpriseAdministratorConnection was added
  • Type EnterpriseOwnerInfo was added
  • Type EnterpriseMemberOrderField was added
  • Type EnterpriseMemberOrder was added
  • Type EnterpriseUserDeployment was added
  • Type OrganizationOrderField was added
  • Type OrganizationOrder was added
  • Type EnterpriseUserAccountMembershipRole was added
  • Type EnterpriseOrganizationMembershipEdge was added
  • Type EnterpriseOrganizationMembershipConnection was added
  • Type EnterpriseUserAccount was added
  • Type EnterpriseMember was added
  • Type EnterpriseMemberEdge was added
  • Type EnterpriseMemberConnection was added
  • Type EnterpriseBillingInfo was added
  • Type Enterprise was added

GraphQL Schema Changes for 2019-07-31

The GraphQL schema includes these changes:

  • Enum value MARKED_AS_DUPLICATE_EVENT was added to enum IssueTimelineItemsItemType
  • Union member MarkedAsDuplicateEvent was added to Union type IssueTimelineItems
  • Enum value MARKED_AS_DUPLICATE_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member MarkedAsDuplicateEvent was added to Union type PullRequestTimelineItems
  • Argument publicOnly: Boolean added to field RegistryPackageOwner.registryPackages
  • Argument publicOnly: Boolean added to field Repository.registryPackages
  • Argument publicOnly: Boolean added to field User.registryPackages
  • Argument publicOnly: Boolean added to field Organization.registryPackages
  • Type IssueOrPullRequestEdge was added
  • Type MarkedAsDuplicateEvent was added

GraphQL Schema Changes for 2019-07-29

The GraphQL schema includes these changes:

  • User object implements Sponsorable interface
  • Field sponsorshipsAsSponsor was added to object type User
  • Field sponsorshipsAsMaintainer was added to object type User
  • Type SponsorshipOrder was added
  • Type SponsorshipPrivacy was added
  • Type Sponsorship was added
  • Type SponsorshipEdge was added
  • Type SponsorshipConnection was added
  • Type Sponsorable was added

GraphQL Schema Changes for 2019-07-26

The GraphQL schema includes these changes:

  • Field registryPackagesForQuery was added to object type RegistryPackageSearch
  • Field registryPackages was added to object type RegistryPackageOwner
  • Field registryPackages was added to object type Repository
  • Field registryPackagesForQuery was added to object type User
  • Field registryPackages was added to object type User
  • Field registryPackagesForQuery was added to object type Organization
  • Field registryPackages was added to object type Organization
  • Type RegistryPackageMetadatum was added
  • Type RegistryPackageTag was added
  • Type RegistryPackageTagEdge was added
  • Type RegistryPackageTagConnection was added
  • Type RegistryPackageStatistics was added
  • Type RegistryPackageVersionEdge was added
  • Type RegistryPackageVersionConnection was added
  • Type RegistryPackageType was added
  • Type RegistryPackageVersionStatistics was added
  • Type RegistryPackageFileEdge was added
  • Type RegistryPackageFileConnection was added
  • Type RegistryPackageFile was added
  • Type RegistryPackageDependencyType was added
  • Type RegistryPackageDependency was added
  • Type RegistryPackageDependencyEdge was added
  • Type RegistryPackageDependencyConnection was added
  • Type RegistryPackageVersion was added
  • Type RegistryPackage was added
  • Type RegistryPackageEdge was added
  • Type RegistryPackageConnection was added

GraphQL Schema Changes for 2019-07-24

The GraphQL schema includes these changes:

  • Union member Bot was added to Union type Assignee
  • Field emojiHTML was added to object type UserStatus

The Checks preview includes these changes:

  • Field url was added to object type CheckSuite
  • Field resourcePath was added to object type CheckSuite