Publicamos actualizaciones para la documentación con frecuencia y es posible que aún se esté traduciendo esta página. Para obtener la información más reciente, consulta la documentación en inglés.
Para la API de Eventos de Informes de Problemas y la API de Línea de Tiempo, aprende sobre cada tipo de evento, la acción que los activa en GitHub y las propiedades exclusivas de cada uno de ellos.
Los eventos de incidencia se desencadenan mediante la actividad en incidencias y solicitudes de incorporación de cambios, y están disponibles en Issue Events API y Timeline Events API. Cada tipo de evento especifica si éste está disponible en la API de Eventos de los Informes de Problemas o en la de Eventos de la Línea de tiempo.
La API de REST de GitHub considera a cada solicitud de extracción como un informe de problemas, pero no todos los informes de problemas consitutyen una solicitud de extracción. Por esta razón, las terminales de los Eventos de Informes de Problemas y las de Eventos de la Línea de Tiempo podrían devolver tanto informes de problemas como solicitudes de extracción en su respuesta. Las solicitudes de incorporación de cambios tienen una propiedad pull_request en el objeto issue. Ya que todas las solicitudes de extracción son informes de problemas, las cantidades de unas y de otras no se duplican en un repositorio. Por ejemplo, si abres tu primer informe de problemas en un repositorio, la cantidad será de 1. Si después abres una solicitud de extracción, a cantidad será de 2. Cada tipo de evento especifica si éste ocurre en solicitudes de extracción, informes de problemas, o en ambos.
Propiedades comunes del objeto del evento de los informes de problemas
Los eventos de los informes de problemas tienen la misma estructura de objeto, excepto aquellos eventos que solo se encuentran disponibles en la API de Eventos de la Línea de Tiempo. Algunos eventos también incluyen propiedades adicionales que proporcionan más contexto acerca de los recursos de éstos. Consulta el evento específico para encontrar más detalles sobre cualquier propiedad que difiera de este formato de objeto.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
added_to_project
El informe de problemas o solicitud de extracción se agregó a un tablero de proyecto. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Disponibilidad
Tipo de problema
API de eventos de Informes de Problemas
API de eventos de la línea de Tiempo
Incidencias
Solicitud de incorporación de cambios
X
X
Propiedades del objeto del evento
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a your site administrator.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento. assignee
assigner
object
Persona que ha realizado la cancelación de la asignación de esta incidencia. Este campo está disponible en la API de eventos de incidencias, pero no en la API de eventos de escala de tiempo.
automatic_base_change_failed
GitHub intentó cambiar la rama base de la solicitud de extracción automáticamente y sin éxito.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
closed
Se cerró el informe de problemas o la solicitud de extracción. Cuando commit_id está presente, identifica la confirmación que ha cerrado la incidencia, mediante la sintaxis "cierres / revisiones". Para más información sobre la sintaxis, vea "Vinculación de una solicitud de incorporación de cambios a una incidencia".
La persona que comentó en el informe de problemas.
created_at
string
La marca de tiempo que indica cuándo se agregó el comentario.
updated_at
string
La marca de tiempo que indica cuándo se actualizó o creó el comentario en caso de que éste jamás se haya actualizado.
author_association
string
Los permisos que tiene el usuario en el repositorio del informe de problemas. Por ejemplo, el valor sería "OWNER" si el propietario del repositorio ha creado un comentario.
body
string
El cuerpo de texto del comentario.
event
string
El valor del evento es "commented".
actor
object
La persona que generó el evento.
confirmadas
Se ha agregado una confirmación a la rama HEAD de la solicitud de incorporación de cambios.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
converted_note_to_issue
El informe de problemas se creó convirtiendo una nota en un tablero de proyecto para un informe de problemas. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Disponibilidad
Tipo de problema
API de eventos de Informes de Problemas
API de eventos de la línea de Tiempo
Issues
X
X
Propiedades del objeto del evento
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a your site administrator.
La marca de tiempo que indica cuándo se agregó la referencia cruzada.
updated_at
string
La marca de tiempo que indica cuándo se actualizó o creó la referencia cruzada en caso de que ésta jamás se haya actualizado.
source
object
La solicitud de extracción o informe de problemas que agregó la referencia cruzada.
source[type]
string
Este valor siempre será "issue" ya que las solicitudes de incorporación de cambios son de tipo incidencia. En la API de Eventos de la Línea de Tiempo solo se devolverán los eventos de referencia cruzada que se activen con informes de problemas o solicitudes de extracción. Para determinar si la incidencia que ha desencadenado el evento es una solicitud de incorporación de cambios, puede comprobar si existe el objeto source[issue][pull_request].
source[issue]
object
Objeto issue que ha agregado la referencia cruzada.
event
string
El valor del evento es "cross-referenced".
demilestoned
El informe de problemas o solicitud de extracción se elimnó de un hito.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
combinados
Se fusionó la solicitud de extracción. El atributo commit_id es el SHA1 de la confirmación HEAD que se ha combinado. commit_repository siempre es lo mismo que el repositorio principal.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento. milestone
milestone[title]
string
Título del hito.
moved_columns_in_project
El informe de problemas o solicitud de extracción se movió entre columnas en un tablero de proyecto. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Disponibilidad
Tipo de problema
API de eventos de Informes de Problemas
API de eventos de la línea de Tiempo
Issues
Solicitudes de incorporación de cambios
X
X
Propiedades del objeto del evento
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a your site administrator.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
referenced
Se referenció al informe de problemas desde un mensaje de confirmación. El atributo commit_id es la confirmación de tipo SHA1 de donde ha sucedido y commit_repository es donde se ha insertado esa confirmación.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
removed_from_project
El informe de problemas o solicitud de extracción se eliminó de un tablero de proyecto. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Disponibilidad
Tipo de problema
API de eventos de Informes de Problemas
API de eventos de la línea de Tiempo
Issues
Solicitudes de incorporación de cambios
X
X
Propiedades del objeto del evento
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a your site administrator.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento. dismissed_review
dismissed_review[state]
string
Estado en el que se encontraba la solicitud de incorporación de cambios cuando se ha descartado. Puede ser de tipo commented, approved o changes_requested.
dismissed_review[review_id]
string
Identificador único de la revisión de la solicitud de incorporación de cambios.
dismissed_review[dismissal_message]
string
Mensaje que el usuario ha incluido al descartar la revisión.
dismissed_review[dismissal_commit_id]
string
Identificador único de la confirmación que ha descartado la revisión, si existe.
review_requested
Se solicitó una revisión de una solicitud de extracción.
La persona que comentó en el informe de problemas.
body
string
El texto de resúmen de la revisión.
commit_id
string
El SHA de la última confirmación en la soicitud de extracción al momento de la revisión.
submitted_at
string
La marca de tiempo que indica cuándo se emitió la revisión.
state
string
El estado de la revisión emitida. Puede ser: commented, changes_requested o approved.
html_url
string
La URL de HTML para la revisión.
pull_request_url
string
La URL de la API de REST que recuperará la solicitud de extracción.
author_association
string
Los permisos que tiene el usuario en el repositorio del informe de problemas. Por ejemplo, el valor sería "OWNER" si el propietario del repositorio ha creado un comentario.
_links
object
html_url y pull_request_url.
event
string
El valor del evento es "reviewed".
subscribed
Alguien se suscribió para recibir notificaciones para un informe de problemas o solicitud de extracción.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento. assignee
assigner
object
Persona que ha realizado la cancelación de la asignación de esta incidencia. Este campo está disponible en la API de eventos de incidencias, pero no en la API de eventos de escala de tiempo.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento. lock_reason
unmarked_as_duplicate
Un informe de problemas que algún usuario había marcado previamente como duplicado de otro informe de problemas ya no se considera como duplicado, o el mismo caso con solicitudes de extracción.