docs/data/graphql/graphql_upcoming_changes.public.yml

---
upcoming_changes:
  - location: LegacyMigration.uploadUrlTemplate
    description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.'
    reason:
      '`uploadUrlTemplate` is being removed because it is not a standard URL and
      adds an extra user step.'
    date: '2019-04-01T00:00:00+00:00'
    criticality: breaking
    owner: tambling
  - location: AssignedEvent.user
    description: '`user` will be removed. Use the `assignee` field instead.'
    reason: Assignees can now be mannequins.
    date: '2020-01-01T00:00:00+00:00'
    criticality: breaking
    owner: tambling
  - location: UnassignedEvent.user
    description: '`user` will be removed. Use the `assignee` field instead.'
    reason: Assignees can now be mannequins.
    date: '2020-01-01T00:00:00+00:00'
    criticality: breaking
    owner: tambling
  - location: Sponsorship.maintainer
    description: '`maintainer` will be removed. Use `Sponsorship.sponsorable` instead.'
    reason: '`Sponsorship.maintainer` will be removed.'
    date: '2020-04-01T00:00:00+00:00'
    criticality: breaking
    owner: antn
  - location: Issue.timeline
    description: '`timeline` will be removed. Use Issue.timelineItems instead.'
    reason: '`timeline` will be removed'
    date: '2020-10-01T00:00:00+00:00'
    criticality: breaking
    owner: mikesea
  - location: PullRequest.timeline
    description: '`timeline` will be removed. Use PullRequest.timelineItems instead.'
    reason: '`timeline` will be removed'
    date: '2020-10-01T00:00:00+00:00'
    criticality: breaking
    owner: mikesea
  - location: Sponsorship.sponsor
    description: '`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead.'
    reason: '`Sponsorship.sponsor` will be removed.'
    date: '2020-10-01T00:00:00+00:00'
    criticality: breaking
    owner: nholden
  - location: MergeStateStatus.DRAFT
    description: '`DRAFT` will be removed. Use PullRequest.isDraft instead.'
    reason:
      DRAFT state will be removed from this enum and `isDraft` should be used
      instead
    date: '2021-01-01T00:00:00+00:00'
    criticality: breaking
    owner: nplasterer
  - location: PackageType.DOCKER
    description: '`DOCKER` will be removed.'
    reason:
      DOCKER will be removed from this enum as this type will be migrated to only
      be used by the Packages REST API.
    date: '2021-06-21'
    criticality: breaking
    owner: reybard
  - location: ReactionGroup.users
    description: '`users` will be removed. Use the `reactors` field instead.'
    reason: Reactors can now be mannequins, bots, and organizations.
    date: '2021-10-01T00:00:00+00:00'
    criticality: breaking
    owner: synthead
  - location: AddPullRequestToMergeQueueInput.branch
    description: '`branch` will be removed.'
    reason:
      PRs are added to the merge queue for the base branch, the `branch` argument
      is now a no-op
    date: '2022-07-01T00:00:00+00:00'
    criticality: breaking
    owner: jhunschejones
  - location: Query.sponsorables.dependencyEcosystem
    description:
      '`dependencyEcosystem` will be removed. Use the ecosystem argument
      instead.'
    reason: The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.
    date: '2022-07-01T00:00:00+00:00'
    criticality: breaking
    owner: cheshire137
  - location: DependencyGraphDependency.packageLabel
    description:
      '`packageLabel` will be removed. Use normalized `packageName` field
      instead.'
    reason: '`packageLabel` will be removed.'
    date: '2022-10-01T00:00:00+00:00'
    criticality: breaking
    owner: github/dependency_graph
  - location: RemovePullRequestFromMergeQueueInput.branch
    description: '`branch` will be removed.'
    reason:
      PRs are removed from the merge queue for the base branch, the `branch` argument
      is now a no-op
    date: '2022-10-01T00:00:00+00:00'
    criticality: breaking
    owner: jhunschejones
  - location: PackageType.NPM
    description: '`NPM` will be removed.'
    reason:
      NPM will be removed from this enum as this type will be migrated to only
      be used by the Packages REST API.
    date: '2022-11-21'
    criticality: breaking
    owner: s-anupam
  - location: PackageType.NUGET
    description: '`NUGET` will be removed.'
    reason:
      NUGET will be removed from this enum as this type will be migrated to only
      be used by the Packages REST API.
    date: '2022-11-21'
    criticality: breaking
    owner: s-anupam
  - location: PackageType.RUBYGEMS
    description: '`RUBYGEMS` will be removed.'
    reason:
      RUBYGEMS will be removed from this enum as this type will be migrated to
      only be used by the Packages REST API.
    date: '2022-12-28'
    criticality: breaking
    owner: ankitkaushal01
  - location: Commit.changedFiles
    description: '`changedFiles` will be removed. Use `changedFilesIfAvailable` instead.'
    reason: '`changedFiles` will be removed.'
    date: '2023-01-01T00:00:00+00:00'
    criticality: breaking
    owner: adamshwert
  - location: ProjectV2View.visibleFields
    description:
      '`visibleFields` will be removed. Check out the `ProjectV2View#fields`
      API as an example for the more capable alternative.'
    reason:
      The `ProjectV2View#visibleFields` API is deprecated in favour of the more
      capable `ProjectV2View#fields` API.
    date: '2023-01-01T00:00:00+00:00'
    criticality: breaking
    owner: mattruggio
  - location: PackageType.MAVEN
    description: '`MAVEN` will be removed.'
    reason:
      MAVEN will be removed from this enum as this type will be migrated to only
      be used by the Packages REST API.
    date: '2023-02-10'
    criticality: breaking
    owner: ankitkaushal01
  - location: ProjectV2View.groupBy
    description:
      '`groupBy` will be removed. Check out the `ProjectV2View#group_by_fields`
      API as an example for the more capable alternative.'
    reason:
      The `ProjectV2View#order_by` API is deprecated in favour of the more capable
      `ProjectV2View#group_by_field` API.
    date: '2023-04-01T00:00:00+00:00'
    criticality: breaking
    owner: alcere
  - location: ProjectV2View.sortBy
    description:
      '`sortBy` will be removed. Check out the `ProjectV2View#sort_by_fields`
      API as an example for the more capable alternative.'
    reason:
      The `ProjectV2View#sort_by` API is deprecated in favour of the more capable
      `ProjectV2View#sort_by_fields` API.
    date: '2023-04-01T00:00:00+00:00'
    criticality: breaking
    owner: traumverloren
  - location: ProjectV2View.verticalGroupBy
    description:
      '`verticalGroupBy` will be removed. Check out the `ProjectV2View#vertical_group_by_fields`
      API as an example for the more capable alternative.'
    reason:
      The `ProjectV2View#vertical_group_by` API is deprecated in favour of the
      more capable `ProjectV2View#vertical_group_by_fields` API.
    date: '2023-04-01T00:00:00+00:00'
    criticality: breaking
    owner: traumverloren
  - location: Repository.squashPrTitleUsedAsDefault
    description:
      '`squashPrTitleUsedAsDefault` will be removed. Use `Repository.squashMergeCommitTitle`
      instead.'
    reason: '`squashPrTitleUsedAsDefault` will be removed.'
    date: '2023-04-01T00:00:00+00:00'
    criticality: breaking
    owner: github/pull_requests
  - location: Commit.pushedDate
    description: '`pushedDate` will be removed.'
    reason: '`pushedDate` is no longer supported.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: darthwillis
  - location: MergeQueue.headOid
    description: '`headOid` will be removed. Use `entry.headOid` instead.'
    reason: '`headOid` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueue.mergeMethod
    description: '`mergeMethod` will be removed. Use `configuration.merge_method` instead.'
    reason: '`mergeMethod` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueue.mergingEntries
    description: '`mergingEntries` will be removed.'
    reason: '`mergingEntries` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueue.pendingRemovalEntries
    description: '`pendingRemovalEntries` will be removed.'
    reason: '`pendingRemovalEntries` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueueEntry.baseOid
    description: '`baseOid` will be removed. Use `baseCommit` instead.'
    reason: '`baseOid` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueueEntry.blockedByMergeConflicts
    description: '`blockedByMergeConflicts` will be removed. Use `state` instead.'
    reason: '`blockedByMergeConflicts` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueueEntry.checkStatus
    description: '`checkStatus` will be removed. Use `state` instead.'
    reason: '`checkStatus` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueueEntry.hasJumpedQueue
    description: '`hasJumpedQueue` will be removed. Use `jump` instead.'
    reason: '`hasJumpedQueue` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueueEntry.headOid
    description: '`headOid` will be removed. Use `headCommit` instead.'
    reason: '`headOid` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: MergeQueueEntry.isSolo
    description: '`isSolo` will be removed. Use `solo` instead.'
    reason: '`isSolo` will be removed.'
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: github/merge_queue
  - location: ProjectV2ItemFieldGroup.field
    description:
      '`field` will be removed. Check out the `ProjectV2ItemFieldGroup#groupByField`
      API as an example for the more capable alternative.'
    reason:
      The `ProjectV2ItemFieldGroup#field` API is deprecated in favour of the more
      capable `ProjectV2ItemFieldGroup#groupByField` API.
    date: '2023-07-01T00:00:00+00:00'
    criticality: breaking
    owner: stevepopovich
  - location: AddPullRequestReviewCommentInput.body
    description:
      '`body` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
      instead'
    reason: We are deprecating the addPullRequestReviewComment mutation
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: AddPullRequestReviewCommentInput.commitOID
    description:
      '`commitOID` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
      instead'
    reason: We are deprecating the addPullRequestReviewComment mutation
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: AddPullRequestReviewCommentInput.inReplyTo
    description:
      '`inReplyTo` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
      instead'
    reason: We are deprecating the addPullRequestReviewComment mutation
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: AddPullRequestReviewCommentInput.path
    description:
      '`path` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
      instead'
    reason: We are deprecating the addPullRequestReviewComment mutation
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: AddPullRequestReviewCommentInput.position
    description:
      '`position` will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply
      instead'
    reason: We are deprecating the addPullRequestReviewComment mutation
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: AddPullRequestReviewCommentInput.pullRequestId
    description:
      '`pullRequestId` will be removed. use addPullRequestReviewThread or
      addPullRequestReviewThreadReply instead'
    reason: We are deprecating the addPullRequestReviewComment mutation
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: AddPullRequestReviewCommentInput.pullRequestReviewId
    description:
      '`pullRequestReviewId` will be removed. use addPullRequestReviewThread
      or addPullRequestReviewThreadReply instead'
    reason: We are deprecating the addPullRequestReviewComment mutation
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: AddPullRequestReviewInput.comments
    description: '`comments` will be removed. use the `threads` argument instead'
    reason: We are deprecating comment fields that use diff-relative positioning
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: PullRequestReviewComment.originalPosition
    description: '`originalPosition` will be removed.'
    reason: We are phasing out diff-relative positioning for PR comments
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole
  - location: PullRequestReviewComment.position
    description:
      '`position` will be removed. Use the `line` and `startLine` fields
      instead, which are file line numbers instead of diff line numbers'
    reason: We are phasing out diff-relative positioning for PR comments
    date: '2023-10-01T00:00:00+00:00'
    criticality: breaking
    owner: aharpole