Alterações de quebra

Sobre alterações significativas

Alterações significativas são quaisquer mudanças que possam exigir ação dos nossos integrantes. Dividimos essas alterações em duas categorias:

Interruptivas: alterações que interromperão as consultas existentes na API do GraphQL. Por exemplo, a eliminação de um campo seria uma mudança decisiva.
Perigosas: alterações que não interromperão as consultas existentes, mas que poderão afetar o comportamento de runtime dos clientes. Adicionar um valor de enumerador é um exemplo de uma alteração perigosa.

Nós nos esforçamos para fornecer APIs estáveis para os nossos integrantes. Quando um novo recurso ainda está em evolução, nós o lançamos por trás de uma versão prévia de esquema.

Vamos anunciar as próximas mudanças significativas em andamento pelo menos três meses antes de fazer alterações no esquema do GraphQL para dar tempo aos integradores de fazer os ajustes necessários. As alterações entram em vigor no primeiro dia do trimestre (1 de janeiro, 1 de abril, 1 de julho ou 1 de outubro). Por exemplo, se anunciarmos uma mudança no dia 15 de Janeiro, ela entrará em vigor no dia 1 de julho.

Changes scheduled for 2021-10-01

Breaking A change will be made to ReactionGroup.users.
Description:
users will be removed. Use the reactors 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 EnterprisePendingCollaboratorEdge.isUnlicensed.
Description:
isUnlicensed will be removed.
Reason:
All pending collaborators consume a license

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 Sponsorship.sponsor.
Description:
sponsor will be removed. Use Sponsorship.sponsorEntity instead.
Reason:
Sponsorship.sponsor will be removed.

Breaking A change will be made to RepositoryInvitationOrderField.INVITEE_LOGIN.
Description:
INVITEE_LOGIN will be removed.
Reason:
INVITEE_LOGIN is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.

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

Breaking A change will be made to EnterpriseOwnerInfo.pendingCollaborators.
Description:
pendingCollaborators will be removed. Use the pendingCollaboratorInvitations field instead.
Reason:
Repository invitations can now be associated with an email, not only an invitee.

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-04-01

Breaking A change will be made to Sponsorship.maintainer.
Description:
maintainer will be removed. Use Sponsorship.sponsorable instead.
Reason:
Sponsorship.maintainer will be removed.

Changes scheduled for 2020-01-01

Breaking A change will be made to UnassignedEvent.user.
Description:
user will be removed. Use the assignee 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 with totalLicenses 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 with totalAvailableLicenses to provide more clarity on the value being returned

Breaking A change will be made to AssignedEvent.user.
Description:
user will be removed. Use the assignee 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. Use uploadUrl instead.
Reason:
uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.