Informationen zu Breaking Changes
Breaking Changes sind Änderungen, für die unsere Integratoren möglicherweise Maßnahmen ergreifen müssen. Diese Änderungen werden in zwei Kategorien unterteilt:
- Breaking Change: Änderungen, die dazu führen, dass bereits vorhandene Abfragen für die GraphQL-API nicht mehr funktionieren. Ein Beispiel wäre etwa das Entfernen eines Felds.
- Gefährliche Änderung: Änderungen, die nicht dazu führen, dass bereits vorhandene Abfragen nicht mehr funktionieren, aber das Laufzeitverhalten von Clients beeinflussen können. Ein Beispiel wäre etwa das Hinzufügen eines Enumerationswerts.
Wir sind bestrebt, stabile APIs für unsere Integratoren bereitzustellen. Wenn ein neues Feature noch weiterentwickelt wird, wird es im Rahmen einer Schemavorschau veröffentlicht.
Bevorstehende Breaking Changes werden von uns mindestens drei Monate vor der Implementierung der Änderung am GraphQL-Schema angekündigt, damit Integratoren genügend Zeit haben, die erforderlichen Anpassungen vorzunehmen. Änderungen werden am ersten Tag eines Quartals wirksam (also am 1. Januar, 1. April, 1. Juli oder 1. Oktober). Eine am 15. Januar angekündigte Änderung wird also beispielsweise am 1. Juli vorgenommen.
Changes scheduled for 2022-07-01
- Breaking A change will be made to
Enterprise.userAccounts
.Description:
userAccounts
will be removed. Use theEnterprise.members
field instead.Reason:
The
Enterprise.userAccounts
field is being removed.
- Breaking A change will be made to
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
Changes scheduled for 2022-04-01
- Breaking A change will be made to
Repository.defaultMergeQueue
.Description:
defaultMergeQueue
will be removed. UseRepository.mergeQueue
instead.Reason:
defaultMergeQueue
will be removed.
Changes scheduled for 2021-10-01
- Breaking A change will be made to
ReactionGroup.users
.Description:
users
will be removed. Use thereactors
field instead.Reason:
Reactors can now be mannequins, bots, and organizations.
Changes scheduled for 2021-06-21
- Breaking A change will be made to
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.
Changes scheduled for 2021-01-01
- Breaking A change will be made to
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
- Breaking A change will be made to
EnterpriseOutsideCollaboratorEdge.isUnlicensed
.Description:
isUnlicensed
will be removed.Reason:
All outside collaborators consume a license
- Breaking A change will be made to
EnterpriseMemberEdge.isUnlicensed
.Description:
isUnlicensed
will be removed.Reason:
All members consume a license
Changes scheduled for 2020-10-01
- Breaking A change will be made to
PullRequest.timeline
.Description:
timeline
will be removed. Use PullRequest.timelineItems instead.Reason:
timeline
will be removed
- Breaking A change will be made to
Issue.timeline
.Description:
timeline
will be removed. Use Issue.timelineItems instead.Reason:
timeline
will be removed
Changes scheduled for 2020-07-01
- Breaking A change will be made to
EnterprisePendingMemberInvitationEdge.isUnlicensed
.Description:
isUnlicensed
will be removed.Reason:
All pending members consume a license
Changes scheduled for 2020-01-01
- Breaking A change will be made to
UnassignedEvent.user
.Description:
user
will be removed. Use theassignee
field instead.Reason:
Assignees can now be mannequins.
- Breaking A change will be made to
EnterpriseBillingInfo.seats
.Description:
seats
will be removed. Use EnterpriseBillingInfo.totalLicenses instead.Reason:
seats
will be replaced withtotalLicenses
to provide more clarity on the value being returned
- Breaking A change will be made to
EnterpriseBillingInfo.availableSeats
.Description:
availableSeats
will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.Reason:
availableSeats
will be replaced withtotalAvailableLicenses
to provide more clarity on the value being returned
- Breaking A change will be made to
AssignedEvent.user
.Description:
user
will be removed. Use theassignee
field instead.Reason:
Assignees can now be mannequins.
Changes scheduled for 2019-04-01
- Breaking A change will be made to
LegacyMigration.uploadUrlTemplate
.Description:
uploadUrlTemplate
will be removed. UseuploadUrl
instead.Reason:
uploadUrlTemplate
is being removed because it is not a standard URL and adds an extra user step.