Crear pull request en GitHub, con una API

Abre un pull request desde la rama head hacia la rama base y lo devuelve, con su number. Envía title, o issue para convertir una issue existente en pull request. Notifica a quienes siguen el repositorio.

Identificador
github_create_pull_request

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
ownerstringSíLogin of the user or organization that owns the repository, the owner.login of List repositories.
repostringSíName of the repository, the name of List repositories.
headstringSíBranch with the changes. For a branch of a fork, write owner:branch.
basestringSíExisting branch of this repository that receives the changes, such as main.
titlestringNoTitle of the pull request. Required unless issue is sent.
bodystringNoDescription of the pull request, in Markdown.
draftbooleanNoOpens it as a draft. In private repositories, drafts need GitHub Team or Enterprise Cloud.
maintainer_can_modifybooleanNoLets the maintainers of the base repository push to the head branch of a fork.
issueintegerNoNumber 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.

Conexiones posibles

Tu cliente conecta su cuenta de GitHub una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/github, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/github_create_pull_request. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de GitHub

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.