Alterações de quebra

Saiba mais sobre as alterações significativas recentes e futuras na API GraphQL GitHub.

Neste artigo

Sobre alterações significativas

Mudanças disruptivas são quaisquer alterações que possam exigir ação dos nossos integradores. Dividimos essas alterações em duas categorias:

  • Falhas: 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.

Anunciaremos mudanças significativas futuras 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 2027-01-01

  • Breaking A change will be made to CheckAnnotation.databaseId.
    Description:

    databaseId will be removed. Use fullDatabaseId instead.

    Reason:

    databaseId will be removed because it does not support 64-bit signed integer identifiers.

  • Breaking A change will be made to Artifact.databaseId.
    Description:

    databaseId will be removed. Use fullDatabaseId instead.

    Reason:

    databaseId will be removed because it does not support 64-bit signed integer identifiers.

Changes scheduled for 2026-10-01

  • Breaking A change will be made to User.viewerRelevantRepositories.
    Description:

    viewerRelevantRepositories will be removed. Use viewerCopilotChatRepositorySuggestions instead.

    Reason:

    viewerRelevantRepositories has been renamed to viewerCopilotChatRepositorySuggestions.

  • Breaking A change will be made to CopilotAgentTask.type.
    Description:

    type will be removed. Use codingAgentFilter and codingAgentTypeFilter instead.

    Reason:

    type will be removed.

Changes scheduled for 2026-07-01

  • Breaking A change will be made to Team.viewerSubscription.
    Description:

    viewerSubscription will be removed.

    Reason:

    Team.viewerSubscription will be removed. Team notifications subscriptions are being deprecated.

  • Breaking A change will be made to Team.viewerCanSubscribe.
    Description:

    viewerCanSubscribe will be removed.

    Reason:

    Team.viewerCanSubscribe will be removed. Team notifications subscriptions are being deprecated.

Changes scheduled for 2026-04-01

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.userUrl.
    Description:

    userUrl will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.userResourcePath.
    Description:

    userResourcePath will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.userLogin.
    Description:

    userLogin will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.user.
    Description:

    user will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.organizationUrl.
    Description:

    organizationUrl will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.organizationResourcePath.
    Description:

    organizationResourcePath will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.organizationName.
    Description:

    organizationName will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.organization.
    Description:

    organization will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.operationType.
    Description:

    operationType will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.isLdapMapped.
    Description:

    isLdapMapped will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.createdAt.
    Description:

    createdAt will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.actorUrl.
    Description:

    actorUrl will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.actorResourcePath.
    Description:

    actorResourcePath will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.actorLogin.
    Description:

    actorLogin will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.actorLocation.
    Description:

    actorLocation will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.actorIp.
    Description:

    actorIp will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.actor.
    Description:

    actor will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to TeamRemoveRepositoryAuditEntry.action.
    Description:

    action will be removed.

    Reason:

    The GraphQL audit-log is deprecated. Please use the REST API instead.

  • Breaking A change will be made to