Skip to main content

GraphQL changelog for 2020

GraphQL schema changes from 2020.

Schema changes for 2020-12-09

The GraphQL schema includes these changes:

  • Field hasVerifiedOwner was added to object type MarketplaceListing

Schema changes for 2020-11-13

The GraphQL schema includes these changes:

  • Input field requiresLinearHistory was added to input object type UpdateBranchProtectionRuleInput
  • Input field allowsForcePushes was added to input object type UpdateBranchProtectionRuleInput
  • Input field allowsDeletions was added to input object type UpdateBranchProtectionRuleInput
  • Input field requiresLinearHistory was added to input object type CreateBranchProtectionRuleInput
  • Input field allowsForcePushes was added to input object type CreateBranchProtectionRuleInput
  • Input field allowsDeletions was added to input object type CreateBranchProtectionRuleInput
  • Field requiresLinearHistory was added to object type BranchProtectionRule
  • Field allowsForcePushes was added to object type BranchProtectionRule
  • Field allowsDeletions was added to object type BranchProtectionRule

Schema changes for 2020-10-12

The GraphQL schema includes these changes:

  • Field updateEnterpriseActionExecutionCapabilitySetting was removed from object type Mutation
  • Field actionExecutionCapabilitySettingOrganizations was removed from object type EnterpriseOwnerInfo
  • Type UpdateEnterpriseActionExecutionCapabilitySettingInput was removed
  • Type UpdateEnterpriseActionExecutionCapabilitySettingPayload was removed
  • Type ActionExecutionCapabilitySetting was removed

Schema changes for 2020-09-30

The GraphQL schema includes these changes:

  • Field issuePrioritiesDebug was removed from object type Milestone

Schema changes for 2020-09-23

The GraphQL schema includes these changes:

  • Field Blob.isBinary changed type from Boolean! to Boolean
  • Field Ref.target changed type from GitObject! to GitObject
  • Union member BaseRefDeletedEvent was added to Union type PullRequestTimelineItem
  • Enum value BASE_REF_DELETED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member BaseRefDeletedEvent was added to Union type PullRequestTimelineItems
  • Enum value PUBLIC_PRIVATE was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value PUBLIC_INTERNAL was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value PRIVATE_INTERNAL was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value PRIVATE was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value NONE was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value INTERNAL was added to enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
  • Enum value MANNEQUIN was added to enum CommentAuthorAssociation
  • Field path was added to object type TreeEntry
  • Field isGenerated was added to object type TreeEntry
  • Field extension was added to object type TreeEntry
  • Field used was added to object type RateLimit
  • Field asCodeOwner was added to object type ReviewRequest
  • Field viewerViewedState was added to object type PullRequestChangedFile
  • Field unmarkFileAsViewed was added to object type Mutation
  • Field markFileAsViewed was added to object type Mutation
  • Input field authorEmail was added to input object type MergePullRequestInput
  • Input field authorEmail was added to input object type MergeBranchInput
  • Field isCrossRepository was added to object type UnmarkedAsDuplicateEvent
  • Field duplicate was added to object type UnmarkedAsDuplicateEvent
  • Field canonical was added to object type UnmarkedAsDuplicateEvent
  • Field isCrossRepository was added to object type MarkedAsDuplicateEvent
  • Field duplicate was added to object type MarkedAsDuplicateEvent
  • Field canonical was added to object type MarkedAsDuplicateEvent
  • Field groups was added to object type ExternalIdentityScimAttributes
  • Field givenName was added to object type ExternalIdentityScimAttributes
  • Field familyName was added to object type ExternalIdentityScimAttributes
  • Field emails was added to object type ExternalIdentityScimAttributes
  • Field username was added to object type ExternalIdentitySamlAttributes
  • Field groups was added to object type ExternalIdentitySamlAttributes
  • Field givenName was added to object type ExternalIdentitySamlAttributes
  • Field familyName was added to object type ExternalIdentitySamlAttributes
  • Field emails was added to object type ExternalIdentitySamlAttributes
  • Field isInOrganization was added to object type RepositoryInfo
  • Field permalink was added to object type RepositoryInvitation
  • Input field issueTemplate was added to input object type CreateIssueInput
  • Field combinedContexts was added to object type Status
  • Field deletedCommentAuthor was added to object type CommentDeletedEvent
  • Field pullRequest was added to object type BaseRefChangedEvent
  • Field previousRefName was added to object type BaseRefChangedEvent
  • Field currentRefName was added to object type BaseRefChangedEvent
  • Field stargazerCount was added to object type Gist
  • Field refUpdateRule was added to object type Ref
  • Field branchProtectionRule was added to object type Ref
  • Argument query: String added to field Repository.milestones
  • Field viewerPossibleCommitEmails was added to object type Repository
  • Field viewerDefaultMergeMethod was added to object type Repository
  • Field viewerDefaultCommitEmail was added to object type Repository
  • Field securityPolicyUrl was added to object type Repository
  • Field issueTemplates was added to object type Repository
  • Field isUserConfigurationRepository was added to object type Repository
  • Field isSecurityPolicyEnabled was added to object type Repository
  • Field isEmpty was added to object type Repository
  • Field isBlankIssuesEnabled was added to object type Repository
  • Field contactLinks was added to object type Repository
  • Field stargazerCount was added to object type Repository
  • Field isInOrganization was added to object type Repository
  • Field viewerCanReply was added to object type PullRequestReviewThread
  • Field path was added to object type PullRequestReviewThread
  • Field isOutdated was added to object type PullRequestReviewThread
  • Field isCollapsed was added to object type PullRequestReviewThread
  • Input field AddPullRequestReviewThreadInput.pullRequestReviewId changed type from ID! to ID
  • Input field pullRequestId was added to input object type AddPullRequestReviewThreadInput
  • Field authorCanPushToRepository was added to object type PullRequestReview
  • Field progressPercentage was added to object type Milestone
  • Enum value MergeStateStatus.DRAFT was deprecated with reason DRAFT state will be removed from this enum and isDraft should be used instead Use PullRequest.isDraft instead. Removal on 2021-01-01 UTC.
  • Field viewerMergeHeadlineText was added to object type PullRequest
  • Field viewerMergeBodyText was added to object type PullRequest
  • Field viewerCanDeleteHeadRef was added to object type PullRequest
  • Field latestReviews was added to object type PullRequest
  • Field latestOpinionatedReviews was added to object type PullRequest
  • Field isReadByViewer was added to object type PullRequest
  • Field progress was added to object type Project
  • Field file was added to object type Commit
  • Field authors was added to object type Commit
  • Field isReadByViewer was added to object type Issue
  • Field bodyUrl was added to object type Issue
  • Field bodyResourcePath was added to object type Issue
  • Field stargazerCount was added to object type Starrable
  • Field stargazerCount was added to object type Topic
  • Type RepositoryContactLink was added
  • Type RefUpdateRule was added
  • Type ProjectProgress was added
  • Type UnmarkFileAsViewedInput was added
  • Type UnmarkFileAsViewedPayload was added
  • Type MarkFileAsViewedPayload was added
  • Type MarkFileAsViewedInput was added
  • Type GitActorEdge was added
  • Type FileViewedState was added
  • Type UserEmailMetadata was added
  • Type GitActorConnection was added
  • Type BaseRefDeletedEvent was added
  • Type IssueTemplate was added

The following changes will be made to the schema:

  • On member EnterprisePendingMemberInvitationEdge.isUnlicensed: isUnlicensed will be removed. Effective 2020-07-01.
  • On member EnterpriseMemberEdge.isUnlicensed: isUnlicensed will be removed. Effective 2021-01-01.
  • On member EnterpriseOutsideCollaboratorEdge.isUnlicensed: isUnlicensed will be removed. Effective 2021-01-01.
  • On member EnterprisePendingCollaboratorEdge.isUnlicensed: isUnlicensed will be removed. Effective 2021-01-01.
  • On member MergeStateStatus.DRAFT: DRAFT will be removed. Use PullRequest.isDraft instead. Effective 2021-01-01.

Schema changes for 2020-06-26

The GraphQL schema includes these changes:

  • Type TopicEdge was removed
  • Type RegistryPackageVersionEdge was removed
  • Type RegistryPackageVersionStatistics was removed
  • Type RegistryPackageTagEdge was removed
  • Type RegistryPackageFileEdge was removed
  • Type RegistryPackageDependencyEdge was removed
  • Type RegistryPackageMetadatum was removed
  • Type TopicConnection was removed
  • Type RegistryPackageTag was removed
  • Type RegistryPackageTagConnection was removed
  • Type RegistryPackageStatistics was removed
  • Type RegistryPackageVersionConnection was removed
  • Type RegistryPackageType was removed
  • Type RegistryPackage was removed
  • Type RegistryPackageFileConnection was removed
  • Type RegistryPackageFile was removed
  • Type RegistryPackageDependencyType was removed
  • Type RegistryPackageDependency was removed
  • Type RegistryPackageDependencyConnection was removed
  • Type RegistryPackageVersion was removed

Schema changes for 2020-06-23

The GraphQL schema includes these changes:

  • Argument packageType: PackageType added to field Organization.packages
  • Argument packageType: PackageType added to field User.packages
  • Argument packageType: PackageType added to field PackageOwner.packages
  • Argument packageType: PackageType added to field Repository.packages

Schema changes for 2020-06-18

The GraphQL schema includes these changes:

  • Field databaseId was added to object type Team

Schema changes for 2020-06-05

The GraphQL schema includes these changes:

  • Enum value TWO_FACTOR_ACCOUNT_RECOVERY was added to enum OrgRemoveMemberAuditEntryReason

Schema changes for 2020-06-01

The GraphQL schema includes these changes:

  • Field twitterUsername was added to object type Organization
  • Field twitterUsername was added to object type User

The following changes will be made to the schema:

  • On member Blob.isBinary: Type for isBinary will change from Boolean! to Boolean. Effective 2019-07-01.
  • On member Ref.target: Type for target will change from GitObject! to GitObject. Effective 2019-07-01.

Schema changes for 2020-05-23

The GraphQL schema includes these changes:

  • Field ipAllowListEntries was added to object type Organization
  • Field ipAllowListEnabledSetting was added to object type Organization

Schema changes for 2020-05-21

The GraphQL schema includes these changes:

  • Enum value AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Enum value AUTOMATIC_BASE_CHANGE_FAILED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member AutomaticBaseChangeSucceededEvent was added to Union type PullRequestTimelineItems
  • Union member AutomaticBaseChangeFailedEvent was added to Union type PullRequestTimelineItems
  • Type AutomaticBaseChangeSucceededEvent was added
  • Type AutomaticBaseChangeFailedEvent was added

The following changes will be made to the schema:

  • On member RepositoryCollaboratorEdge.permission: Type for permission will change from RepositoryPermission! to String. Effective 2020-10-01.
  • On member RepositoryInvitation.permission: Type for permission will change from RepositoryPermission! to String. Effective 2020-10-01.
  • On member TeamRepositoryEdge.permission: Type for permission will change from RepositoryPermission! to String. Effective 2020-10-01.

Schema changes for 2020-05-19

The GraphQL schema includes these changes:

  • Field RepositoryInvitation.invitee changed type from User! to User
  • Default value for argument orderBy on field EnterpriseOwnerInfo.pendingCollaborators changed from {"field"=>"INVITEE_LOGIN", "direction"=>"ASC"} to {"field"=>"CREATED_AT", "direction"=>"DESC"}
  • Enum value RepositoryInvitationOrderField.INVITEE_LOGIN was deprecated with reason `INVITEE_LOGIN is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee. Removal on 2020-10-01 UTC.`
  • Field email was added to object type RepositoryInvitation
  • Field pendingCollaboratorInvitations was added to object type EnterpriseOwnerInfo
  • Type RepositoryInvitationEdge was added
  • Type RepositoryInvitationConnection was added

The following changes will be made to the schema:

  • On member EnterpriseOwnerInfo.pendingCollaborators: pendingCollaborators will be removed. Use the pendingCollaboratorInvitations field instead. Effective 2020-10-01.
  • On member RepositoryInvitationOrderField.INVITEE_LOGIN: INVITEE_LOGIN will be removed. Effective 2020-10-01.

Schema changes for 2020-05-13

The GraphQL schema includes these changes:

  • Field packageName was removed from object type RepositoryVulnerabilityAlert
  • Field fixedIn was removed from object type RepositoryVulnerabilityAlert
  • Field externalReference was removed from object type RepositoryVulnerabilityAlert
  • Field externalIdentifier was removed from object type RepositoryVulnerabilityAlert
  • Field affectedRange was removed from object type RepositoryVulnerabilityAlert
  • Field isDelisted was removed from object type MarketplaceListing
  • Field isApproved was removed from object type MarketplaceListing
  • Field hasApprovalBeenRequested was removed from object type MarketplaceListing
  • Field pinnedRepositories was removed from object type RepositoryOwner
  • Input field field was removed from input object type ContributionOrder
  • Field pinnedRepositories was removed from object type Organization
  • Field pinnedRepositories was removed from object type User
  • Type ContributionOrderField was removed
  • Default value for argument orderBy on field PullRequestReviewContributionsByRepository.contributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field PullRequestContributionsByRepository.contributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field IssueContributionsByRepository.contributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.repositoryContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.pullRequestReviewContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.pullRequestContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}
  • Default value for argument orderBy on field ContributionsCollection.issueContributions changed from {"field"=>"OCCURRED_AT", "direction"=>"DESC"} to {"direction"=>"DESC"}

Schema changes for 2020-05-12

The GraphQL schema includes these changes:

  • Field organizationVerifiedDomainEmails was added to object type User

Schema changes for 2020-05-11

The GraphQL schema includes these changes:

  • Field sponsorEntity was added to object type Sponsorship
  • Type Sponsor was added

The following changes will be made to the schema:

  • On member Sponsorship.sponsor: sponsor will be removed. Use Sponsorship.sponsorEntity instead. Effective 2020-10-01.

Schema changes for 2020-05-01

The GraphQL schema includes these changes:

  • Input field includeAllBranches was added to input object type CloneTemplateRepositoryInput

Schema changes for 2020-04-23

The following changes will be made to the schema:

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

Schema changes for 2020-04-20

The GraphQL schema includes these changes:

  • Enum value USER_ACCOUNT_DELETED was added to enum OrgRemoveMemberAuditEntryReason

Schema changes for 2020-04-15

The GraphQL schema includes these changes:

  • Enum value CONVERT_TO_DRAFT_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member ConvertToDraftEvent was added to Union type PullRequestTimelineItems
  • Field DeploymentStatus.creator changed type from Actor to Actor!
  • Field isOverLimit was added to object type StarredRepositoryConnection
  • Field Deployment.creator changed type from Actor to Actor!
  • Field onBehalfOf was added to object type Commit
  • Type ConvertToDraftEvent was added

Schema changes for 2020-03-23

The GraphQL schema includes these changes:

  • Type IssueOrPullRequestEdge was removed
  • Default value for argument affiliations on field RepositoryOwner.repositories changed from ["OWNER", "COLLABORATOR"] to __no_default__
  • Default value for argument affiliations on field RepositoryOwner.pinnedRepositories changed from ["OWNER", "COLLABORATOR"] to __no_default__
  • Default value for argument affiliations on field Organization.repositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field Organization.pinnedRepositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field User.watching changed from ["OWNER", "COLLABORATOR", "ORGANIZATION_MEMBER"] to ``
  • Default value for argument affiliations on field User.repositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field User.pinnedRepositories changed from ["OWNER", "COLLABORATOR"] to ``
  • Default value for argument affiliations on field Repository.forks changed from ["OWNER", "COLLABORATOR"] to ``
  • Field submodule was added to object type TreeEntry
  • Field reviewDecision was added to object type ReviewStatusHovercardContext
  • Field permalink was added to object type SecurityAdvisory
  • Field updateIpAllowListEntry was added to object type Mutation
  • Field updateIpAllowListEnabledSetting was added to object type Mutation
  • Field setEnterpriseIdentityProvider was added to object type Mutation
  • Field removeEnterpriseIdentityProvider was added to object type Mutation
  • Field deleteIpAllowListEntry was added to object type Mutation
  • Field createIpAllowListEntry was added to object type Mutation
  • Field ipAllowListEntries was added to object type EnterpriseOwnerInfo
  • Field ipAllowListEnabledSetting was added to object type EnterpriseOwnerInfo
  • Field submodules was added to object type Repository
  • Field reviewDecision was added to object type PullRequest
  • Field submodules was added to object type Commit
  • Field slug was added to object type Enterprise
  • Type SubmoduleEdge was added
  • Type PullRequestReviewDecision was added
  • Type UpdateIpAllowListEntryInput was added
  • Type UpdateIpAllowListEntryPayload was added
  • Type UpdateIpAllowListEnabledSettingInput was added
  • Type UpdateIpAllowListEnabledSettingPayload was added
  • Type SetEnterpriseIdentityProviderInput was added
  • Type SetEnterpriseIdentityProviderPayload was added
  • Type RemoveEnterpriseIdentityProviderInput was added
  • Type RemoveEnterpriseIdentityProviderPayload was added
  • Type IpAllowListEntryOrderField was added
  • Type IpAllowListEntryEdge was added
  • Type IpAllowListOwner was added
  • Type IpAllowListEntryOrder was added
  • Type IpAllowListEntryConnection was added
  • Type IpAllowListEnabledSettingValue was added
  • Type DeleteIpAllowListEntryPayload was added
  • Type DeleteIpAllowListEntryInput was added
  • Type CreateIpAllowListEntryPayload was added
  • Type IpAllowListEntry was added
  • Type CreateIpAllowListEntryInput was added
  • Type Submodule was added
  • Type SubmoduleConnection was added

Schema changes for 2020-03-10

The GraphQL schema includes these changes:

  • Type MentionableItemEdge was removed
  • Type MentionableItem was removed
  • Field statusCheckRollup was added to object type Commit
  • Type StatusCheckRollupContext was added
  • Type StatusCheckRollupContextEdge was added
  • Type StatusCheckRollupContextConnection was added
  • Type StatusCheckRollup was added

Schema changes for 2020-03-05

The GraphQL schema includes these changes:

  • Field actor was added to object type RequestReviewsPayload
  • Type MentionableItemEdge was added
  • Type MentionableItem was added

Schema changes for 2020-02-19

The GraphQL schema includes these changes:

  • Type PackageType was added

The GitHub Packages preview includes these changes:

  • Field packageType was added to object type Package

Schema changes for 2020-02-12

The GraphQL schema includes these changes:

  • Field deleteDeployment was added to object type Mutation
  • Type DeleteDeploymentInput was added
  • Type DeleteDeploymentPayload was added

Schema changes for 2020-02-05

The GraphQL schema includes these changes:

  • Type EnterpriseOrderField was removed
  • Type CollectionItemContent was removed
  • Enum value UNMARKED_AS_DUPLICATE_EVENT was added to enum PullRequestTimelineItemsItemType
  • Enum value DISCONNECTED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Enum value CONNECTED_EVENT was added to enum PullRequestTimelineItemsItemType
  • Union member UnmarkedAsDuplicateEvent was added to Union type PullRequestTimelineItems
  • Union member DisconnectedEvent was added to Union type PullRequestTimelineItems
  • Union member ConnectedEvent was added to Union type PullRequestTimelineItems
  • Enum value UNMARKED_AS_DUPLICATE_EVENT was added to enum IssueTimelineItemsItemType
  • Enum value DISCONNECTED_EVENT was added to enum IssueTimelineItemsItemType
  • Enum value CONNECTED_EVENT was added to enum IssueTimelineItemsItemType
  • Union member UnmarkedAsDuplicateEvent was added to Union type IssueTimelineItems
  • Union member DisconnectedEvent was added to Union type IssueTimelineItems
  • Union member ConnectedEvent was added to Union type IssueTimelineItems
  • Input field SubmitPullRequestReviewInput.pullRequestReviewId changed type from ID! to ID
  • Input field pullRequestId was added to input object type SubmitPullRequestReviewInput
  • Input field AddPullRequestReviewCommentInput.pullRequestReviewId changed type from ID! to ID
  • Input field pullRequestId was added to input object type AddPullRequestReviewCommentInput
  • Field originalEnvironment was added to object type Deployment
  • Field latestEnvironment was added to object type Deployment
  • Field checksUrl was added to object type PullRequest
  • Field checksResourcePath was added to object type PullRequest
  • Type UnmarkedAsDuplicateEvent was added
  • Type DisconnectedEvent was added
  • Type ConnectedEvent was added

The [Checks preview](/graphql/overview/schema-previews#checks-preview) includes these changes:

  • Enum value STALE was added to enum CheckConclusionState
  • Enum value SKIPPED was added to enum CheckConclusionState

Schema changes for 2020-01-09

The GraphQL schema includes these changes:

  • Enum value DUPLICATE was added to enum ReportedContentClassifiers
  • Field deleteBranchOnMerge was added to object type Repository

Schema changes for 2020-01-06

The GraphQL schema includes these changes:

  • Field sponsorable was added to object type Sponsorship

The following changes will be made to the schema:

  • On member Sponsorship.maintainer: maintainer will be removed. Use Sponsorship.sponsorable instead. Effective 2020-04-01.