Criar merge request no GitLab, por uma API
Abre uma merge request de source_branch para target_branch e a retorna, com seu iid. Um título que começa com Draft: a abre como rascunho. Notifica os assignees e reviewers.
- Identificador
- gitlab_create_merge_request
A chamada
POST https://connect.reportei.com/api/tools/gitlab_create_merge_request/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>",
"title": "<title>",
"source_branch": "<source_branch>",
"target_branch": "<target_branch>"
}
}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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | string | Sim | The id of the project from List projects, or its path_with_namespace, such as group/project. |
| title | string | Sim | Title of the merge request. |
| source_branch | string | Sim | Branch with the changes. |
| target_branch | string | Sim | Branch that receives the changes, such as main. |
| description | string | Não | Description of the merge request, in Markdown. |
| assignee_ids | array | Não | Ids of the users to assign, from List project members. |
| reviewer_ids | array | Não | Ids of the users to ask for review, from List project members. |
| labels | array | Não | Label names. A name that does not exist yet becomes a new label of the project. |
| milestone | string | Não | Title of a milestone of the project or of its groups. |
| remove_source_branch | boolean | Não | Deletes the source branch when the merge request is merged. |
| squash | boolean | Não | Squashes the commits into one on merge. Without it, the project setting decides. |
| allow_collaboration | boolean | Não | Lets the members who can merge into the target branch push to the source branch of a fork. |
Conexões possíveis
O seu cliente conecta a conta do GitLab 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/gitlab, 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/gitlab_create_merge_request. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do GitLab
- Listar projetosGETLista projetos, do mais novo ao mais antigo. Envie membership true para obter só os projetos da conta: sem isso, o GitLab.com retorna todos os projetos públicos. Cada item tem id e path_with_namespace, que as outras ferramentas aceitam como project. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Listar membros do projetoGETLista os membros de um projeto, inclusive os herdados dos grupos. Cada item tem id, username e name: o id é o que assignee_ids e reviewer_ids pedem. Pagine com page e per_page.
- Listar issuesGETLista as issues de todos os projetos que a conta enxerga. Por padrão, só as issues que a conta criou: envie scope assigned_to_me ou all para as outras. Cada item tem project_id e iid, que as ferramentas de issue pedem. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Listar issues do projetoGETLista as issues de um projeto, da mais nova à mais antiga. Cada item tem iid, o número da issue no projeto, que as ferramentas de issue pedem. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Obter issueGETRetorna uma issue de um projeto, com title, description, state, labels, assignees, milestone e due date.
- Criar issuePOSTCria uma issue em um projeto e a retorna, com seu iid. Notifica os participantes.
- Atualizar issuePUTAltera uma issue e a retorna. Só os campos enviados mudam, e pelo menos um deve ser enviado. Para fechar ou reabrir, envie state_event. labels substitui todos os labels; add_labels e remove_labels mudam só os citados.
- Listar notas da issueGETLista os comentários (notes) de uma issue, do mais novo ao mais antigo por padrão, inclusive as notas que o GitLab escreve a cada mudança. Envie activity_filter only_comments para manter só o que as pessoas escreveram. Pagine com page e per_page.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
