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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| owner | string | Sí | Login of the user or organization that owns the repository, the owner.login of List repositories. |
| repo | string | Sí | Name of the repository, the name of List repositories. |
| head | string | Sí | Branch with the changes. For a branch of a fork, write owner:branch. |
| base | string | Sí | Existing branch of this repository that receives the changes, such as main. |
| title | string | No | Title of the pull request. Required unless issue is sent. |
| body | string | No | Description of the pull request, in Markdown. |
| draft | boolean | No | Opens it as a draft. In private repositories, drafts need GitHub Team or Enterprise Cloud. |
| maintainer_can_modify | boolean | No | Lets the maintainers of the base repository push to the head branch of a fork. |
| issue | integer | No | Number 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
- Listar repositoriosGETLista los repositorios a los que llega la cuenta: los propios, aquellos donde es colaboradora y los de sus organizaciones. Cada elemento tiene owner.login y name, que son el owner y el repo que piden las demás herramientas. Pagina con page y per_page: una página con menos elementos que per_page es la última.
- Buscar issuesGETBusca issues y pull requests en todos los repositorios que ve la cuenta, con la sintaxis de búsqueda de GitHub en q. Devuelve total_count e items, hasta 1.000 resultados por búsqueda; pagina con page y per_page. Cada elemento tiene number, y repository_url termina con el owner y el repo del elemento.
- Listar issuesGETLista las issues de un repositorio, de la más nueva a la más antigua. Los pull requests también vienen en la lista, marcados con la clave pull_request. Pagina con page y per_page: una página con menos elementos que per_page es la última.
- Obtener issueGETDevuelve una issue, con title, body, state, labels, assignees y milestone. Una issue movida a otro repositorio responde 301 con su nueva ubicación.
- Crear issuePOSTCrea una issue en un repositorio y la devuelve, con su number. Labels, assignees, milestone y type se descartan en silencio cuando la cuenta no tiene acceso de push al repositorio. Notifica a quienes siguen el repositorio.
- Actualizar issuePATCHModifica una issue y la devuelve. Solo cambian los campos enviados. Para cerrarla, envía state closed con un state_reason. Labels y assignees reemplazan los actuales, y una lista vacía los borra.
- Listar comentarios de la issueGETLista los comentarios de una issue o de un pull request, del más antiguo al más nuevo. Los comentarios de revisión sobre el código de un pull request no están incluidos. Pagina con page y per_page: una página con menos elementos que per_page es la última.
- Crear comentario en la issuePOSTAgrega un comentario a una issue o a un pull request y lo devuelve. Notifica a los participantes.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
