Listar comentários da issue no GitHub, por uma API
Lista os comentários de uma issue ou de um pull request, do mais antigo para o mais novo. Os comentários de revisão no código de um pull request não estão incluídos. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Identificador
- github_list_issue_comments
A chamada
POST https://connect.reportei.com/api/tools/github_list_issue_comments/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>",
"issue_number": 1
}
}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 |
|---|---|---|---|
| owner | string | Sim | Login of the user or organization that owns the repository, the owner.login of List repositories. |
| repo | string | Sim | Name of the repository, the name of List repositories. |
| issue_number | integer | Sim | Number of the issue or pull request, the number of List issues, Search issues or List pull requests. |
| since | string | Não | Only comments updated after this time, as YYYY-MM-DDTHH:MM:SSZ. |
| per_page | integer | Não | Results per page, up to 100. The default is 30. |
| page | integer | Não | Page number, starting at 1. |
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_list_issue_comments. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do GitHub
- Listar repositóriosGETLista os repositórios que a conta alcança: os próprios, aqueles em que é colaboradora e os de suas organizações. Cada item tem owner.login e name, que são o owner e o repo que as outras ferramentas pedem. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Buscar issuesGETBusca issues e pull requests em todos os repositórios que a conta enxerga, com a sintaxe de busca do GitHub em q. Retorna total_count e items, até 1.000 resultados por busca; pagine com page e per_page. Cada item tem number, e repository_url termina com o owner e o repo do item.
- Listar issuesGETLista as issues de um repositório, da mais nova para a mais antiga. Pull requests também vêm na lista, marcados com a chave pull_request. Pagine com page e per_page: uma página com menos itens que per_page é a última.
- Obter issueGETRetorna uma issue, com title, body, state, labels, assignees e milestone. Uma issue movida para outro repositório responde 301 com o novo endereço.
- Criar issuePOSTCria uma issue em um repositório e a retorna, com seu number. Labels, assignees, milestone e type são descartados em silêncio quando a conta não tem acesso de push ao repositório. Notifica quem acompanha o repositório.
- Atualizar issuePATCHAltera uma issue e a retorna. Só os campos enviados mudam. Para fechá-la, envie state closed com um state_reason. Labels e assignees substituem os atuais, e uma lista vazia os limpa.
- Criar comentário na issuePOSTAdiciona um comentário a uma issue ou a um pull request e o retorna. Notifica os participantes.
- Listar pull requestsGETLista os pull requests de um repositório, do mais novo para o mais antigo. Pagine com page e per_page: uma página com menos itens que per_page é a última.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
