Acerca de los cambios sustanciales
Los cambios sustanciales son aquellos que pudieran necesitar que nuestros integradores realicen alguna acción al respecto. Dividimos estos cambios en dos categorías:
- Importantes: cambios que interrumpirán consultas existentes a GraphQL API. Por ejemplo, eliminar un campo sería un cambio sustancial.
- Peligrosos: cambios que no interrumpirán las consultas existentes, pero que podrían afectar al comportamiento del tiempo de ejecución de los clientes. Agregar un valor de enumerador es un ejemplo de un cambio peligroso.
Nos esforzamos por proporcionar API estables para nuestros integradores. Cuando una característica nueva sigue en evolución, se publica detrás de una versión preliminar del esquema.
Anunciaremos los cambios sustanciales por venir por lo menos tres meses antes de aplicarlos al modelo de GraphQL, para proporcionar a los integradores tiempo para realizar los ajustes necesarios. Los cambios toman efecto en el primer día de un trimestre (1 de enero, 1 de abril, 1 de julio, o 1 de octubre). Por ejemplo, si anunciamos un cambio en el 15 de enero, se aplicará en el 1 de julio.
Changes scheduled for 2021-10-01
- Breaking A change will be made to
ReactionGroup.users.Description:
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:
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:
Reason:
DRAFT state will be removed from this enum and
isDraftshould be used instead
- Breaking A change will be made to
EnterprisePendingCollaboratorEdge.isUnlicensed.Description:
Reason:
All pending collaborators consume a license
- Breaking A change will be made to
EnterpriseOutsideCollaboratorEdge.isUnlicensed.Description:
Reason:
All outside collaborators consume a license
- Breaking A change will be made to
EnterpriseMemberEdge.isUnlicensed.Description:
Reason:
All members consume a license
Changes scheduled for 2020-10-01
- Breaking A change will be made to
Sponsorship.sponsor.Description:
Reason:
Sponsorship.sponsorwill be removed.
- Breaking A change will be made to
RepositoryInvitationOrderField.INVITEE_LOGIN.Description:
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:
Reason:
timelinewill be removed
- Breaking A change will be made to
Issue.timeline.Description:
Reason:
timelinewill be removed
- Breaking A change will be made to
EnterpriseOwnerInfo.pendingCollaborators.Description:
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:
Reason:
All pending members consume a license
Changes scheduled for 2020-04-01
- Breaking A change will be made to
Sponsorship.maintainer.Description:
Reason:
Sponsorship.maintainerwill be removed.
Changes scheduled for 2020-01-01
- Breaking A change will be made to
UnassignedEvent.user.Description:
Reason:
Assignees can now be mannequins.
- Breaking A change will be made to
EnterpriseBillingInfo.seats.Description:
Reason:
seatswill be replaced withtotalLicensesto provide more clarity on the value being returned
- Breaking A change will be made to
EnterpriseBillingInfo.availableSeats.Description:
Reason:
availableSeatswill be replaced withtotalAvailableLicensesto provide more clarity on the value being returned
- Breaking A change will be made to
AssignedEvent.user.Description:
Reason:
Assignees can now be mannequins.