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

February 12, 2019
hubot

The GraphQL schema includes these changes:

Field updatedAt was added to object type PublicKey
Field isReadOnly was added to object type PublicKey
Field fingerprint was added to object type PublicKey
Field createdAt was added to object type PublicKey
Field accessedAt was added to object type PublicKey
Field hasTwoFactorEnabled was added to object type OrganizationMemberEdge
Type SetBusinessIdentityProviderInput was added
Type SetBusinessIdentityProviderPayload was added
Type RemoveBusinessIdentityProviderInput was added
Type RemoveBusinessIdentityProviderPayload was added
Type RegenerateBusinessIdentityProviderRecoveryCodesInput was added
Type RegenerateBusinessIdentityProviderRecoveryCodesPayload was added

The Unified business identity preview includes these changes:

Field setBusinessIdentityProvider was added to object type Mutation
Field removeBusinessIdentityProvider was added to object type Mutation
Field regenerateBusinessIdentityProviderRecoveryCodes was added to object type Mutation
Field twoFactorRequiredSettingOrganizations was added to object type BusinessAdminInfo
Field teamDiscussionsSettingOrganizations was added to object type BusinessAdminInfo
Field samlIdentityProvider was added to object type BusinessAdminInfo
Field repositoryProjectsSettingOrganizations was added to object type BusinessAdminInfo
Field organizationProjectsSettingOrganizations was added to object type BusinessAdminInfo
Field membersCanInviteCollaboratorsSettingOrganizations was added to object type BusinessAdminInfo
Field membersCanDeleteRepositoriesSettingOrganizations was added to object type BusinessAdminInfo
Field membersCanDeleteIssuesSettingOrganizations was added to object type BusinessAdminInfo
Field membersCanCreateRepositoriesSettingOrganizations was added to object type BusinessAdminInfo
Field membersCanChangeRepositoryVisibilitySettingOrganizations was added to object type BusinessAdminInfo
Field defaultRepositoryPermissionSettingOrganizations was added to object type BusinessAdminInfo
Field allowPrivateRepositoryForkingSettingOrganizations was added to object type BusinessAdminInfo
Type SamlSignatureAlgorithm was added
Type SamlDigestAlgorithm was added
Type BusinessIdentityProvider was added
Type OrganizationMembersCanCreateRepositoriesSettingValue was added

GraphQL Schema Changes for 2019-02-09

February 9, 2019
hubot

The GraphQL schema includes these changes:

Default value for argument orderBy on field Commit.deployments changed from {"field"=>"CREATED_AT", "direction"=>"DESC"} to {"field"=>"CREATED_AT", "direction"=>"ASC"}
Default value for argument orderBy on field Repository.deployments changed from {"field"=>"CREATED_AT", "direction"=>"DESC"} to {"field"=>"CREATED_AT", "direction"=>"ASC"}

GraphQL Schema Changes for 2019-02-07

February 7, 2019
hubot

The following changes will be made to the schema:

On member RepositoryVulnerabilityAlert.affectedRange: affectedRange will be removed. Use securityVulnerability.vulnerableVersionRange instead. Effective 2019-07-01.
On member RepositoryVulnerabilityAlert.externalIdentifier: externalIdentifier will be removed. Use securityAdvisory.identifiers instead. Effective 2019-07-01.
On member RepositoryVulnerabilityAlert.externalReference: externalReference will be removed. Use securityAdvisory.references instead. Effective 2019-07-01.
On member RepositoryVulnerabilityAlert.fixedIn: fixedIn will be removed. Use securityVulnerability.firstPatchedVersion instead. Effective 2019-07-01.
On member RepositoryVulnerabilityAlert.packageName: packageName will be removed. Use securityVulnerability.package instead. Effective 2019-07-01.

The GraphQL schema includes these changes:

Type DefaultRepositoryPermissionField was added

The Repository Vulnerability Alerts preview includes these changes:

Field RepositoryVulnerabilityAlert.externalReference changed type from String to String!
Field vulnerableRequirements was added to object type RepositoryVulnerabilityAlert
Field vulnerableManifestPath was added to object type RepositoryVulnerabilityAlert
Field vulnerableManifestFilename was added to object type RepositoryVulnerabilityAlert
Field securityVulnerability was added to object type RepositoryVulnerabilityAlert
Field securityAdvisory was added to object type RepositoryVulnerabilityAlert

GraphQL Schema Changes for 2019-02-06

February 6, 2019
hubot

The following changes will be made to the schema:

On member ReviewDismissedEvent.message: message will be removed. Use dismissalMessage instead. Effective 2019-07-01.
On member ReviewDismissedEvent.messageHtml: messageHtml will be removed. Use dismissalMessageHTML instead. Effective 2019-07-01.

The GraphQL schema includes these changes:

Enum value QUEUED was added to enum DeploymentStatusState
Enum value IN_PROGRESS was added to enum DeploymentStatusState
Field dismissalMessageHTML was added to object type ReviewDismissedEvent
Field dismissalMessage was added to object type ReviewDismissedEvent

GraphQL Schema Changes for 2019-02-04

February 4, 2019
hubot

The GraphQL schema includes these changes:

Field deployments was added to object type Commit
Argument orderBy: DeploymentOrder added to field Repository.deployments
Type UpdateBusinessTwoFactorAuthenticationRequiredSettingInput was added
Type UpdateBusinessTwoFactorAuthenticationRequiredSettingPayload was added
Type UpdateBusinessTeamDiscussionsSettingInput was added
Type UpdateBusinessTeamDiscussionsSettingPayload was added
Type UpdateBusinessRepositoryProjectsSettingInput was added
Type UpdateBusinessRepositoryProjectsSettingPayload was added
Type UpdateBusinessProfileInput was added
Type UpdateBusinessProfilePayload was added
Type UpdateBusinessOrganizationProjectsSettingInput was added
Type UpdateBusinessOrganizationProjectsSettingPayload was added
Type UpdateBusinessMembersCanUpdateProtectedBranchesSettingInput was added
Type UpdateBusinessMembersCanUpdateProtectedBranchesSettingPayload was added
Type UpdateBusinessMembersCanInviteCollaboratorsSettingInput was added
Type UpdateBusinessMembersCanInviteCollaboratorsSettingPayload was added
Type UpdateBusinessMembersCanDeleteRepositoriesSettingInput was added
Type UpdateBusinessMembersCanDeleteRepositoriesSettingPayload was added
Type UpdateBusinessMembersCanDeleteIssuesSettingInput was added
Type UpdateBusinessMembersCanDeleteIssuesSettingPayload was added
Type UpdateBusinessMembersCanCreateRepositoriesSettingInput was added
Type UpdateBusinessMembersCanCreateRepositoriesSettingPayload was added
Type UpdateBusinessMembersCanChangeRepositoryVisibilitySettingInput was added
Type UpdateBusinessMembersCanChangeRepositoryVisibilitySettingPayload was added
Type UpdateBusinessDefaultRepositoryPermissionSettingInput was added
Type UpdateBusinessDefaultRepositoryPermissionSettingPayload was added
Type UpdateBusinessAllowPrivateRepositoryForkingSettingInput was added
Type UpdateBusinessAllowPrivateRepositoryForkingSettingPayload was added
Type RemoveBusinessBillingManagerInput was added
Type RemoveBusinessBillingManagerPayload was added
Type RemoveBusinessAdminInput was added
Type RemoveBusinessAdminPayload was added
Type InviteBusinessBillingManagerInput was added
Type InviteBusinessBillingManagerPayload was added
Type InviteBusinessAdminInput was added
Type InviteBusinessAdminPayload was added
Type CancelBusinessBillingManagerInvitationInput was added
Type CancelBusinessBillingManagerInvitationPayload was added
Type CancelBusinessAdminInvitationInput was added
Type CancelBusinessAdminInvitationPayload was added
Type AcceptBusinessMemberInvitationInput was added
Type AcceptBusinessMemberInvitationPayload was added
Type BusinessMemberInvitationEdge was added
Type BusinessMemberInvitationConnection was added
Type DeploymentOrderField was added
Type DeploymentOrder was added

The Unified business identity preview includes these changes:

Field updateBusinessTwoFactorAuthenticationRequiredSetting was added to object type Mutation
Field updateBusinessTeamDiscussionsSetting was added to object type Mutation
Field updateBusinessRepositoryProjectsSetting was added to object type Mutation
Field updateBusinessProfile was added to object type Mutation
Field updateBusinessOrganizationProjectsSetting was added to object type Mutation
Field updateBusinessMembersCanUpdateProtectedBranchesSetting was added to object type Mutation
Field updateBusinessMembersCanInviteCollaboratorsSetting was added to object type Mutation
Field updateBusinessMembersCanDeleteRepositoriesSetting was added to object type Mutation
Field updateBusinessMembersCanDeleteIssuesSetting was added to object type Mutation
Field updateBusinessMembersCanCreateRepositoriesSetting was added to object type Mutation
Field updateBusinessMembersCanChangeRepositoryVisibilitySetting was added to object type Mutation
Field updateBusinessDefaultRepositoryPermissionSetting was added to object type Mutation
Field updateBusinessAllowPrivateRepositoryForkingSetting was added to object type Mutation
Field removeBusinessBillingManager was added to object type Mutation
Field removeBusinessAdmin was added to object type Mutation
Field inviteBusinessBillingManager was added to object type Mutation
Field inviteBusinessAdmin was added to object type Mutation
Field cancelBusinessBillingManagerInvitation was added to object type Mutation
Field cancelBusinessAdminInvitation was added to object type Mutation
Field acceptBusinessMemberInvitation was added to object type Mutation
Field businessMemberInvitationByToken was added to object type Query
Field businessMemberInvitation was added to object type Query
Field business was added to object type Query
Type BusinessRepositoryInfo was added
Type OrganizationOrderField was added
Type OrganizationOrder was added
Type BusinessBillingInfo was added
Type BusinessEnabledSettingValue was added
Type BusinessPendingMemberInvitationConnection was added
Type BusinessMemberInvitationRole was added
Type BusinessMemberInvitation was added
Type BusinessMembersCanCreateRepositoriesSettingValue was added
Type BusinessDefaultRepositoryPermissionSettingValue was added
Type BusinessEnabledDisabledSettingValue was added
Type BusinessAdminInfo was added
Type Business was added