GraphQL changelog for 2022

GraphQL schema changes from 2022.

In this article

Schema changes for 2022-12-09

The GraphQL schema includes these changes:

  • Type Claimable was added
  • Type CreateAttributionInvitationInput was added
  • Type CreateAttributionInvitationPayload was added
  • Type CreateSponsorsListingInput was added
  • Type CreateSponsorsListingPayload was added
  • Type MannequinConnection was added
  • Type MannequinEdge was added
  • Type MannequinOrder was added
  • Type MannequinOrderField was added
  • Type SponsorsCountryOrRegionCode was added
  • Field createAttributionInvitation was added to object type Mutation
  • Field createSponsorsListing was added to object type Mutation
  • Field mannequins was added to object type Organization
  • Field isDraft was added to object type SponsorsTierAdminInfo
  • Field isPublished was added to object type SponsorsTierAdminInfo
  • Field isRetired was added to object type SponsorsTierAdminInfo

The following changes will be made to the schema:

  • On member RepositoryVulnerabilityAlert.fixReason:fixReason will be removed. Effective 2023-04-01.

Schema changes for 2022-12-07

The GraphQL schema includes these changes:

  • Field fiscalHost was added to object type SponsorsListing
  • WorkflowRun object implements UniformResourceLocatable interface

The following changes will be made to the schema:

  • On member PackageType.NPM:NPM will be removed. Effective 2022-11-21.
  • On member PackageType.NUGET:NUGET will be removed. Effective 2022-11-21.

Schema changes for 2022-12-02

The GraphQL schema includes these changes:

  • Type SponsorsListingFeatureableItem was added
  • Field featureable was added to object type SponsorsListingFeaturedItem

Schema changes for 2022-12-01

The GraphQL schema includes these changes:

  • Field totalCommentsCount was added to object type PullRequest

Schema changes for 2022-11-29

The GraphQL schema includes these changes:

  • Enum value 'TRADE_RESTRICTIONwas added to enumRepositoryLockReason'

Schema changes for 2022-11-24

The GraphQL schema includes these changes:

  • Type AddEnterpriseOrganizationMemberInput was added
  • Type AddEnterpriseOrganizationMemberPayload was added
  • Field addEnterpriseOrganizationMember was added to object type Mutation

Schema changes for 2022-11-18

The GraphQL schema includes these changes:

  • Type SponsorsListingFeaturedItem was added
  • Type SponsorsListingFeaturedItemFeatureableType was added
  • Field featuredItems was added to object type SponsorsListing

Schema changes for 2022-11-17

The GraphQL schema includes these changes:

  • Argument includeAsSponsor: Boolean added to field Organization.sponsorsActivities
  • Argument includeAsSponsor: Boolean added to field Sponsorable.sponsorsActivities
  • Argument includeAsSponsor: Boolean added to field User.sponsorsActivities

Schema changes for 2022-11-16

The GraphQL schema includes these changes:

  • Type TransferEnterpriseOrganizationInput was added
  • Type TransferEnterpriseOrganizationPayload was added
  • Field transferEnterpriseOrganization was added to object type Mutation
  • Argument 'maintainerLogins: [String!]added to fieldOrganization.sponsorshipsAsSponsor'
  • Argument 'maintainerLogins: [String!]added to fieldSponsorable.sponsorshipsAsSponsor'
  • Field contactEmailAddress was added to object type SponsorsListing
  • Field nameRaw was added to object type Submodule
  • Field pathRaw was added to object type Submodule
  • Field nameRaw was added to object type TreeEntry
  • Field pathRaw was added to object type TreeEntry
  • Argument 'maintainerLogins: [String!]added to fieldUser.sponsorshipsAsSponsor'

Schema changes for 2022-11-15

The GraphQL schema includes these changes:

  • Input field teamId was added to input object type 'CreateProjectV2Input'
  • Field billingCountryOrRegion was added to object type SponsorsListing
  • Field residenceCountryOrRegion was added to object type SponsorsListing

The following changes will be made to the schema:

  • On member Repository.squashPrTitleUsedAsDefault:squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead. Effective 2023-04-01.

Schema changes for 2022-11-12

The GraphQL schema includes these changes:

  • Input field repositoryId was added to input object type 'CreateProjectV2Input'

Schema changes for 2022-11-11

The GraphQL schema includes these changes:

  • Type 'LinkProjectV2ToTeamInput' was added
  • Type 'LinkProjectV2ToTeamPayload' was added
  • Type 'ProjectV2Filters' was added
  • Type 'ProjectV2State' was added
  • Type 'UnlinkProjectV2FromTeamInput' was added
  • Type 'UnlinkProjectV2FromTeamPayload' was added
  • Field 'linkProjectV2ToTeamwas added to object typeMutation'
  • Field 'unlinkProjectV2FromTeamwas added to object typeMutation'
  • Argument 'filterBy: ProjectV2Filtersadded to fieldTeam.projectsV2'
  • Argument query: String added to field 'Team.projectsV2'

Schema changes for 2022-11-10

The GraphQL schema includes these changes:

  • Argument since: DateTime added to field Organization.sponsorsActivities
  • Argument until: DateTime added to field Organization.sponsorsActivities
  • Argument since: DateTime added to field Sponsorable.sponsorsActivities
  • Argument until: DateTime added to field Sponsorable.sponsorsActivities
  • Argument since: DateTime added to field User.sponsorsActivities
  • Argument until: DateTime added to field User.sponsorsActivities

Schema changes for 2022-11-05

The GraphQL schema includes these changes:

  • Field hasDiscussionsEnabled was added to interface RepositoryInfo

Schema changes for 2022-11-02

The GraphQL schema includes these changes:

  • Type 'ArchiveProjectV2ItemInput' was added
  • Type 'ArchiveProjectV2ItemPayload' was added
  • Type 'LinkProjectV2ToRepositoryInput' was added
  • Type 'LinkProjectV2ToRepositoryPayload' was added
  • Type 'UnarchiveProjectV2ItemInput' was added
  • Type 'UnarchiveProjectV2ItemPayload' was added
  • Type 'UnlinkProjectV2FromRepositoryInput' was added
  • Type 'UnlinkProjectV2FromRepositoryPayload' was added
  • Field lockAllowsFetchAndMerge was added to object type BranchProtectionRule
  • Field lockBranch was added to object type BranchProtectionRule
  • Field requireLastPushApproval was added to object type BranchProtectionRule
  • Input field lockAllowsFetchAndMerge was added to input object type CreateBranchProtectionRuleInput
  • Input field lockBranch was added to input object type CreateBranchProtectionRuleInput
  • Input field requireLastPushApproval was added to input object type CreateBranchProtectionRuleInput
  • Field 'archiveProjectV2Itemwas added to object typeMutation'
  • Field 'linkProjectV2ToRepositorywas added to object typeMutation'
  • Field 'unarchiveProjectV2Itemwas added to object typeMutation'
  • Field 'unlinkProjectV2FromRepositorywas added to object typeMutation'
  • Enum value 'TRACKED_BYwas added to enumProjectNextFieldType'
  • Enum value 'TRACKED_BYwas added to enumProjectV2FieldType'
  • Field hasDiscussionsEnabled was added to object type Repository
  • Input field lockAllowsFetchAndMerge was added to input object type UpdateBranchProtectionRuleInput
  • Input field lockBranch was added to input object type UpdateBranchProtectionRuleInput
  • Input field requireLastPushApproval was added to input object type UpdateBranchProtectionRuleInput
  • Input field hasDiscussionsEnabled was added to input object type UpdateRepositoryInput

The following changes will be made to the schema:

Schema changes for 2022-10-24

The GraphQL schema includes these changes:

  • Field filename was added to object type IssueTemplate

Schema changes for 2022-10-21

The GraphQL schema includes these changes:

  • Field teams was added to object type 'ProjectV2'
  • Field 'projectV2was added to object typeTeam'
  • Field 'projectsV2was added to object typeTeam'

Schema changes for 2022-10-19

The GraphQL schema includes these changes:

  • Field language was added to object type TreeEntry

Schema changes for 2022-10-18

The GraphQL schema includes these changes:

  • Type Comparison was added
  • Type ComparisonCommitConnection was added
  • Type ComparisonStatus was added
  • Type 'ProjectV2SortByField' was added
  • Type 'ProjectV2SortByFieldConnection' was added
  • Type 'ProjectV2SortByFieldEdge' was added
  • Field sortByFields was added to object type 'ProjectV2View'
  • Field verticalGroupByFields was added to object type 'ProjectV2View'
  • Field compare was added to object type Ref

The following changes will be made to the schema:

  • On member ProjectV2View.sortBy:sortBy will be removed. Check out the ProjectV2View#sort_by_fields API as an example for the more capable alternative. Effective 2023-04-01.
  • On member ProjectV2View.verticalGroupBy:verticalGroupBy will be removed. Check out the ProjectV2View#vertical_group_by_fields API as an example for the more capable alternative. Effective 2023-04-01.

Schema changes for 2022-10-07

The GraphQL schema includes these changes:

  • Enum value PUB was added to enum DependencyGraphEcosystem
  • Field groupByFields was added to object type 'ProjectV2View'
  • Enum value PUB was added to enum SecurityAdvisoryEcosystem

The following changes will be made to the schema:

  • On member ProjectV2View.groupBy:groupBy will be removed. Check out the ProjectV2View#group_by_fields API as an example for the more capable alternative. Effective 2023-04-01.

Schema changes for 2022-10-03

The GraphQL schema includes these changes:

  • Type CreateLinkedBranchInput was added
  • Type CreateLinkedBranchPayload was added
  • Type DeleteLinkedBranchInput was added
  • Type DeleteLinkedBranchPayload was added
  • Type LinkedBranch was added
  • Type LinkedBranchConnection was added
  • Type LinkedBranchEdge was added
  • Field linkedBranches was added to object type Issue
  • Field createLinkedBranch was added to object type Mutation
  • Field deleteLinkedBranch was added to object type Mutation

Schema changes for 2022-09-30

The GraphQL schema includes these changes:

  • Field view was added to object type 'ProjectV2'

Schema changes for 2022-09-28

The GraphQL schema includes these changes:

    The following changes will be made to the schema:

    Schema changes for 2022-09-27

    The GraphQL schema includes these changes:

    • Field dashboardResourcePath was added to object type SponsorsListing
    • Field dashboardUrl was added to object type SponsorsListing
    • Field resourcePath was added to object type SponsorsListing
    • Field url was added to object type SponsorsListing

    Schema changes for 2022-09-22

    The GraphQL schema includes these changes:

    • Field databaseId was added to interface Migration
    • Field databaseId was added to object type RepositoryMigration

    Schema changes for 2022-09-16

    The GraphQL schema includes these changes:

    • Type 'ClearProjectV2ItemFieldValueInput' was added
    • Type 'ClearProjectV2ItemFieldValuePayload' was added
    • Field pullRequestReviewComment was added to object type DeletePullRequestReviewCommentPayload
    • Argument hasTwoFactorEnabled: Boolean added to field Enterprise.members
    • Argument hasTwoFactorEnabled: Boolean added to field EnterpriseOwnerInfo.admins
    • Field 'clearProjectV2ItemFieldValuewas added to object typeMutation'

    Schema changes for 2022-09-15

    The GraphQL schema includes these changes:

    • Type CheckRunState was added
    • Type CheckRunStateCount was added
    • Type StatusContextStateCount was added
    • Field fields was added to object type 'ProjectV2View'
    • Field checkRunCount was added to object type StatusCheckRollupContextConnection
    • Field checkRunCountsByState was added to object type StatusCheckRollupContextConnection
    • Field statusContextCount was added to object type StatusCheckRollupContextConnection
    • Field statusContextCountsByState was added to object type StatusCheckRollupContextConnection

    The following changes will be made to the schema:

    • On member ProjectV2View.visibleFields:visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative. Effective 2023-01-01.

    Schema changes for 2022-09-14

    The GraphQL schema includes these changes:

    • Field diffSide was added to object type PullRequestThread
    • Field line was added to object type PullRequestThread
    • Field startDiffSide was added to object type PullRequestThread
    • Field startLine was added to object type PullRequestThread

    Schema changes for 2022-09-08

    The GraphQL schema includes these changes:

    • Type EnterpriseAllowPrivateRepositoryForkingPolicyValue was added
    • Field changedFilesIfAvailable was added to object type Commit
    • Field allowPrivateRepositoryForkingSettingPolicyValue was added to object type EnterpriseOwnerInfo
    • Input field policyValue was added to input object type UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput

    The following changes will be made to the schema:

    • On member Commit.changedFiles:changedFiles will be removed. Use changedFilesIfAvailable instead. Effective 2023-01-01.

    Schema changes for 2022-09-07

    The GraphQL schema includes these changes:

    • Type SshSignature was added
    • Type WorkflowRunConnection was added
    • Type WorkflowRunEdge was added
    • Type WorkflowRunOrder was added
    • Type WorkflowRunOrderField was added
    • Input field conclusions was added to input object type CheckRunFilter
    • Input field statuses was added to input object type CheckRunFilter
    • Field runs was added to object type Workflow

    Schema changes for 2022-09-01

    The GraphQL schema includes these changes:

    • Type MergeCommitMessage was added
    • Type MergeCommitTitle was added
    • Type SquashMergeCommitMessage was added
    • Type SquashMergeCommitTitle was added
    • Field mergeCommitMessage was added to object type Repository
    • Field mergeCommitTitle was added to object type Repository
    • Field squashMergeCommitMessage was added to object type Repository
    • Field squashMergeCommitTitle was added to object type Repository

    Schema changes for 2022-08-26

    The GraphQL schema includes these changes:

    • Enum value GITHUB was removed from enum MigrationSourceType
    • Enum value GITLAB was removed from enum MigrationSourceType

    Schema changes for 2022-08-24

    The GraphQL schema includes these changes:

    • Input field createLabelsIfMissing was added to input object type TransferIssueInput

    Schema changes for 2022-08-22

    The GraphQL schema includes these changes:

      The following changes will be made to the schema:

      Schema changes for 2022-08-19

      The GraphQL schema includes these changes:

      • Type UpdateOrganizationWebCommitSignoffSettingInput was added
      • Type UpdateOrganizationWebCommitSignoffSettingPayload was added
      • Type UpdateRepositoryWebCommitSignoffSettingInput was added
      • Type UpdateRepositoryWebCommitSignoffSettingPayload was added
      • Enum value UNAFFILIATED was added to enum EnterpriseUserAccountMembershipRole
      • Field updateOrganizationWebCommitSignoffSetting was added to object type Mutation
      • Field updateRepositoryWebCommitSignoffSetting was added to object type Mutation
      • Field webCommitSignoffRequired was added to object type Organization
      • Enum value TRACKS was added to enum ProjectNextFieldType
      • Enum value TASKS (deprecated) was removed from enum ProjectNextFieldType
      • Enum value TRACKS was added to enum 'ProjectV2FieldType'
      • Enum value TASKS was removed from enum 'ProjectV2FieldType'
      • Field webCommitSignoffRequired was added to object type Repository
      • Field dismissComment was added to object type RepositoryVulnerabilityAlert
      • Input field lockSource was added to input object type StartRepositoryMigrationInput

      The following changes will be made to the schema:

      Schema changes for 2022-08-16

      The GraphQL schema includes these changes:

      • Field slug was added to object type DiscussionCategory
      • Field discussionCategory was added to object type Repository

      Schema changes for 2022-08-11

      The GraphQL schema includes these changes:

      • Input field targetRepoVisibility was added to input object type StartRepositoryMigrationInput

      Schema changes for 2022-08-06

      The GraphQL schema includes these changes:

      • Enum value TASKS was added to enum ProjectNextFieldType
      • Enum value TRACKS (deprecated) was removed from enum ProjectNextFieldType
      • Enum value TASKS was added to enum 'ProjectV2FieldType'
      • Enum value TRACKS was removed from enum 'ProjectV2FieldType'

      The following changes will be made to the schema:

      Schema changes for 2022-08-04

      The GraphQL schema includes these changes:

      • Enum value ACTIONS was added to enum SecurityAdvisoryEcosystem

      Schema changes for 2022-08-03

      The GraphQL schema includes these changes:

      • Field size was added to object type TreeEntry

      Schema changes for 2022-08-02

      The GraphQL schema includes these changes:

      • Field fieldValueByName was added to object type 'ProjectV2Item'

      Schema changes for 2022-07-28

      The GraphQL schema includes these changes:

      • Type PullRequestThread was added

      Schema changes for 2022-07-23

      The GraphQL schema includes these changes:

      • Field fieldValueByName was removed from object type 'ProjectV2Item'

      Schema changes for 2022-07-22

      The GraphQL schema includes these changes:

      • Argument 'actions: [SponsorsActivityAction!]added to fieldOrganization.sponsorsActivities'
      • Field fieldValueByName was added to object type 'ProjectV2Item'
      • Argument 'actions: [SponsorsActivityAction!]added to fieldSponsorable.sponsorsActivities'
      • Argument 'actions: [SponsorsActivityAction!]added to fieldUser.sponsorsActivities'

      Schema changes for 2022-07-19

      The GraphQL schema includes these changes:

      • Type EnterpriseUserAccountConnection was removed
      • Type EnterpriseUserAccountEdge was removed
      • Field userAccounts (deprecated) was removed from object type Enterprise
      • Field items was removed from object type 'ProjectV2View'
      • Argument 'orderBy: ProjectV2FieldOrderadded to fieldProjectV2View.groupBy'
      • Argument 'orderBy: ProjectV2FieldOrderadded to fieldProjectV2View.verticalGroupBy'
      • Argument 'orderBy: ProjectV2FieldOrderadded to fieldProjectV2View.visibleFields'
      • Field items (deprecated) was removed from object type ProjectView

      Schema changes for 2022-07-14

      The GraphQL schema includes these changes:

      • Type 'ProjectV2ItemFieldValueOrder' was added
      • Type 'ProjectV2ItemFieldValueOrderField' was added
      • Argument 'orderBy: ProjectV2ItemFieldValueOrderadded to fieldProjectV2Item.fieldValues'
      • Argument orderBy: PullRequestOrder added to field 'ProjectV2ItemFieldPullRequestValue.pullRequests'

      Schema changes for 2022-07-11

      The GraphQL schema includes these changes:

      • Type 'ProjectV2FieldOrder' was added
      • Type 'ProjectV2FieldOrderField' was added
      • Type 'ProjectV2ItemOrder' was added
      • Type 'ProjectV2ItemOrderField' was added
      • Type 'ProjectV2ViewOrder' was added
      • Type 'ProjectV2ViewOrderField' was added
      • Argument 'orderBy: ProjectV2FieldOrderadded to fieldProjectV2.fields'
      • Argument 'orderBy: ProjectV2ItemOrderadded to fieldProjectV2.items'
      • Argument orderBy: RepositoryOrder added to field 'ProjectV2.repositories'
      • Argument 'orderBy: ProjectV2ViewOrderadded to fieldProjectV2.views'

      Schema changes for 2022-06-29

      The GraphQL schema includes these changes:

      • Type RepositoryVulnerabilityAlertDependencyScope was added
      • Argument 'dependencyScopes: [RepositoryVulnerabilityAlertDependencyScope!]added to fieldRepository.vulnerabilityAlerts'
      • Field dependencyScope was added to object type RepositoryVulnerabilityAlert
      • Enum value ERLANG was added to enum SecurityAdvisoryEcosystem

      Schema changes for 2022-06-24

      The GraphQL schema includes these changes:

      • Input field AddProjectDraftIssueInput.projectId changed type from ID! to ID
      • Input field AddProjectDraftIssueInput.title changed type from String! to String
      • Input field AddProjectNextItemInput.contentId changed type from ID! to ID
      • Input field AddProjectNextItemInput.projectId changed type from ID! to ID
      • Input field DeleteProjectNextItemInput.itemId changed type from ID! to ID
      • Input field DeleteProjectNextItemInput.projectId changed type from ID! to ID
      • Input field UpdateProjectNextInput.projectId changed type from ID! to ID
      • Input field UpdateProjectNextItemFieldInput.itemId changed type from ID! to ID
      • Input field UpdateProjectNextItemFieldInput.projectId changed type from ID! to ID
      • Input field UpdateProjectNextItemFieldInput.value changed type from String! to String

      The following changes will be made to the schema: