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:
userswill be removed. Use thereactorsfield 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:
DOCKERwill 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:
DRAFTwill be removed. Use PullRequest.isDraft instead.Reason:
DRAFT state will be removed from this enum and
isDraftshould be used instead
- Breaking A change will be made to
EnterprisePendingCollaboratorEdge.isUnlicensed.Description:
isUnlicensedwill be removed.Reason:
All pending collaborators consume a license
- Breaking A change will be made to
EnterpriseOutsideCollaboratorEdge.isUnlicensed.Description:
isUnlicensedwill be removed.Reason:
All outside collaborators consume a license
- Breaking A change will be made to
EnterpriseMemberEdge.isUnlicensed.Description:
isUnlicensedwill be removed.Reason:
All members consume a license
Changes scheduled for 2020-10-01
- Breaking A change will be made to
Sponsorship.sponsor.Description:
sponsorwill be removed. UseSponsorship.sponsorEntityinstead.Reason:
Sponsorship.sponsorwill be removed.
- Breaking A change will be made to
RepositoryInvitationOrderField.INVITEE_LOGIN.Description:
INVITEE_LOGINwill be removed.Reason:
INVITEE_LOGINis 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:
timelinewill be removed. Use PullRequest.timelineItems instead.Reason:
timelinewill be removed
- Breaking A change will be made to
Issue.timeline.Description:
timelinewill be removed. Use Issue.timelineItems instead.Reason:
timelinewill be removed
- Breaking A change will be made to
EnterpriseOwnerInfo.pendingCollaborators.Description:
pendingCollaboratorswill be removed. Use thependingCollaboratorInvitationsfield 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:
isUnlicensedwill 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:
maintainerwill be removed. UseSponsorship.sponsorableinstead.Reason:
Sponsorship.maintainerwill be removed.
Changes scheduled for 2020-01-01
- Breaking A change will be made to
UnassignedEvent.user.Description:
userwill be removed. Use theassigneefield instead.Reason:
Assignees can now be mannequins.
- Breaking A change will be made to
EnterpriseBillingInfo.seats.Description:
seatswill be removed. Use EnterpriseBillingInfo.totalLicenses instead.Reason:
seatswill be replaced withtotalLicensesto provide more clarity on the value being returned
- Breaking A change will be made to
EnterpriseBillingInfo.availableSeats.Description:
availableSeatswill be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.Reason:
availableSeatswill be replaced withtotalAvailableLicensesto provide more clarity on the value being returned
- Breaking A change will be made to
AssignedEvent.user.Description:
userwill be removed. Use theassigneefield instead.Reason:
Assignees can now be mannequins.