Мы публикуем частые обновления нашей документации, и перевод этой страницы, возможно, еще выполняется. Актуальные сведения см. в документации на английском языке.
В настоящее время GitHub AE находится в ограниченном выпуске.
Сведения о типах событий, действиях активации в GitHub и уникальных свойствах каждого события в API событий и временной шкалы.
События проблемы активируются действиями в проблемах и запросах на вытягивание и доступны в API событий проблем и в API событий временной шкалы. Каждый тип события указывает, доступно ли событие в API событий проблемы или API событий временной шкалы.
REST API GitHub рассматривает каждый запрос на вытягивание как проблему, но не каждая проблема является запросом на вытягивание. По этой причине конечные точки событий проблемы и событий временной шкалы могут возвращать в ответе как проблемы, так и запросы на вытягивание. Запросы на вытягивание содержат свойство pull_request в объекте issue. Так как запросы на вытягивание являются проблемами, номера проблем и запросов на вытягивание не перекрываются в репозитории. Например, при открытии первой проблемы в репозитории ее номером будет 1. Если затем открыть запрос на вытягивание, его номером будет 2. Каждый тип события указывает, где происходит событие: в запросе на вытягивание, проблемах или и там, и там.
Общие свойства объекта события проблемы
События проблемы имеют одинаковую структуру объектов, за исключением событий, доступных только в API событий временной шкалы. Некоторые события также включают дополнительные свойства, которые предоставляют больше контекста о ресурсах событий. Дополнительные сведения о свойствах, отличающихся от этого формата объекта, см. в конкретном событии.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
added_to_project
На доску проекта добавлена проблема или запрос на вытягивание. Это событие отображается только в откликах, если в репозитории включены панели проектов.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Проблемы
Запрос на вытягивание
X
X
Свойства объекта события
Примечание. Сведения о карточке проекта теперь отображаются в ответах REST API для проблем, связанных с проектом, и событий временной шкалы. Эта функция теперь доступна разработчикам для предварительного просмотра. Дополнительные сведения см. в этой записи блога.
Чтобы получить атрибут project_card, панели проекта можно включить для репозитория, а также необходимо указать пользовательский тип мультимедиа в заголовке Accept:
application/vnd.github.starfox-preview+json
Предупреждение. API может быть изменен без предварительного уведомления в течение срока действия предварительной версии. Предварительные версии функций не поддерживаются для использования в рабочей среде. При возникновении каких-либо проблем обратитесь владелец предприятия.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
closed
Проблема или запрос на вытягивание закрыта. При наличии commit_id он определяет фиксацию, которая закрыла проблему с помощью синтаксиса "closes / fixes". Дополнительные сведения о синтаксисе см. в разделе Связывание запроса на вытягивание с проблемой.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
добавлен комментарий
К проблеме или запросу на вытягивание добавлен комментарий.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Проблемы
Запросы на вытягивание
X
Свойства объекта события
Структура этих свойств события отличается от структуры общих свойств объекта события проблемы. Для этого события возвращаются перечисленные ниже свойства.
Имя
Тип
Описание
url
string
URL-адрес REST API для получения комментария к проблеме.
Метка времени, указывающая время добавления комментария.
updated_at
string
Метка времени, указывающая время обновления комментария или время создания, если комментарий никогда не обновлялся.
author_association
string
Разрешения, которыми располагает пользователь в репозитории проблемы. Например, если владелец репозитория создал комментарий, значение будет "OWNER".
body
string
Основной текст комментария.
event
string
Значение события — "commented".
actor
object
Пользователь, создавший событие.
зафиксировано
В ветвь HEAD запроса на вытягивание добавлена фиксация.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Запросы на вытягивание
X
Свойства объекта события
Структура этих свойств события отличается от структуры общих свойств объекта события проблемы. Для этого события возвращаются перечисленные ниже свойства.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
converted_note_to_issue
Проблема создана путем преобразования заметки на доске проекта в проблему. Это событие отображается только в откликах, если в репозитории включены панели проектов.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Проблемы
X
X
Свойства объекта события
Примечание. Сведения о карточке проекта теперь отображаются в ответах REST API для проблем, связанных с проектом, и событий временной шкалы. Эта функция теперь доступна разработчикам для предварительного просмотра. Дополнительные сведения см. в этой записи блога.
Чтобы получить атрибут project_card, панели проекта можно включить для репозитория, а также необходимо указать пользовательский тип мультимедиа в заголовке Accept:
application/vnd.github.starfox-preview+json
Предупреждение. API может быть изменен без предварительного уведомления в течение срока действия предварительной версии. Предварительные версии функций не поддерживаются для использования в рабочей среде. При возникновении каких-либо проблем обратитесь владелец предприятия.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
перекрестная ссылка
На проблему или запрос на вытягивание ссылается другая проблема или запрос на вытягивание.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Проблемы
Запросы на вытягивание
X
Свойства объекта события
Структура этих свойств события отличается от структуры общих свойств объекта события проблемы. Для этого события возвращаются перечисленные ниже свойства.
Имя
Тип
Описание
actor
object
Пользователь, создавший событие.
created_at
string
Метка времени, указывающая время добавления перекрестной ссылки.
updated_at
string
Метка времени, указывающая время обновления перекрестной ссылки или время создания, если она никогда не обновлялась.
source
object
Проблема или запрос на вытягивание, добавивший перекрестную ссылку.
source[type]
string
Это значение всегда будет "issue", потому что запросы на вытягивание имеют тип проблемы. В API событий временной шкалы возвращаются только события перекрестной ссылки, активируемые проблемами или запросами на вытягивание. Чтобы определить, является ли проблема, активировавшая событие, запросом на вытягивание, можно проверить, существует ли объект source[issue][pull_request].
source[issue]
object
Объект issue, добавивший перекрестную ссылку.
event
string
Значение события — "cross-referenced".
demilestoned
Проблема или запрос на вытягивание удалены из вехи.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
отключен
Связь между проблемой или запросом на вытягивание и другой проблемой или запросом на вытягивание разорвана. Дополнительные сведения см. в разделе Связывание запроса на вытягивание с проблемой.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
marked_as_duplicate
Пользователь с разрешениями на запись пометил проблему как дубликат другой проблемы или запрос на вытягивание как дубликат другого запроса на вытягивание.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
объединенные
Запрос на вытягивание объединен. Атрибут commit_id — это SHA1 фиксации HEAD, которая была объединена. commit_repository всегда совпадает с основным репозиторием.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие. milestone
milestone[title]
string
Название вехи.
moved_columns_in_project
Проблема или запрос на вытягивание перемещены между столбцами на доске проекта. Это событие отображается только в откликах, если в репозитории включены панели проектов.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Проблемы
Запросы на вытягивание
X
X
Свойства объекта события
Примечание. Сведения о карточке проекта теперь отображаются в ответах REST API для проблем, связанных с проектом, и событий временной шкалы. Эта функция теперь доступна разработчикам для предварительного просмотра. Дополнительные сведения см. в этой записи блога.
Чтобы получить атрибут project_card, панели проекта можно включить для репозитория, а также необходимо указать пользовательский тип мультимедиа в заголовке Accept:
application/vnd.github.starfox-preview+json
Предупреждение. API может быть изменен без предварительного уведомления в течение срока действия предварительной версии. Предварительные версии функций не поддерживаются для использования в рабочей среде. При возникновении каких-либо проблем обратитесь владелец предприятия.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
referenced
На проблему ссылается сообщение о фиксации. Атрибут commit_id — это SHA1 фиксации, в которой произошло это событие, а commit_repository — место отправки этой фиксации.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие.
removed_from_project
Проблема или запрос на вытягивание удалены из доски проекта. Это событие отображается только в откликах, если в репозитории включены панели проектов.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Проблемы
Запросы на вытягивание
X
X
Свойства объекта события
Примечание. Сведения о карточке проекта теперь отображаются в ответах REST API для проблем, связанных с проектом, и событий временной шкалы. Эта функция теперь доступна разработчикам для предварительного просмотра. Дополнительные сведения см. в этой записи блога.
Чтобы получить атрибут project_card, панели проекта можно включить для репозитория, а также необходимо указать пользовательский тип мультимедиа в заголовке Accept:
application/vnd.github.starfox-preview+json
Предупреждение. API может быть изменен без предварительного уведомления в течение срока действия предварительной версии. Предварительные версии функций не поддерживаются для использования в рабочей среде. При возникновении каких-либо проблем обратитесь владелец предприятия.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие. requested_reviewer
review_requester
object
Пользователь, запросивший проверку.
reviewed
Запрос на вытягивание проверен.
Доступность
Тип проблемы
API событий проблемы
API событий временной шкалы
Запросы на вытягивание
X
Свойства объекта события
Структура этих свойств события отличается от структуры общих свойств объекта события проблемы. Для этого события возвращаются перечисленные ниже свойства.
Идентифицирует фактический тип наступившего события.
commit_id
string
SHA фиксации, которая ссылалась на эту проблему.
commit_url
string
Ссылка REST API GitHub на фиксацию, которая ссылалась на эту проблему.
created_at
string
Метка времени, указывающая, когда произошло событие. lock_reason
unmarked_as_duplicate
Проблема или запрос на вытягивание, который пользователь ранее пометил как дубликат другой проблемы или другого запроса на вытягивание соответственно, больше не считается дубликатом.