Критические изменения

Сведения о критических изменениях

Критические изменения — это любые изменения, которые могут потребовать действий от интеграторов. Эти изменения делятся на две категории:

Критические. Изменения, которые прерывают выполнение текущих запросов к API GraphQL. Например, критическим изменением является удаление поля.
Опасные. Изменения, которые не прерывают выполнение существующих запросов, но могут повлиять на поведение среды выполнения клиентов. Опасным изменением является, например, добавление значения в перечисление.

Мы стремимся предоставлять стабильные API для наших интеграторов. Когда работа над новой функцией еще идет, мы выпускаем ее в рамках предварительной версии схемы.

Мы объявляем о предстоящих критических изменениях минимум за три месяца до их внедрения в схему GraphQL, чтобы дать интеграторам время для внесения необходимых корректировок. Изменения вступают в силу в первый день квартала (1 января, 1 апреля, 1 июля или 1 октября). Например, если об изменении объявлено 15 января, оно будет внедрено 1 июля.

Changes scheduled for 2022-07-01

Breaking A change will be made to Enterprise.userAccounts.
Description:
userAccounts will be removed. Use the Enterprise.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. Use Repository.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 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 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 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.

Критические изменения

В этой статье