Skip to main content

Solicitações de pull empilhadas nas APIs REST e GraphQL

Leia e gerencie solicitações de pull empilhadas programaticamente com as GitHub APIs REST e GraphQL.

Neste artigo

Observação

Esse recurso está em versão prévia pública e está sujeito a alterações.

As GitHub APIs REST e GraphQL expõem solicitações de pull empilhadas. A API REST dá suporte à leitura e ao gerenciamento de pilhas, enquanto a API do GraphQL dá suporte a consultas somente leitura.

Use a API para ler a associação de pilha de uma solicitação pull ou criar sua própria automação e integrações para solicitações de pull empilhadas.

API REST

A API REST expõe solicitações de pull empilhadas de duas maneiras:

  • O stack objeto em recursos de solicitação de pull. Quando uma solicitação de pull pertence a uma pilha, seu recurso REST inclui um stack objeto. Isso permite que você leia a associação de pilha da solicitação de pull, incluindo o número e o tamanho da pilha e a posição e a base da solicitação de pull, diretamente da solicitação de pull.
  • A API stacks. Um conjunto dedicado de pontos de extremidade para listar, ler, criar, estender e dissolver pilhas. Essa é a superfície para criar e modificar pilhas.

Observação

Se você mesclar por meio da API e quiser usar solicitações de pull empilhadas, precisará atualizar seu código para usar a nova API de mesclagem para pilhas.

Para pontos de extremidade, parâmetros e esquemas, consulte Endpoints da API REST para solicitações de pull.

API GraphQL

A API do GraphQL expõe a associação de pilha de uma solicitação de pull por meio de somente stack leitura e stackEntry campos no PullRequest tipo. Use esses campos para consultar a pilha à qual uma solicitação de pull pertence e sua posição dentro dela.

A API do GraphQL é somente leitura para pilhas; não há mutações de pilha. Para criar ou modificar pilhas, use a API REST.

Para campos, objetos e esquemas, consulte Solicitações de pull.

Leitura adicional