Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.
Para a API de eventos de problemas e API da Linha do tempo, aprenda sobre cada tipo de evento, ativando a ação em GitHub, bem como as propriedades únicas de cada evento.
Eventos de problemas são acionados pela atividade em problemas e pull requests e estão disponíveis na API de eventos de problemas e na API de eventos da linha do tempo. Cada tipo de evento especifica se o evento está disponível nos eventos do problema ou na API de eventos da linha do tempo.
A API REST do GitHub considera que todo pull request é um problema, mas nem todos os problemas são pull request. Por este motivo, os eventos de problemas e os pontos de extremidade dos eventos da linha do tempo podem retornar problemas e pull requests na resposta. Pull requests têm uma propriedade pull_request no objeto problema. Como os pull requests são problemas, os números de problemas e pull requests não se sobrepõem em um repositório. Por exemplo, se você abrir seu primeiro problema em um repositório, o número será 1. Se você abrir um pull request, o número será 2. Cada tipo de evento especifica se o evento ocorre em um pull request, em um problema ou em ambos.
Propriedades comuns do objeto de evento do problema
Todos os eventos de problema têm a mesma estrutura de objeto, exceto os eventos que estão disponíveis apenas na API de eventos da linha do tempo. Alguns eventos também incluem propriedades adicionais que fornecem mais contexto sobre os recursos do evento. Consulte o evento específico para obter informações sobre quaisquer propriedades que diferem deste formato de objeto.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
added_to_project
O problema ou pull request foi adicionado a um quadro de projeto. Você só vê esse evento nas respostas quando os quadros de projeto estão habilitados no repositório.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
Pull request
X
X
Propriedades do objeto do evento
Observação: Os detalhes do cartão do projeto agora são mostrados em respostas da API REST para eventos relacionados ao projeto e da linha do tempo. Esse recurso agora está disponível para pré-visualização dos desenvolvedores. Para obter informações, consulte o post do blogue.
Para receber o atributo project_card, os quadros de projeto devem estar habilitados para um repositório e você deve fornecer um tipo de mídia personalizado no cabeçalho Aceitar:
application/vnd.github.starfox-preview+json
Aviso: A API pode mudar sem aviso prévio durante o período de pré-visualização. Os recursos de visualização não são compatíveis com o uso em produção. Em caso de problemas, entre em contato com your site administrator.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
closed
O problema ou pull request foi fechado. Quando o commit_id está presente, ele identifica o commit que fechou o problema usando sintaxe "fecha/corrige". Para obter mais informações sobre a sintaxe, consulte "Vinculando um pull request a um problema".
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
comentado
Um comentário foi adicionado ao problema ou pull request.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
Pull requests
X
Propriedades do objeto do evento
Estes eventos não usam a mesma estrutura que as propriedades comuns do evento de issue event object common properties. As seguintes propriedades são retornadas para este evento.
Nome
Tipo
Descrição
url
string
A URL da API REST para recuperar o comentário do problema.
A marca de tempo que indica quando o comentário foi adicionado.
updated_at
string
A marca de tempo que indica quando o comentário foi atualizado ou criado, se o comentário nunca for atualizado.
author_association
string
As permissões que o usuário tem no repositório do problema. Por exemplo, o valor seria "PROPRIETÁRIO" se o proprietário do repositório criasse um comentário.
texto
string
O texto do comentário.
event
string
O valor da reunião é "comentado".
actor
objeto
A pessoa que gerou o evento.
comprometido
Um commit foi adicionado ao branch HEAD do pull request.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Pull requests
X
Propriedades do objeto do evento
Estes eventos não usam a mesma estrutura que as propriedades comuns do evento de issue event object common properties. As seguintes propriedades são retornadas para este evento.
O problema ou pull request foi vinculado a outro problema ou pull request. Para obter mais informações, consulte "Vincular um pull request a um problema".
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
converted_note_to_issue
O problema foi criado convertendo uma observação de um quadro de projeto em uma problema. Você só vê esse evento nas respostas quando os quadros de projeto estão habilitados no repositório.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
X
X
Propriedades do objeto do evento
Observação: Os detalhes do cartão do projeto agora são mostrados em respostas da API REST para eventos relacionados ao projeto e da linha do tempo. Esse recurso agora está disponível para pré-visualização dos desenvolvedores. Para obter informações, consulte o post do blogue.
Para receber o atributo project_card, os quadros de projeto devem estar habilitados para um repositório e você deve fornecer um tipo de mídia personalizado no cabeçalho Aceitar:
application/vnd.github.starfox-preview+json
Aviso: A API pode mudar sem aviso prévio durante o período de pré-visualização. Os recursos de visualização não são compatíveis com o uso em produção. Em caso de problemas, entre em contato com your site administrator.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
project_card
object
O objeto do cartão do projeto. project_id
cross-referenced
O problema ou pull request foi referenciado a partir de outro problema ou pull request.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
Pull requests
X
Propriedades do objeto do evento
Estes eventos não usam a mesma estrutura que as propriedades comuns do evento de issue event object common properties. As seguintes propriedades são retornadas para este evento.
Nome
Tipo
Descrição
actor
objeto
A pessoa que gerou o evento.
created_at
string
A marca de tempo que indica quando a referência cruzada foi adicionada.
updated_at
string
A marca de tempo que indica quando a referência cruzada foi atualizada ou criada, se a referência cruzada nunca for atualizada.
fonte
objeto
O problema ou pull request que adicionou uma referência cruzada.
source[type]
string
Esse valor será sempre "problema", porque os pull requests são do tipo problema. Apenas eventos de referência cruzada acionados por problemas são retornados na API de eventos da linha te tempo. Para determinar se o problema que acionou o evento é um pull request, você pode verificar se o objeto [issue][pull_request existe.
source[issue]
objeto
O objeto problema que adicionou a referência cruzada.
event
string
O valor do evento é "referência cruzada".
demilestoned
O problema ou pull request foi removido de um marco.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
desconectado
O problema ou o pull request foi desvinculado de outro problema ou pull request. Para obter mais informações, consulte "Vincular um pull request a um problema".
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
merged
O pull request foi mesclado. O atributo commit_id é o SHA1 do commit do HEAD que foi mesclado. O commit_repository é sempre o mesmo do repositório principal.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
marco
objeto
Objeto do marco. marco[title]
moved_columns_in_project
O problema ou pull request foi movido entre as colunas em um quadro de projeto. Você só vê esse evento nas respostas quando os quadros de projeto estão habilitados no repositório.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
Pull requests
X
X
Propriedades do objeto do evento
Observação: Os detalhes do cartão do projeto agora são mostrados em respostas da API REST para eventos relacionados ao projeto e da linha do tempo. Esse recurso agora está disponível para pré-visualização dos desenvolvedores. Para obter informações, consulte o post do blogue.
Para receber o atributo project_card, os quadros de projeto devem estar habilitados para um repositório e você deve fornecer um tipo de mídia personalizado no cabeçalho Aceitar:
application/vnd.github.starfox-preview+json
Aviso: A API pode mudar sem aviso prévio durante o período de pré-visualização. Os recursos de visualização não são compatíveis com o uso em produção. Em caso de problemas, entre em contato com your site administrator.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
referenciado
O problema foi referenciado a partir de uma mensagem de commit. O atributo do commit_id` é o SHA1 do commit onde isso ocorreu e o commit_repository é o local onde esse commit foi feito carregado.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
Pull requests
X
X
Propriedades do objeto do evento
| Nome | Tipo | Descrição |
| ------------ | --------- | ---------------------------------------------------------------------- |
| `id` | `inteiro` | O identificador exclusivo do evento. |
| `node_id` | `string` | O [Global Node ID](/graphql/guides/using-global-node-ids) do evento. |
| `url` | `string` | A URL da API REST para buscar o evento. |
| `actor` | `objeto` | A pessoa que gerou o evento. |
| `event` | `string` | Identifica o tipo atual do evento que ocorreu. |
| `commit_id` | `string` | O SHA do commit que fez referência a esta issue. |
| `commit_url` | `string` | O link da GitHub REST API para o commit que referenciou este problema. |
| `created_at` | `string` | O timestamp indicando quando ocorreu o evento. |
removed_from_project
O problema ou pull request foi removido de um quadro de projeto. Você só vê esse evento nas respostas quando os quadros de projeto estão [habilitados](/articles/disabling-project-boards-in-a-repository) no repositório.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
Pull requests
X
X
Propriedades do objeto do evento
Observação: Os detalhes do cartão do projeto agora são mostrados em respostas da API REST para eventos relacionados ao projeto e da linha do tempo. Esse recurso agora está disponível para pré-visualização dos desenvolvedores. Para obter informações, consulte o post do blogue.
Para receber o atributo project_card, os quadros de projeto devem estar habilitados para um repositório e você deve fornecer um tipo de mídia personalizado no cabeçalho Aceitar:
application/vnd.github.starfox-preview+json
Aviso: A API pode mudar sem aviso prévio durante o período de pré-visualização. Os recursos de visualização não são compatíveis com o uso em produção. Em caso de problemas, entre em contato com your site administrator.
| Nome | Tipo | Descrição |
| ------------ | --------- | ---------------------------------------------------------------------- |
| `id` | `inteiro` | O identificador exclusivo do evento. |
| `node_id` | `string` | O [Global Node ID](/graphql/guides/using-global-node-ids) do evento. |
| `url` | `string` | A URL da API REST para buscar o evento. |
| `actor` | `objeto` | A pessoa que gerou o evento. |
| `event` | `string` | Identifica o tipo atual do evento que ocorreu. |
| `commit_id` | `string` | O SHA do commit que fez referência a esta issue. |
| `commit_url` | `string` | O link da GitHub REST API para o commit que referenciou este problema. |
| `created_at` | `string` | O timestamp indicando quando ocorreu o evento. |
`project_card` | `object` | O objeto do cartão do projeto. `project_id` | `integer` | O identificador exclusivo do cartão do projeto. `project_url` | `string` | A REST API URL para recuperar o cartão do projeto. `column_name` | `string` | O nome da coluna na qual o problema está.
renamed
O problema ou o título do pull request foi alterado.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Problemas
Pull requests
X
X
Propriedades do objeto do evento
| Nome | Tipo | Descrição |
| ------------ | --------- | ---------------------------------------------------------------------- |
| `id` | `inteiro` | O identificador exclusivo do evento. |
| `node_id` | `string` | O [Global Node ID](/graphql/guides/using-global-node-ids) do evento. |
| `url` | `string` | A URL da API REST para buscar o evento. |
| `actor` | `objeto` | A pessoa que gerou o evento. |
| `event` | `string` | Identifica o tipo atual do evento que ocorreu. |
| `commit_id` | `string` | O SHA do commit que fez referência a esta issue. |
| `commit_url` | `string` | O link da GitHub REST API para o commit que referenciou este problema. |
| `created_at` | `string` | O timestamp indicando quando ocorreu o evento. |
renomear` | `objeto` | As informações do nome. `renomear[from]` | `string` | O nome anterior. `Renomear[to]` | `string` | O novo nome.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
requested_reviewer
object
A pessoa solicitou a revisão da pull request. review_requester
revisado
O pull request foi revisado.
Disponibilidade
Tipo de problema
API de eventos de problema
API de eventos da linha de tempo
Pull requests
X
Propriedades do objeto do evento
Estes eventos não usam a mesma estrutura que as propriedades comuns do evento de issue event object common properties. As seguintes propriedades são retornadas para este evento.
O SHA do último commit no pull request no momento da revisão.
submitted_at
string
A marca de tempo que indica quando a revisão foi enviada.
estado
string
O estado da revisão enviada. Pode ser um desses: comentado, changes_requested ou aprovado.
html_url
string
A URL de HTML da revisão.
pull_request_url
string
A URL da API REST para recuperar a o pull request.
author_association
string
As permissões que o usuário tem no repositório do problema. Por exemplo, o valor seria "PROPRIETÁRIO" se o proprietário do repositório criasse um comentário.
_links
objeto
O html_url e pull_request_url.
event
string
O valor do evento é "revisado".
assinado
Alguém faz a assinatura para receber notificações de um problema ou pull request.
O link da GitHub REST API para o commit que referenciou este problema.
created_at
string
O timestamp indicando quando ocorreu o evento.
lock_reason
string
O motivo pelo qual uma conversa sobre o problema ou pull request foi bloqueada, caso tenha sido fornecida.
unmarked_as_duplicate
Um problema que um usuário havia marcado anteriormente como uma duplicata de outro problema não é considerado mais uma duplicata, ou um pull request que um usuário havia marcado anteriormente como uma duplicata de outro pull request não é mais considerado uma duplicata.