Criar pull request no GitHub, por uma API

Abre um pull request da branch head para a branch base e o retorna, com seu number. Envie title, ou issue para transformar uma issue existente em pull request. Notifica quem acompanha o repositório.

Identificador
github_create_pull_request

A chamada

POST https://connect.reportei.com/api/tools/github_create_pull_request/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "owner": "<owner>",
    "repo": "<repo>",
    "head": "<head>",
    "base": "<base>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
ownerstringSimLogin of the user or organization that owns the repository, the owner.login of List repositories.
repostringSimName of the repository, the name of List repositories.
headstringSimBranch with the changes. For a branch of a fork, write owner:branch.
basestringSimExisting branch of this repository that receives the changes, such as main.
titlestringNãoTitle of the pull request. Required unless issue is sent.
bodystringNãoDescription of the pull request, in Markdown.
draftbooleanNãoOpens it as a draft. In private repositories, drafts need GitHub Team or Enterprise Cloud.
maintainer_can_modifybooleanNãoLets the maintainers of the base repository push to the head branch of a fork.
issueintegerNãoNumber of an issue of the repository, the number of List issues, to turn into this pull request. Its title, body and comments move to the pull request.

Conexões possíveis

O seu cliente conecta a conta do GitHub uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/github, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/github_create_pull_request. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do GitHub

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.