Поделиться через

GitHub

GitHub — это веб-служба размещения репозитория Git. Он предлагает все функции распределенного управления редакцией и управления исходным кодом (SCM) Git, а также добавление собственных функций.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Стандарт Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Стандарт Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Стандарт Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Microsoft
URL https://support.microsoft.com/
Адрес электронной почты [email protected]
Метаданные соединителя
Publisher Microsoft
Website https://github.com/
Политика конфиденциальности https://github.com/trust-center/privacy
Категории ИТ-операции; Сотрудничество

Издатель приложений Github соединителя

Этот соединитель использует приложения по учетной записи aaptapps

Подробное описание соединителя

Дополнительные сведения о соединителе см. в подробном разделе.

Известные проблемы и ограничения

Обратите внимание, что активирует поиск элементов проблемы в разных репозиториях, назначенных пользователю, прошедшим проверку подлинности. Репозитории организации не поддерживаются.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд
Частота опросов триггеров 1 15 секунд

Действия

Github MCP Server

Github MCP Server
Вывод списка участников совместной работы репозитория

Вывод списка участников совместной работы репозитория.
Добавление выбранного репозитория в секрет организации (предварительная версия)

Добавляет репозиторий в секрет организации, если visibility для доступа к репозиторию задано selectedзначение . Видимость устанавливается при создании или обновлении секрета организации. Для использования этой конечной точки необходимо пройти проверку подлинности с помощью маркера доступа с admin:org областью действия. Приложения GitHub должны иметь secrets разрешение организации на использование этой конечной точки.
Запрос рецензентов для запроса на вытягивание (предварительная версия)

Запрашивает запрос на вытягивание из заданного набора пользователей и (или) команд.
Обновление вехи

Обновите существующую веху.
Обновление запроса на вытягивание (предварительная версия)

Эта операция используется для обновления запроса на вытягивание репозитория. Чтобы обновить запрос на вытягивание в общедоступном репозитории, необходимо иметь доступ на запись к головной или исходной ветви. Для репозиториев, принадлежащих организации, необходимо быть членом организации, владеющей репозиторием, чтобы открыть или обновить запрос на вытягивание.
Обновление проблемы

Обновите существующую проблему, учитывая номер проблемы.
Перечисляет все вехи репозитория

Перечисляет все вехи репозитория.
Перечисляет доступные назначающиеся для проблем в репозитории

Перечисляет доступные назначенные для проблем в репозитории.
Поиск Github с помощью запроса

Поиск Github с помощью запроса
Поиск проблем по состоянию и ключевому слову

Поиск проблем по состоянию и ключевому слову.
Получение всех запросов на вытягивание репозитория

Получение всех запросов на вытягивание репозитория.
Получение всех проблем репозитория

Получение всех проблем репозитория.
Получение запроса на вытягивание (предварительная версия)

Эта операция используется для получения запроса на вытягивание репозитория.
Получение конкретной проблемы репозитория

Получение конкретной проблемы репозитория.
Получение открытого ключа репозитория (предварительная версия)

Получает открытый ключ, который необходимо зашифровать секреты. Перед созданием или обновлением секретов необходимо зашифровать секрет.
Получение пользователя, прошедшего проверку подлинности

Получите прошедшего проверку подлинности пользователя.
Получение репозитория по идентификатору (предварительная версия)

Возвращает репозиторий по идентификатору.
Получение списка файлов из запроса на вытягивание (предварительная версия)

Эта операция используется для получения списка файлов из запроса на вытягивание репозитория.
Получение ссылки (предварительная версия)

Возвращает одну ссылку из базы данных Git. Параметр reference должен быть отформатирован как heads/<branch name> для ветвей и tags/<tag name> тегов. reference Если значение не соответствует существующему ссылок, 404 возвращается значение.
Проверка того, является ли пользователь сотрудником репозитория

Проверьте, является ли пользователь сотрудником репозитория.
Слияние запроса на вытягивание (предварительная версия)

Эта операция используется для объединения запроса на вытягивание для репозитория.
Создание запроса на вытягивание (предварительная версия)

Эта операция заключается в создании запроса на вытягивание в репозитории. Чтобы открыть или обновить запрос на вытягивание в общедоступном репозитории, необходимо иметь доступ на запись к головной или исходной ветви. Для репозиториев, принадлежащих организации, необходимо быть членом организации, владеющей репозиторием, чтобы создать запрос на вытягивание.
Создание или обновление секрета репозитория (предварительная версия)

Создает или обновляет секрет репозитория с зашифрованным значением. Зашифруйте секрет с помощью LibSodium.
Создание проблемы

Эта операция используется для создания новой проблемы для определенного репозитория.
Создание репозитория с помощью шаблона (предварительная версия)

Создает новый репозиторий с помощью шаблона репозитория. Прошедший проверку подлинности пользователь должен принадлежать или быть членом организации, которая владеет репозиторием.
Создание события отправки репозитория (предварительная версия)

Эта операция заключается в активации события веб-перехватчика, вызываемого repository_dispatch при желании действия, которое происходит за пределами GitHub, чтобы активировать рабочий процесс GitHub Actions или веб-перехватчик приложения GitHub. При возникновении repository_dispatch события необходимо настроить рабочий процесс GitHub Actions или приложение GitHub.
Создание ссылки (предварительная версия)

Создает ссылку для репозитория. Невозможно создать новые ссылки для пустых репозиториев, даже если используется хэш SHA-1 фиксации. Пустые репозитории — это репозитории без ветвей.
Список всех меток для проблемы

Перечисляет все метки для проблемы.
Список всех меток для репозитория

Перечисляет все метки для репозитория.
Список всех общедоступных репозиториев для организации

Выводит список всех общедоступных репозиториев для организации.
Список всех общедоступных репозиториев для пользователя

Выводит список всех общедоступных репозиториев для пользователя.
Список всех репозиториев для прошедшего проверку подлинности пользователя

Выводит список всех репозиториев (как общедоступных, так и частных) для прошедшего проверку подлинности пользователя.
Сравнение двух фиксаций (предварительная версия)

Оба base и head должны быть именами ветвей в repositoryName. Чтобы сравнить ветви между другими репозиториями в той же сети, что repositoryNameи формат <USERNAME>:branch. Ответ эквивалентен выполнению git log base..head команды. Однако фиксации возвращаются в хронологическом порядке.
Удаление выбранного репозитория из секрета организации (предварительная версия)

Удаляет репозиторий из секрета организации, если visibility для доступа к репозиторию задано значение selected. Видимость устанавливается при создании или обновлении секрета организации. Для использования этой конечной точки необходимо пройти проверку подлинности с помощью маркера доступа с admin:org областью действия. Приложения GitHub должны иметь secrets разрешение организации на использование этой конечной точки.
Удаление запрошенных рецензентов из запроса на вытягивание (предварительная версия)

Удалите запрошенных рецензентов из запроса на вытягивание из заданного набора пользователей и (или) команд.
Удаляет веб-перехватчик GitHub (предварительная версия)

Удаляет веб-перехватчик GitHub

Github MCP Server

Идентификатор операции:
InvokeMCPServer

Github MCP Server

Вывод списка участников совместной работы репозитория

Идентификатор операции:
ListCollaborators

Вывод списка участников совместной работы репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Отображаемый номер страницы.

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Добавление выбранного репозитория в секрет организации (предварительная версия)

Идентификатор операции:
AddSelectedRepoToOrgSecret

Добавляет репозиторий в секрет организации, если visibility для доступа к репозиторию задано selectedзначение . Видимость устанавливается при создании или обновлении секрета организации. Для использования этой конечной точки необходимо пройти проверку подлинности с помощью маркера доступа с admin:org областью действия. Приложения GitHub должны иметь secrets разрешение организации на использование этой конечной точки.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Идентификатор репозитория
 repositoryId True integer

Уникальный идентификатор репозитория.
Имя секрета
 secretName True string

Имя секрета.

Запрос рецензентов для запроса на вытягивание (предварительная версия)

Идентификатор операции:
RequestReviewersPullRequest

Запрашивает запрос на вытягивание из заданного набора пользователей и (или) команд.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер вытягивания
 pullNumber True integer

Номер вытягивания.
Авторам
 reviewers array of string
team_reviewers
 team_reviewers array of string

Обновление вехи

Идентификатор операции:
UpdateMilestone

Обновите существующую веху.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер вехи
 milestoneNumber True integer

Номер вехи для заданной вехи.
Название
 title string

Сводка по вехе.
Государство
 state string

Открытое или близкое состояние вехи.
Вехи
 description string

Описание вехи.
due_on
 due_on string

Дата выполнения вехи.

Возвращаемое значение

Коллекция связанных проблем и запросов на вытягивание.

response
Milestone

Обновление запроса на вытягивание (предварительная версия)

Идентификатор операции:
UpdatePullRequest

Эта операция используется для обновления запроса на вытягивание репозитория. Чтобы обновить запрос на вытягивание в общедоступном репозитории, необходимо иметь доступ на запись к головной или исходной ветви. Для репозиториев, принадлежащих организации, необходимо быть членом организации, владеющей репозиторием, чтобы открыть или обновить запрос на вытягивание.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер вытягивания
 pullNumber True integer

Номер вытягивания.
Название
 title string

Заголовок запроса на вытягивание.
Тело
 body string

Содержимое запроса на вытягивание.
Государство
 state string

Состояние этого запроса на вытягивание. open или closed.
Base
 base string

Имя ветви, в которую вы хотите включить изменения. Это должна быть существующая ветвь в текущем репозитории. Вы не можете обновить базовую ветвь в запросе на вытягивание, чтобы указать другой репозиторий.
Может ли поддерживать изменение?
 maintainer_can_modify boolean

Указывает, могут ли поддерживающие изменять запрос на вытягивание.

Возвращаемое значение

Запросы на вытягивание позволяют другим пользователям сообщать о изменениях, которые вы добавили в репозиторий на сайте GitHub. После отправки запроса на вытягивание заинтересованные стороны могут просмотреть набор изменений, обсудить возможные изменения и даже отправить фиксации последующих действий при необходимости.

Тело
PullRequest

Обновление проблемы

Идентификатор операции:
UpdateIssueNum

Обновите существующую проблему, учитывая номер проблемы.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер проблемы
 issueNumber True integer

Номер проблемы для данной проблемы.
Название
 title string

Сводка проблемы.
Тело
 body string

Описание проблемы.
assignee
 assignee string

Назначаемый участник проблемы.
Государство
 state string

Открытое или закрытое состояние проблемы. Может быть одним из открытых или закрытых.
ChangeReason
 state_reason string

Причина изменения состояния.
Вехи
 milestone string

Количество вех для связывания с проблемой.
labels
 labels array of string

метки, связанные с проблемой.
Назначенных
 assignees array of string

Имя пользователя, назначаемое проблеме.

Возвращаемое значение

Свойства проблемы с GitHub.

Тело
IssueDetailsModel

Перечисляет все вехи репозитория

Идентификатор операции:
GetMilestones

Перечисляет все вехи репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
государство
 state string

Состояние вехи.
sort
 sort string

Что сортировать результаты по.
направление
 direction string

Направление сортировки.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Отображаемый номер страницы.

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Перечисляет доступные назначающиеся для проблем в репозитории

Идентификатор операции:
GetAssignees

Перечисляет доступные назначенные для проблем в репозитории.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Отображаемый номер страницы.

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Поиск Github с помощью запроса

Идентификатор операции:
SearchGithubWithQuery

Поиск Github с помощью запроса

Параметры

Имя Ключ Обязательно Тип Описание
query
 query string

query

Поиск проблем по состоянию и ключевому слову

Идентификатор операции:
SearchIssues

Поиск проблем по состоянию и ключевому слову.

Параметры

Имя Ключ Обязательно Тип Описание
q
 q True string

Ключевые слова поиска и квалификаторы.
sort
 sort string

Свойство для сортировки результатов по.
заказ
 order string

Направление сортировки.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Номер страницы для получения

Возвращаемое значение

Модель получения результатов поиска

Тело
MultipleSearchFetchModel

Получение всех запросов на вытягивание репозитория

Идентификатор операции:
GetPullRequests

Получение всех запросов на вытягивание репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
государство
 state string

Фильтрация по состоянию.
голова
 head string

Фильтрация по головному пользователю или организации.
основа
 base string

Фильтрация по имени базовой ветви.
sort
 sort string

Что сортировать результаты по.
направление
 direction string

Направление сортировки.
perPage
 per_page integer

Количество результатов на страницу.
page
 page integer

Отображаемый номер страницы.

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Получение всех проблем репозитория

Идентификатор операции:
GetIssues

Получение всех проблем репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
веха
 milestone string

Фильтрация по вехе.
государство
 state string

Фильтрация по состоянию.
assignee
 assignee string

Фильтруйте по назначаемой.
создатель
 creator string

Фильтрация по создателю.
mentioned
 mentioned string

Фильтрация по упоминаниям.
labels
 labels string

Фильтрация по именам меток.
sort
 sort string

Поле для сортировки результатов по.
направление
 direction string

Направление сортировки.
с
 since string

Фильтрация по проблемам после заданной даты.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Отображаемый номер страницы.

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Получение запроса на вытягивание (предварительная версия)

Идентификатор операции:
GetPullRequest

Эта операция используется для получения запроса на вытягивание репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер вытягивания
 pullNumber True integer

Номер вытягивания.

Возвращаемое значение

Запросы на вытягивание позволяют другим пользователям сообщать о изменениях, которые вы добавили в репозиторий на сайте GitHub. После отправки запроса на вытягивание заинтересованные стороны могут просмотреть набор изменений, обсудить возможные изменения и даже отправить фиксации последующих действий при необходимости.

Тело
PullRequest

Получение конкретной проблемы репозитория

Идентификатор операции:
GetIssueNum

Получение конкретной проблемы репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер проблемы
 issueNumber True integer

Номер проблемы для данной проблемы.

Возвращаемое значение

Свойства проблемы с GitHub.

Тело
IssueDetailsModel

Получение открытого ключа репозитория (предварительная версия)

Идентификатор операции:
GetRepositoryPublicKey

Получает открытый ключ, который необходимо зашифровать секреты. Перед созданием или обновлением секретов необходимо зашифровать секрет.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.

Возвращаемое значение

Открытый ключ, используемый для задания секретов действий.

Тело
ActionsPublicKey

Получение пользователя, прошедшего проверку подлинности

Идентификатор операции:
GetUser

Получите прошедшего проверку подлинности пользователя.

Возвращаемое значение

Свойства пользователя GitHub.

Тело
UserDetailsModel

Получение репозитория по идентификатору (предварительная версия)

Идентификатор операции:
GetRepositoryById

Возвращает репозиторий по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор репозитория
 repositoryId True integer

Уникальный идентификатор репозитория.

Возвращаемое значение

Репозиторий Git

Тело
RepositoryDetails

Получение списка файлов из запроса на вытягивание (предварительная версия)

Идентификатор операции:
GetPullRequestFiles

Эта операция используется для получения списка файлов из запроса на вытягивание репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер вытягивания
 pullNumber True integer

Номер вытягивания.

Возвращаемое значение

response
array of PullRequestFile

Получение ссылки (предварительная версия)

Идентификатор операции:
GetReference

Возвращает одну ссылку из базы данных Git. Параметр reference должен быть отформатирован как heads/<branch name> для ветвей и tags/<tag name> тегов. reference Если значение не соответствует существующему ссылок, 404 возвращается значение.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Reference
 reference True string

Ссылка в URL-адресе должна быть отформатирована как имя> головы или< ветви для ветвей и тегов или< тегов> для тегов.

Возвращаемое значение

Ссылки на Git в репозитории

Тело
GitReference

Проверка того, является ли пользователь сотрудником репозитория

Идентификатор операции:
checkCollaborator

Проверьте, является ли пользователь сотрудником репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
имя пользователя
 userName True string

Дескриптор учетной записи пользователя GitHub.

Возвращаемое значение

Модель получения одного ответа API

response
object

Слияние запроса на вытягивание (предварительная версия)

Идентификатор операции:
MergePullRequest

Эта операция используется для объединения запроса на вытягивание для репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер вытягивания
 pullNumber True integer

Номер вытягивания.
Заголовок фиксации
 commitTitle string

Заголовок сообщения автоматической фиксации.
Фиксация сообщения
 commitMessage string

Дополнительные сведения для добавления к сообщению автоматической фиксации.
Ша
 sha string

Sha, что головка запроса на вытягивание должна соответствовать, чтобы разрешить слияние.
Метод слияния
 mergeMethod string

Метод слияния для использования. Возможные значения: mergesquash или rebase. По умолчанию — merge.

Возвращаемое значение

Результат слияния запроса на вытягивание.

Тело
PullRequestMergeResult

Создание запроса на вытягивание (предварительная версия)

Идентификатор операции:
CreatePullRequest

Эта операция заключается в создании запроса на вытягивание в репозитории. Чтобы открыть или обновить запрос на вытягивание в общедоступном репозитории, необходимо иметь доступ на запись к головной или исходной ветви. Для репозиториев, принадлежащих организации, необходимо быть членом организации, владеющей репозиторием, чтобы создать запрос на вытягивание.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Название
 title string

Заголовок нового запроса на вытягивание.
Head
 head True string

Имя ветви, в которой реализованы изменения. Для запросов на вытягивание между репозиториями в той же сети пространство head имен с пользователем, как показано ниже username:branch.
Base
 base True string

Имя ветви, в которую нужно выполнить изменения. Это должна быть существующая ветвь в текущем репозитории. Вы не можете отправить запрос на вытягивание в один репозиторий, который запрашивает слияние в базу другого репозитория.
Тело
 body string

Содержимое запроса на вытягивание.
Может ли поддерживать изменение?
 maintainer_can_modify boolean

Указывает, могут ли поддерживающие изменять запрос на вытягивание.
Черновик
 draft boolean

Указывает, является ли запрос на вытягивание черновиком.

Возвращаемое значение

Запросы на вытягивание позволяют другим пользователям сообщать о изменениях, которые вы добавили в репозиторий на сайте GitHub. После отправки запроса на вытягивание заинтересованные стороны могут просмотреть набор изменений, обсудить возможные изменения и даже отправить фиксации последующих действий при необходимости.

Тело
PullRequest

Создание или обновление секрета репозитория (предварительная версия)

Идентификатор операции:
CreateUpdateRepositorySecret

Создает или обновляет секрет репозитория с зашифрованным значением. Зашифруйте секрет с помощью LibSodium.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Имя секрета
 secretName True string

Имя секрета.
encrypted_value
 encrypted_value string

Значение секрета, зашифрованное с помощью LibSodium с помощью открытого ключа, полученного из действия "Получить открытый ключ репозитория".
key_id
 key_id string

Идентификатор ключа, используемого для шифрования секрета.

Создание проблемы

Идентификатор операции:
CreateIssue

Эта операция используется для создания новой проблемы для определенного репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Название
 title True string

Сводка проблемы.
Тело
 body string

Описание проблемы.

Возвращаемое значение

Свойства проблемы с GitHub.

Тело
IssueDetailsModel

Создание репозитория с помощью шаблона (предварительная версия)

Идентификатор операции:
CreateRepositoryUsingTemplate

Создает новый репозиторий с помощью шаблона репозитория. Прошедший проверку подлинности пользователь должен принадлежать или быть членом организации, которая владеет репозиторием.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец шаблона
 templateOwner True string

Имя владельца репозитория шаблонов.
Репозиторий шаблонов
 templateRepository True string

Имя репозитория шаблонов.
Владелец
 owner string

Организация или пользователь, которому будет принадлежать новый репозиторий. Если оставить пустым, прошедший проверку подлинности пользователь будет владельцем.
Имя
 name True string

Имя нового репозитория.
Description
 description string

Краткое описание нового репозитория.
Является ли частный?
 private boolean

true Создание частного репозитория или false создание общедоступного репозитория.

Возвращаемое значение

Репозиторий Git

Тело
RepositoryDetails

Создание события отправки репозитория (предварительная версия)

Идентификатор операции:
CreateRepositoryDispatchEvent

Эта операция заключается в активации события веб-перехватчика, вызываемого repository_dispatch при желании действия, которое происходит за пределами GitHub, чтобы активировать рабочий процесс GitHub Actions или веб-перехватчик приложения GitHub. При возникновении repository_dispatch события необходимо настроить рабочий процесс GitHub Actions или приложение GitHub.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Имя события
 event_type string

Пользовательское имя события веб-перехватчика.
Полезные данные события
 client_payload object

Полезные данные JSON с дополнительными сведениями о событии веб-перехватчика, которое может использовать ваше действие или рабочий файл.

Создание ссылки (предварительная версия)

Идентификатор операции:
CreateReference

Создает ссылку для репозитория. Невозможно создать новые ссылки для пустых репозиториев, даже если используется хэш SHA-1 фиксации. Пустые репозитории — это репозитории без ветвей.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Reference
 ref True string

Имя полной ссылки (т. е refs/heads/master. ). Если он не начинается с "ссылок" и имеет по крайней мере две косые черты, он будет отклонен.
Ша
 sha True string

Значение SHA1 для этой ссылки.

Возвращаемое значение

Ссылки на Git в репозитории

Тело
GitReference

Список всех меток для проблемы

Идентификатор операции:
GetIssueLabels

Перечисляет все метки для проблемы.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер проблемы
 issueNumber True integer

Номер проблемы для данной проблемы.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Отображаемый номер страницы.

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Список всех меток для репозитория

Идентификатор операции:
GetLabels

Перечисляет все метки для репозитория.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Отображаемый номер страницы.

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Список всех общедоступных репозиториев для организации

Идентификатор операции:
GetOrgRepos

Выводит список всех общедоступных репозиториев для организации.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
type
 type string

Ограничить результаты репозиториями указанного типа.
sort
 sort string

Свойство для сортировки результатов по.
направление
 direction string

Направление сортировки.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Номер страницы для получения

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Список всех общедоступных репозиториев для пользователя

Идентификатор операции:
GetRepos

Выводит список всех общедоступных репозиториев для пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
type
 type string

Ограничить результаты репозиториями указанного типа.
sort
 sort string

Свойство для сортировки результатов по.
направление
 direction string

Направление сортировки.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Номер страницы для получения

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Список всех репозиториев для прошедшего проверку подлинности пользователя

Идентификатор операции:
GetUserRepos

Выводит список всех репозиториев (как общедоступных, так и частных) для прошедшего проверку подлинности пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
видимость
 visibility string

Ограничить результаты репозиториями указанной видимости (public/private/all).
принадлежность
 affiliation string

Ограничить результаты на основе принадлежности.
с
 since string

Ограничить результаты репозиториями, обновленными после заданного времени.
before
 before string

Ограничить результаты репозиториями, обновленными до заданного времени.
type
 type string

Ограничить результаты репозиториями указанного типа.
sort
 sort string

Свойство для сортировки результатов по.
направление
 direction string

Направление сортировки.
per_page
 per_page integer

Количество результатов на страницу.
page
 page integer

Номер страницы для получения

Возвращаемое значение

Модель получения ответа API списка

Товары
MultipleFetchModel

Сравнение двух фиксаций (предварительная версия)

Идентификатор операции:
CompareRepositoryCommits

Оба base и head должны быть именами ветвей в repositoryName. Чтобы сравнить ветви между другими репозиториями в той же сети, что repositoryNameи формат <USERNAME>:branch. Ответ эквивалентен выполнению git log base..head команды. Однако фиксации возвращаются в хронологическом порядке.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Base
 base True string

базовый параметр
Head
 head True string

главный параметр

Возвращаемое значение

Сравнение фиксаций

Тело
CommitComparison

Удаление выбранного репозитория из секрета организации (предварительная версия)

Идентификатор операции:
RemoveSelectedRepoFromOrgSecret

Удаляет репозиторий из секрета организации, если visibility для доступа к репозиторию задано значение selected. Видимость устанавливается при создании или обновлении секрета организации. Для использования этой конечной точки необходимо пройти проверку подлинности с помощью маркера доступа с admin:org областью действия. Приложения GitHub должны иметь secrets разрешение организации на использование этой конечной точки.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Идентификатор репозитория
 repositoryId True integer

Уникальный идентификатор репозитория.
Имя секрета
 secretName True string

Имя секрета.

Удаление запрошенных рецензентов из запроса на вытягивание (предварительная версия)

Идентификатор операции:
RemoveReviewersPullRequest

Удалите запрошенных рецензентов из запроса на вытягивание из заданного набора пользователей и (или) команд.

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Номер вытягивания
 pullNumber True integer

Номер вытягивания.
Авторам
 reviewers array of string
team_reviewers
 team_reviewers array of string

Удаляет веб-перехватчик GitHub (предварительная версия)

Идентификатор операции:
DeleteWebhookTrigger

Удаляет веб-перехватчик GitHub

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
Идентификатор веб-перехватчика GitHub
 webhookId True string

Идентификатор веб-перехватчика GitHub

Триггеры

Когда мне назначена проблема

Эта операция активируется при назначении проблемы пользователю, вошедшего в систему.
Когда откроется и назначена мне новая проблема

Эта операция активируется при открытии и назначении проблемы пользователю, вошедшему в систему.
Когда проблема, назначенная мне, закрыта

Эта операция активируется при закрытии проблемы, назначенной пользователю вошедшего в систему.
При создании или изменении запроса на вытягивание (предварительная версия)

Создает веб-перехватчик GitHub для запросов на вытягивание

Когда мне назначена проблема

Идентификатор операции:
IssueAssigned

Эта операция активируется при назначении проблемы пользователю, вошедшего в систему.

Возвращаемое значение

Свойства проблемы с GitHub.

Тело
IssueDetailsModel

Когда откроется и назначена мне новая проблема

Идентификатор операции:
IssueOpened

Эта операция активируется при открытии и назначении проблемы пользователю, вошедшему в систему.

Возвращаемое значение

Свойства проблемы с GitHub.

Тело
IssueDetailsModel

Когда проблема, назначенная мне, закрыта

Идентификатор операции:
IssueClosed

Эта операция активируется при закрытии проблемы, назначенной пользователю вошедшего в систему.

Возвращаемое значение

Свойства проблемы с GitHub.

Тело
IssueDetailsModel

При создании или изменении запроса на вытягивание (предварительная версия)

Идентификатор операции:
WebhookPullRequestTrigger

Создает веб-перехватчик GitHub для запросов на вытягивание

Параметры

Имя Ключ Обязательно Тип Описание
Владелец репозитория
 repositoryOwner True string

Имя владельца репозитория.
Имя репозитория
 repositoryName True string

Имя репозитория.
События веб-перехватчика для прослушивания
 events True array of string

События веб-перехватчика для прослушивания

Возвращаемое значение

Ответ запроса на вытягивание веб-перехватчика.

Тело
WebhookPullRequestResponse

Определения

IssueDetailsModel

Свойства проблемы с GitHub.

Имя Путь Тип Описание
Название
 title string

Сводка проблемы.
Тело
 body string

Описание проблемы.
assignee
 assignee UserDetailsModel

Свойства пользователя GitHub.
Идентификатор
 number integer

Уникальный идентификатор проблемы.
Государство
 state string

Состояние проблемы.
Создан Date-Time
 created_at string

гггг-ММ-ddTHH:mm:ss.fffZ (формат UTC).
URL-адрес репозитория
 repository_url string

Веб-ссылка на репозиторий.

MultipleSearchFetchModel

Модель получения результатов поиска

Имя Путь Тип Описание
body
 body array of GeneralAPIModel

текст результата

MultipleFetchModel

Модель получения ответа API списка

Имя Путь Тип Описание
Товары
 GeneralAPIModel

Модель получения одного ответа API

GeneralAPIModel

Модель получения одного ответа API

UserDetailsModel

Свойства пользователя GitHub.

Имя Путь Тип Описание
Вход
 login string

Имя входа пользователя.
Идентификатор
 id integer

Идентификатор пользователя.
Идентификатор узла
 node_id string

Идентификатор узла пользователя.
URL-адрес аватара
 avatar_url string

URL-адрес аватара пользователя.
Идентификатор Gravatar
 gravatar_id string

Идентификатор Пользователя Gravatar.
URL-адрес
 url string

URL-адрес пользователя.
HTML-URL-адрес
 html_url string

Url-адрес html пользователя.
URL-адрес подписчиков
 followers_url string

User FollowersUrl
Следующий URL-адрес
 following_url string

Url-адрес для пользователя, следующего за пользователем.
URL-адрес Gists
 gists_url string

URL-адрес Gists пользователя.
Url-адрес с звездой
 starred_url string

Url-адрес для роли пользователя.
URL-адрес подписок
 subscriptions_url string

URL-адрес подписок пользователей.
URL-адрес организации
 organizations_url string

URL-адрес организации пользователей.
URL-адрес репозитория
 repos_url string

URL-адрес репозитория пользователя.
URL-адрес событий
 events_url string

URL-адрес событий пользователя.
Url-адрес полученных событий
 received_events_url string

URL-адрес полученных событий пользователем.
Тип
 type string

Тип пользователя.
Администратор сайта
 site_admin boolean

Администратор сайта пользователя?
Имя
 name string

Имя пользователя.
Компания
 company string

Пользовательская компания.
Блог
 blog string

Блог пользователя.
Местоположение
 location string

Расположение пользователя.
Адрес электронной почты
 email string

Электронная почта пользователя.
Нанимаемый
 hireable boolean

Пользователь, нанимаемый?
Биография
 bio string

ПользовательСкая биография.
Общедоступные репозитории
 public_repos integer

Общедоступный репозиторий пользователей.
Public Gists
 public_gists integer

Общедоступные Gists пользователей.
Подписчики
 followers integer

Подписчики пользователей.
Подписки
 following integer

Пользователь ниже.
Создано в
 created_at date-time

Пользователь создан по адресу.
Обновлено в
 updated_at date-time

Пользователь обновлен по адресу.

Проверка

Имя Путь Тип Описание
Проверено
 verified boolean

Указывает, считает ли GitHub подпись в этой фиксации проверенной.
Причина проверки
 reason string

Причина проверяемого значения.
Подписанное значение
 payload string

Значение, подписанное.
Подпись фиксации
 signature string

Подпись, извлеченная из фиксации.

GitUser

Метаданные для сведений автора и фиксации Git.

Имя Путь Тип Описание
Имя пользователя Git
 name string

Имя пользователя
Электронная почта пользователя Git
 email string

Адрес электронной почты
Метка времени фиксации
 date string

Метка времени фиксации.

DiffEntry

Запись диффа

Имя Путь Тип Описание
Имя файла
 filename string

Изменено имя файла.
Дополнения
 additions integer

Количество добавлений в файле
Удаление
 deletions integer

Количество удалений в файле
Changes
 changes integer

Количество изменений в файле
Состояние
 status string

Состояние изменения изменено, переименовано и т. д.,
Необработанный URL-адрес
 raw_url string

Ссылка на необработанный URL-адрес к файлу
URL-адрес большого двоичного объекта
 blob_url string

Ссылка URL-адреса БОЛЬШОго двоичного объекта на файл
Patch
 patch string

Фактические изменения, внесенные в файл.
Sha изменения
 sha string

SHA изменения.
URL-адрес содержимого
 contents_url string

URL-адрес содержимого файла.
Предыдущее имя файла
 previous_filename string

Предыдущее имя файла, если имя файла изменено

Зафиксировать

Зафиксировать

Имя Путь Тип Описание
URL-адрес фиксации
 url string

URL-адрес HTTP для фиксации.
Фиксация sha
 sha string

SHA фиксации
Идентификатор узла
 node_id string

Идентификатор узла фиксации.
HTML-URL-адрес
 html_url string

HTML-URL-адрес фиксации
URL-адрес комментариев
 comments_url string

URL-адрес примечаний фиксации
URL-адрес фиксации
 commit.url string

URL-адрес фиксации.
автор
 commit.author GitUser

Метаданные для сведений автора и фиксации Git.
Коммиттер
 commit.committer GitUser

Метаданные для сведений автора и фиксации Git.
Сообщение о фиксации
 commit.message string

Зафиксировать сообщение.
Число комментариев
 commit.comment_count integer

Количество комментариев фиксации
Фиксация sha
 commit.tree.sha string

SHA фиксации
URL-адрес фиксации
 commit.tree.url uri

Url-адрес фиксации.
проверка
 commit.verification Verification
автор
 author UserDetailsModel

Свойства пользователя GitHub.
Коммиттер
 committer UserDetailsModel

Свойства пользователя GitHub.
родители
 parents array of object
Родительская sha
 parents.sha string

Sha фиксации родительской ветви
URL-адрес родительской ветви
 parents.url string

URL-адрес родительской ветви.
HTML-адрес родительской ветви
 parents.html_url string

HTML-url-адрес родительской ветви.
Дополнения
 stats.additions integer

Количество добавлений
Удаление
 stats.deletions integer

Количество удалений
Total
 stats.total integer

Общее количество изменений
files
 files array of DiffEntry

CommitComparison

Сравнение фиксаций

Имя Путь Тип Описание
URL-адрес
 url string

URL-адрес для сравнения
HTML-URL-адрес
 html_url string

HTML-URL-адрес для сравнения
Постоянный URL-адрес
 permalink_url string

Постоянный URL-адрес для сравнения
Url-адрес Diff
 diff_url string

Url-адрес Diff
URL-адрес исправления
 patch_url string

URL-адрес исправления
base_commit
 base_commit Commit

Зафиксировать
merge_base_commit
 merge_base_commit Commit

Зафиксировать
Состояние
 status string

Состояние сравнения, например. расхождение и т. д.,
Впереди
 ahead_by integer

вперед по базовой ветви
Позади
 behind_by integer

базовая ветвь behind_by
Общее количество фиксаций
 total_commits integer

общее количество фиксаций
Фиксации
 commits array of Commit

Совершает
Files
 files array of DiffEntry

files

ActionsPublicKey

Открытый ключ, используемый для задания секретов действий.

Имя Путь Тип Описание
Идентификатор ключа
 key_id string

Идентификатор ключа.
Key
 key string

Открытый ключ в кодировке Base64.
Идентификатор
 id integer

Уникальный идентификатор ключа.
URL-адрес
 url string

URL-адрес открытого ключа.
Название
 title string

Заголовок открытого ключа.
Создано в
 created_at string

Дата и время создания ключа.

LicenseDetails

Сведения о лицензии

Имя Путь Тип Описание
Key
 key string

Нижний регистр идентификатора SPDX лицензии.
Имя
 name string

Полное имя лицензии, указанное в параметре https://spdx.org/licenses.
URL-адрес
 url uri

URL-адрес лицензии https://choosealicense.com.
Идентификатор SPDX
 spdx_id string

Короткий идентификатор, заданный https://spdx.org/licenses.
Идентификатор узла
 node_id string

Идентификатор узла лицензии.
HTML-URL-адрес
 html_url uri

URL-адрес HTML лицензии.

РепозиторийMiniDetails

Репозиторий Git

Имя Путь Тип Описание
Идентификатор репозитория
 id integer

Уникальный идентификатор репозитория.
Идентификатор узла репозитория
 node_id string

Идентификатор узла репозитория.
Имя репозитория
 name string

Имя репозитория.
Полное имя репозитория
 full_name string

Полное имя репозитория.
Администратора
 permissions.admin boolean
pull
 permissions.pull boolean
сортировка
 permissions.triage boolean
толкать
 permissions.push boolean
поддерживать
 permissions.maintain boolean
owner
 owner UserDetailsModel

Свойства пользователя GitHub.
Является ли репозиторий частным?
 private boolean

Является ли репозиторий частным или общедоступным.
Описание репозитория
 description string

Описание репозитория
Домашняя страница репозитория
 homepage uri

Домашняя страница для этого репозитория
Язык репозитория
 language string

Язык для этого репозитория
Архивирован ли репозиторий?
 archived boolean

Архивируется ли репозиторий.
Отключен ли репозиторий?
 disabled boolean

Возвращает значение, отключается ли этот репозиторий.
Видимость репозитория
 visibility string

Видимость репозитория: общедоступная, частная или внутренняя.
Репозиторий создан в
 created_at date-time

дата и время создания репозитория.
Обновленный репозиторий
 updated_at date-time

дата и время последнего обновления репозитория.
Разрешить слияние повторной базы репозитория
 allow_rebase_merge boolean

Разрешить ли повторное слияние для запросов на вытягивание.
Разрешить слияние Squash в репозитории
 allow_squash_merge boolean

Разрешение слияний скваша для запросов на вытягивание.
Удаление ветви репозитория при слиянии
 delete_branch_on_merge boolean

Удаление ветвей головы при слиянии запросов на вытягивание
Разрешить фиксацию слияния репозитория
 allow_merge_commit boolean

Разрешение фиксаций слиянием для запросов на вытягивание.
Главная ветвь репозитория
 master_branch string

Главная ветвь репозитория.

РепозиторийDetails

Репозиторий Git

Имя Путь Тип Описание
Идентификатор
 id integer

Уникальный идентификатор репозитория.
Идентификатор узла
 node_id string

Идентификатор узла репозитория.
Имя
 name string

Имя репозитория.
Полное имя
 full_name string

Полное имя репозитория.
Лицензия
 license LicenseDetails

Сведения о лицензии
Вилки
 forks integer

Количество вилок репозитория.
Администратора
 permissions.admin boolean
pull
 permissions.pull boolean
сортировка
 permissions.triage boolean
толкать
 permissions.push boolean
поддерживать
 permissions.maintain boolean
owner
 owner UserDetailsModel

Свойства пользователя GitHub.
Является ли частный?
 private boolean

Является ли репозиторий частным или общедоступным.
HTML-URL-адрес
 html_url uri

HTML-url репозитория
Description
 description string

Описание репозитория
Есть ли вилка?
 fork boolean

Если репозиторий является вилкой?
URL-адрес
 url uri

URL-адрес HTTP для этого репозитория
URL-адрес архива
 archive_url string

URL-адрес архива для этого репозитория
Url-адрес назначения
 assignees_url string

URL-адрес назначения для этого репозитория
URL-адрес больших двоичных объектов
 blobs_url string

URL-адрес больших двоичных объектов для этого репозитория
Url-адрес ветвей
 branches_url string

URL-адрес ветви для этого репозитория
URL-адрес участников совместной работы
 collaborators_url string

URL-адрес участников совместной работы для этого репозитория
URL-адрес комментариев
 comments_url string

URL-адрес комментариев для этого репозитория
Url-адрес фиксации
 commits_url string

URL-адрес фиксации для этого репозитория
Сравнение URL-адреса
 compare_url string

URL-адрес сравнения для этого репозитория
URL-адрес содержимого
 contents_url string

URL-адрес содержимого для этого репозитория
URL-адрес участников
 contributors_url uri

URL-адрес участника для этого репозитория
URL-адрес развертывания
 deployments_url uri

URL-адрес развертывания для этого репозитория
URL-адрес загрузки
 downloads_url uri

URL-адрес загрузки для этого репозитория
URL-адрес событий
 events_url uri

URL-адрес событий для этого репозитория
URL-адрес вилки
 forks_url uri

URL-адрес вилки для этого репозитория
URL-адрес фиксации Git
 git_commits_url string

URL-адрес фиксации Git для этого репозитория
URL-адрес ссылок на Git
 git_refs_url string

URL-адрес ссылок Git для этого репозитория
URL-адрес тегов Git
 git_tags_url string

URL-адрес тегов Git для этого репозитория
URL-адрес Git
 git_url string

URL-адрес Git для этого репозитория
Url-адрес комментария проблемы
 issue_comment_url string

URL-адрес комментария проблемы для этого репозитория
Url-адрес событий проблемы
 issue_events_url string

URL-адрес событий проблемы для этого репозитория
URL-адрес проблем
 issues_url string

URL-адрес проблем для этого репозитория
URL-адрес ключей
 keys_url string

URL-адрес ключей для этого репозитория
URL-адрес меток
 labels_url string

URL-адрес меток для этого репозитория
URL-адрес языков
 languages_url uri

URL-адрес языков для этого репозитория
URL-адрес слияния
 merges_url uri

URL-адрес слияния для этого репозитория
URL-адрес вех
 milestones_url string

URL-адрес вех для этого репозитория
URL-адрес уведомлений
 notifications_url string

URL-адрес уведомлений для этого репозитория
Url-адрес извлечения
 pulls_url string

URL-адрес извлечения для этого репозитория
URL-адрес выпуска
 releases_url string

URL-адрес выпуска для этого репозитория
URL-адрес SSH
 ssh_url string

URL-адрес SSH для клонирования этого репозитория
URL-адрес stargazers
 stargazers_url uri

Звездолазы (Stargazers — это люди, которые закладыли репозиторий GitHub) URL-адрес этого репозитория.
URL-адрес состояния
 statuses_url string

URL-адрес состояния для этого репозитория
URL-адрес подписчиков
 subscribers_url uri

URL-адрес подписчиков для этого репозитория
URL-адрес подписки
 subscription_url uri

URL-адрес подписки для этого репозитория
URL-адрес тегов
 tags_url uri

URL-адрес тегов для этого репозитория
URL-адрес Teams
 teams_url uri

URL-адрес teams для этого репозитория
URL-адрес деревьев
 trees_url string

URL-адрес деревьев для этого репозитория
Клонированный URL-адрес
 clone_url string

URL-адрес клона для этого репозитория
Url-адрес зеркального отображения
 mirror_url uri

Исходный URL-адрес зеркального отображения для этого репозитория
URL-адрес перехватчиков
 hooks_url uri

URL-адрес перехватчиков для этого репозитория
URL-адрес SVN
 svn_url uri

URL-адрес SVN для этого репозитория
Главная страница
 homepage uri

Домашняя страница для этого репозитория
Language
 language string

Язык для этого репозитория
Число вилок
 forks_count integer

Количество вилок имеется в этой сети.
Stargazers Count
 stargazers_count integer

Количество пользователей, которые снялись в репозитории.
Счетчик наблюдателей
 watchers_count integer

Количество пользователей, просматривающих репозиторий.
Size
 size integer

Размер репозитория
Ветвь по умолчанию
 default_branch string

Ветвь по умолчанию репозитория.
Количество открытых проблем
 open_issues_count integer

Количество открытых проблем в репозитории.
Шаблон?
 is_template boolean

Является ли этот репозиторий шаблоном, который можно использовать для создания новых репозиториев.
Темы
 topics array of string

Список разделов в репозитории
Есть проблемы?
 has_issues boolean

Включены ли проблемы.
Есть ли проекты?
 has_projects boolean

Включены ли проекты.
Есть вики-сайт?
 has_wiki boolean

Включена ли вики-страница.
Есть ли страницы?
 has_pages boolean

Включены ли страницы.
Есть ли скачивание?
 has_downloads boolean

Включена ли загрузка.
Архивировано?
 archived boolean

Архивируется ли репозиторий.
Отключено?
 disabled boolean

Возвращает значение, отключается ли этот репозиторий.
Видимость
 visibility string

Видимость репозитория: общедоступная, частная или внутренняя.
Pushed At
 pushed_at date-time

После последнего отправки репозитория.
Создано в
 created_at date-time

дата и время создания репозитория.
Обновлено в
 updated_at date-time

дата и время последнего обновления репозитория.
Разрешить слияние повторной базы данных
 allow_rebase_merge boolean

Разрешить ли повторное слияние для запросов на вытягивание.
Идентификатор репозитория шаблонов
 template_repository.id integer

Уникальный идентификатор репозитория.
Идентификатор узла репозитория шаблонов
 template_repository.node_id string

Идентификатор узла репозитория.
Имя репозитория шаблонов
 template_repository.name string

Имя репозитория.
Полное имя репозитория шаблонов
 template_repository.full_name string

Полное имя репозитория.
owner
 template_repository.owner UserDetailsModel

Свойства пользователя GitHub.
Является ли репозиторий шаблонов частным?
 template_repository.private boolean

Является ли репозиторий частным или общедоступным.
HTML-адрес репозитория шаблонов
 template_repository.html_url uri

HTML-url репозитория
Описание репозитория шаблонов
 template_repository.description string

Описание репозитория
Является ли репозиторий шаблоном вилкой?
 template_repository.fork boolean

Если репозиторий является вилкой?
URL-адрес репозитория шаблонов
 template_repository.url uri

URL-адрес HTTP для этого репозитория
URL-адрес архива репозитория шаблонов
 template_repository.archive_url string

URL-адрес архива для этого репозитория
Url-адрес назначения репозитория шаблонов
 template_repository.assignees_url string

URL-адрес назначения для этого репозитория
URL-адрес больших двоичных объектов репозитория шаблонов
 template_repository.blobs_url string

URL-адрес больших двоичных объектов для этого репозитория
Url-адрес филиалов репозитория шаблонов
 template_repository.branches_url string

URL-адрес ветви для этого репозитория
URL-адрес участников совместной работы репозитория шаблонов
 template_repository.collaborators_url string

URL-адрес участников совместной работы для этого репозитория
Url-адрес примечаний репозитория шаблонов
 template_repository.comments_url string

URL-адрес комментариев для этого репозитория
URL-адрес фиксации репозитория шаблонов
 template_repository.commits_url string

URL-адрес фиксации для этого репозитория
Url-адрес сравнения репозитория шаблонов
 template_repository.compare_url string

URL-адрес сравнения для этого репозитория
URL-адрес содержимого репозитория шаблонов
 template_repository.contents_url string

URL-адрес содержимого для этого репозитория
URL-адрес участника репозитория шаблонов
 template_repository.contributors_url uri

URL-адрес участника для этого репозитория
URL-адрес развертывания репозитория шаблонов
 template_repository.deployments_url uri

URL-адрес развертывания для этого репозитория
URL-адрес скачивания репозитория шаблонов
 template_repository.downloads_url uri

URL-адрес загрузки для этого репозитория
URL-адрес событий репозитория шаблонов
 template_repository.events_url uri

URL-адрес событий для этого репозитория
URL-адрес репозитория шаблонов
 template_repository.forks_url uri

URL-адрес вилки для этого репозитория
URL-адрес фиксации репозитория шаблонов Git
 template_repository.git_commits_url string

URL-адрес фиксации Git для этого репозитория
Url-адрес ссылок репозитория шаблонов Git
 template_repository.git_refs_url string

URL-адрес ссылок Git для этого репозитория
URL-адрес тегов репозитория шаблонов Git
 template_repository.git_tags_url string

URL-адрес тегов Git для этого репозитория
URL-адрес репозитория шаблонов Git
 template_repository.git_url string

URL-адрес Git для этого репозитория
Url-адрес примечания репозитория шаблонов
 template_repository.issue_comment_url string

URL-адрес комментария проблемы для этого репозитория
Url-адрес событий проблемы репозитория шаблонов
 template_repository.issue_events_url string

URL-адрес событий проблемы для этого репозитория
Url-адрес проблем с репозиторием шаблонов
 template_repository.issues_url string

URL-адрес проблем для этого репозитория
URL-адрес ключей репозитория шаблонов
 template_repository.keys_url string

URL-адрес ключей для этого репозитория
URL-адрес меток репозитория шаблонов
 template_repository.labels_url string

URL-адрес меток для этого репозитория
URL-адрес языков репозитория шаблонов
 template_repository.languages_url uri

URL-адрес языков для этого репозитория
URL-адрес слияния репозитория шаблонов
 template_repository.merges_url uri

URL-адрес слияния для этого репозитория
Url-адрес вех репозитория шаблонов
 template_repository.milestones_url string

URL-адрес вех для этого репозитория
URL-адрес уведомлений репозитория шаблонов
 template_repository.notifications_url string

URL-адрес уведомлений для этого репозитория
Url-адрес извлечения репозитория шаблонов
 template_repository.pulls_url string

URL-адрес извлечения для этого репозитория
URL-адрес выпуска репозитория шаблонов
 template_repository.releases_url string

URL-адрес выпуска для этого репозитория
URL-адрес SSH репозитория шаблонов
 template_repository.ssh_url string

URL-адрес SSH для клонирования этого репозитория
URL-адрес stargazers репозитория шаблонов
 template_repository.stargazers_url uri

Звездолазы (Stargazers — это люди, которые закладыли репозиторий GitHub) URL-адрес этого репозитория.
URL-адрес состояния репозитория шаблонов
 template_repository.statuses_url string

URL-адрес состояния для этого репозитория
URL-адрес подписчиков репозитория шаблонов
 template_repository.subscribers_url uri

URL-адрес подписчиков для этого репозитория
URL-адрес подписки репозитория шаблонов
 template_repository.subscription_url uri

URL-адрес подписки для этого репозитория
URL-адрес тегов репозитория шаблонов
 template_repository.tags_url uri

URL-адрес тегов для этого репозитория
URL-адрес репозитория шаблонов Teams
 template_repository.teams_url uri

URL-адрес teams для этого репозитория
URL-адрес деревьев репозитория шаблонов
 template_repository.trees_url string

URL-адрес деревьев для этого репозитория
Url-адрес клонирования репозитория шаблонов
 template_repository.clone_url string

URL-адрес клона для этого репозитория
Url-адрес зеркального отображения репозитория шаблонов
 template_repository.mirror_url uri

Исходный URL-адрес зеркального отображения для этого репозитория
URL-адрес перехватчиков репозитория шаблонов
 template_repository.hooks_url uri

URL-адрес перехватчиков для этого репозитория
URL-адрес SVN репозитория шаблонов
 template_repository.svn_url uri

URL-адрес SVN для этого репозитория
Домашняя страница репозитория шаблонов
 template_repository.homepage uri

Домашняя страница для этого репозитория
Язык репозитория шаблонов
 template_repository.language string

Язык для этого репозитория
Число вилок репозитория шаблонов
 template_repository.forks_count integer

Количество вилок имеется в этой сети.
Число звездочек репозитория шаблонов
 template_repository.stargazers_count integer

Количество пользователей, которые снялись в репозитории.
Число наблюдателей репозитория шаблонов
 template_repository.watchers_count integer

Количество пользователей, просматривающих репозиторий.
Размер репозитория шаблонов
 template_repository.size integer

Размер репозитория
Ветвь репозитория шаблонов по умолчанию
 template_repository.default_branch string

Ветвь по умолчанию репозитория.
Число открытых проблем репозитория шаблонов
 template_repository.open_issues_count integer

Количество открытых проблем в репозитории.
Является ли репозиторий шаблоном?
 template_repository.is_template boolean

Является ли этот репозиторий шаблоном, который можно использовать для создания новых репозиториев.
Разделы репозитория шаблонов
 template_repository.topics array of string

Список разделов в репозитории
У репозитория шаблонов возникли проблемы?
 template_repository.has_issues boolean

Включены ли проблемы.
Репозиторий шаблонов имеет проекты?
 template_repository.has_projects boolean

Включены ли проекты.
Репозиторий шаблонов имеет вики-сайт?
 template_repository.has_wiki boolean

Включена ли вики-страница.
Репозиторий шаблонов содержит страницы?
 template_repository.has_pages boolean

Включены ли страницы.
У репозитория шаблонов есть скачивание?
 template_repository.has_downloads boolean

Включена ли загрузка.
Архивирован ли репозиторий шаблонов?
 template_repository.archived boolean

Архивируется ли репозиторий.
Отключен ли репозиторий шаблонов?
 template_repository.disabled boolean

Возвращает значение, отключается ли этот репозиторий.
Видимость репозитория шаблонов
 template_repository.visibility string

Видимость репозитория: общедоступная, частная или внутренняя.
Репозиторий шаблонов отправлен в
 template_repository.pushed_at date-time

После последнего отправки репозитория.
Репозиторий шаблонов, созданный в
 template_repository.created_at date-time

дата и время создания репозитория.
Обновленный репозиторий шаблонов
 template_repository.updated_at date-time

дата и время последнего обновления репозитория.
Администратора
 template_repository.permissions.admin boolean
толкать
 template_repository.permissions.push boolean
pull
 template_repository.permissions.pull boolean
Репозиторий шаблонов разрешает слияние повторной базы данных
 template_repository.allow_rebase_merge boolean

Разрешить ли повторное слияние для запросов на вытягивание.
Репозиторий шаблонов репозитория шаблонов
 template_repository.template_repository string

Репозиторий шаблонов.
Маркер клона temp clone репозитория шаблонов
 template_repository.temp_clone_token string

Временный маркер проверки подлинности для клонирования этого репозитория.
Репозиторий шаблонов разрешает слияние Squash
 template_repository.allow_squash_merge boolean

Разрешение слияний скваша для запросов на вытягивание.
Репозиторий шаблонов удаляет ветвь при слиянии
 template_repository.delete_branch_on_merge boolean

Удаление ветвей головы при слиянии запросов на вытягивание
Репозиторий шаблонов разрешает фиксацию слияния
 template_repository.allow_merge_commit boolean

Разрешение фиксаций слиянием для запросов на вытягивание.
Число подписчиков репозитория шаблонов
 template_repository.subscribers_count integer

Количество подписчиков для репозитория.
Число сетей репозитория шаблонов
 template_repository.network_count integer

Число сетей репозитория
Клонированный маркер temp
 temp_clone_token string

Временный маркер проверки подлинности для клонирования этого репозитория.
Разрешить слияние Squash
 allow_squash_merge boolean

Разрешение слияний скваша для запросов на вытягивание.
Удаление ветви при слиянии
 delete_branch_on_merge boolean

Удаление ветвей головы при слиянии запросов на вытягивание
Разрешить фиксацию слияния
 allow_merge_commit boolean

Разрешение фиксаций слиянием для запросов на вытягивание.
Число подписчиков
 subscribers_count integer

Количество подписчиков для репозитория.
Число сетевых подключений
 network_count integer

Число сетей репозитория
Открытые проблемы
 open_issues integer

Открытые проблемы с репозиторием.
Watchers
 watchers integer

Наблюдатели за репозиториями.
Главная ветвь
 master_branch string

Главная ветвь репозитория.
В главной роли
 starred_at string

Репозиторий в главной роли

GitReference

Ссылки на Git в репозитории

Имя Путь Тип Описание
Reference
 ref string

Имя полной ссылки.
Идентификатор узла
 node_id string

Идентификатор узла ссылки.
URL-адрес
 url uri

URL-адрес ссылки.
type
 object.type string

Тип объекта .
Ша
 object.sha string

Sha для ссылки.
URL-адрес
 object.url uri

URL-адрес объекта.

PullRequestMergeResult

Результат слияния запроса на вытягивание.

Имя Путь Тип Описание
Ша
 sha string

SHA для фиксации слияния.
Объединены ли?
 merged boolean

Независимо от того, был ли объединен запрос на вытягивание.
Message
 message string

Сообщение об ответе слиянием.

Веха

Коллекция связанных проблем и запросов на вытягивание.

Имя Путь Тип Описание
Url-адрес вехи
 url uri

URL-адрес HTTP для вехи.
Html-адрес вехи
 html_url uri

URL-адрес HTML для вехи.
Url-адрес меток вехи
 labels_url uri

URL-адрес меток для вехи.
Идентификатор вехи
 id integer

Уникальный идентификатор для вехи.
Идентификатор узла вехи
 node_id string

Идентификатор узла для вехи.
Номер вехи
 number integer

Число вехи.
Состояние вехи
 state string

Состояние вехи.
Название вехи
 title string

Название вехи.
Описание вехи
 description string

Описание вехи.
создатель
 creator UserDetailsModel

Свойства пользователя GitHub.
Проблемы открытия вехи
 open_issues integer

Количество открытых проблем для репозитория.
Проблемы с закрытыми вехами
 closed_issues integer

Количество закрытых проблем для репозитория.
Веха, созданная в
 created_at date-time

Дата и время создания вехи.
Веха обновлена в
 updated_at date-time

Дата и время последнего обновления вехи.
Веха закрыта в
 closed_at date-time

Дата и время закрытия вехи.
Веха должна быть включена
 due_on date-time

Дата выполнения вехи.

Этикетка

Цветовые метки помогают классифицировать и фильтровать проблемы (как и метки в Gmail).

Имя Путь Тип Описание
Идентификатор
 id integer

Уникальный идентификатор метки.
Идентификатор узла
 node_id string

Идентификатор узла для метки.
URL-адрес
 url uri

URL-адрес метки
Имя
 name string

Имя метки.
Description
 description string

Краткое описание этой метки.
Цвет
 color string

6-символьный шестнадцатеричный код без ведущего #, определяющий цвет
Используется ли значение по умолчанию?
 default boolean

Независимо от того, является ли это меткой по умолчанию.

TeamDetails

Группы членов организации, предоставляющие разрешения на указанные репозитории.

Имя Путь Тип Описание
Идентификатор
 id integer

Уникальный идентификатор команды.
Идентификатор узла
 node_id string

Идентификатор узла для команды.
URL-адрес
 url uri

URL-адрес команды.
URL-адрес участников
 members_url string

URL-адрес HTTP для участников команды.
name string

Имя команды
Description
 description string

Описание команды
Разрешение
 permission string

Разрешение, которое команда будет иметь для своих репозиториев
Конфиденциальность
 privacy string

Уровень конфиденциальности этой команды должен иметь
HTML-URL-адрес
 html_url uri

HTML-URL-адрес команды.
URL-адрес репозиториев
 repositories_url uri

URL-адрес HTTP для репозиториев этой команды.
Slug
 slug string

Слизь, соответствующий команде.
LDAP DN
 ldap_dn string

Различающееся имя (DN), с которыми команда сопоставляется в среде LDAP

Запрос на вытягивание

Запросы на вытягивание позволяют другим пользователям сообщать о изменениях, которые вы добавили в репозиторий на сайте GitHub. После отправки запроса на вытягивание заинтересованные стороны могут просмотреть набор изменений, обсудить возможные изменения и даже отправить фиксации последующих действий при необходимости.

Имя Путь Тип Описание
URL-адрес запроса на вытягивание
 url uri

URL-адрес HTTP для этого запроса на вытягивание.
Идентификатор запроса на вытягивание
 id integer

Уникальный идентификатор запроса на вытягивание.
Идентификатор узла запроса на вытягивание
 node_id string

Идентификатор узла для запроса на вытягивание.
Url-адрес html запроса на вытягивание
 html_url uri

URL-адрес HTML для запроса на вытягивание.
Url-адрес Diff запроса на вытягивание
 diff_url uri

URL-адрес Diff для запроса на вытягивание.
Url-адрес исправления запроса на вытягивание
 patch_url uri

URL-адрес исправления для запроса на вытягивание.
Url-адрес проблемы запроса на вытягивание
 issue_url uri

URL-адрес проблемы для запроса на вытягивание.
URL-адрес фиксации запроса на вытягивание
 commits_url uri

URL-адрес фиксации для запроса на вытягивание.
Url-адрес примечаний для проверки запроса на вытягивание
 review_comments_url uri

URL-адрес примечаний для запроса на вытягивание.
Url-адрес примечания запроса на запрос на вытягивание
 review_comment_url string

URL-адрес комментария для запроса на вытягивание.
Url-адрес Diff запроса на вытягивание
 comments_url uri

URL-адрес Diff для запроса на вытягивание.
Url-адрес состояния запроса на вытягивание
 statuses_url uri

URL-адрес состояния запроса на вытягивание.
Номер запроса на вытягивание
 number integer

Номер уникальной идентификации запроса на вытягивание в своем репозитории.
Состояние запроса на вытягивание
 state string

Состояние этого запроса на вытягивание. open или closed.
Заблокирован ли запрос на вытягивание?
 locked boolean

Блокируется ли запрос на вытягивание.
Заголовок запроса на вытягивание
 title string

Заголовок запроса на вытягивание.
Пользователь
 user UserDetailsModel

Свойства пользователя GitHub.
Текст запроса на вытягивание
 body string

Тело как Markdown.
Метки запроса на вытягивание
 labels array of Label

Список меток, связанных с запросом на вытягивание.
milestone Milestone

Коллекция связанных проблем и запросов на вытягивание.
Причина активной блокировки запроса на вытягивание
 active_lock_reason string

Причина, по которой беседа была заблокирована.
Запрос на вытягивание, созданный по адресу
 created_at date-time

Дата и время создания запроса на вытягивание.
Запрос на вытягивание обновлен по адресу
 updated_at date-time

Дата и время последнего обновления запроса на вытягивание.
Запрос на вытягивание закрыт по адресу
 closed_at date-time

Дата и время закрытия запроса на вытягивание.
Запрос на вытягивание, объединенный по адресу
 merged_at date-time

Дата и время объединения запроса на вытягивание.
Зафиксировать фиксацию слияния по запросу на вытягивание
 merge_commit_sha string

Зафиксировать фиксацию слияния запроса на вытягивание.
assignee
 assignee UserDetailsModel

Свойства пользователя GitHub.
Назначение запросов на вытягивание
 assignees array of UserDetailsModel

Список назначаемых для запроса на вытягивание.
Запрос на вытягивание запрошенных рецензентов
 requested_reviewers array of UserDetailsModel

Список пользователей, назначенных этому запросу на вытягивание.
Запрос на вытягивание запрошенных команд
 requested_teams array of TeamDetails

Список запрошенных команд для этого запроса на вытягивание.
Метка головки запроса на вытягивание
 head.label string

Метка головки.
Справочник по голове запроса на вытягивание
 head.ref string

Справочник по голове
Репо
 head.repo RepositoryMiniDetails

Репозиторий Git
Шайка запроса на вытягивание
 head.sha string

Ша головы
Пользователь
 head.user UserDetailsModel

Свойства пользователя GitHub.
Базовая метка запроса на вытягивание
 base.label string

Метка головки.
Справочник по базовому запросу на вытягивание
 base.ref string

Справочник по голове
Репо
 base.repo RepositoryMiniDetails

Репозиторий Git
Базовый sha запроса на вытягивание
 base.sha string

Ша головы
Пользователь
 base.user UserDetailsModel

Свойства пользователя GitHub.
Связь requestAuthor по запросу на вытягивание
 author_association string

Связь автора с темой комментария.
Черновик запроса на вытягивание?
 draft boolean

Указывает, является ли запрос на вытягивание черновиком.
Объединены ли запросы на вытягивание?
 merged boolean

Независимо от того, был ли объединен запрос на вытягивание.
Можно ли объединить запрос на вытягивание?
 mergeable boolean

Можно ли объединить запрос на вытягивание в зависимости от наличия конфликтов слияния.
Можно ли повторно использовать запрос на вытягивание?
 rebaseable boolean

Можно ли повторно использовать запрос на вытягивание.
Состояние объединения запросов на вытягивание
 mergeable_state string

Состояние объединения запроса на вытягивание.
merged_by
 merged_by UserDetailsModel

Свойства пользователя GitHub.
Количество примечаний запроса на вытягивание
 comments integer

Количество комментариев в этом запросе на вытягивание.
Количество примечаний для проверки запроса на вытягивание
 review_comments integer

Количество комментариев проверки в этом запросе на вытягивание.
Может ли обслуживатель изменить запрос на вытягивание?
 maintainer_can_modify boolean

Указывает, могут ли поддерживающие изменять запрос на вытягивание.
Количество фиксаций запросов на вытягивание
 commits integer

Количество фиксаций в этом запросе на вытягивание.
Количество добавлений запросов на вытягивание
 additions integer

Количество добавлений в этом запросе на вытягивание.
Число удалений запросов на вытягивание
 deletions integer

Количество удалений в этом запросе на вытягивание.
Количество измененных файлов запроса на вытягивание
 changed_files integer

Количество измененных файлов в этом запросе на вытягивание.

PullRequestFile

Имя Путь Тип Описание
sha для файла
 sha string

Sha для файла.
Имя файла
 filename string

Имя файла.
Состояние изменения файла
 status string

Состояние изменения файла.
Количество добавлений, внесенных в файл
 additions integer

Количество добавлений, внесенных в файл.
Количество удалений, сделанных в файл
 deletions integer

Количество удалений, сделанных в файл.
Количество изменений, внесенных в файл
 changes integer

Количество изменений, внесенных в файл.
URL-адрес БОЛЬШОго двоичного объекта для файла
 blob_url string

URL-адрес большого двоичного объекта для файла.
Необработанный URL-адрес для файла
 raw_url string

Необработанный URL-адрес файла.
URL-адрес содержимого файла
 contents_url string

URL-адрес содержимого файла.
Исправление содержимого файла
 patch string

Содержимое исправления для файла.

WebhookPullRequestResponse

Ответ запроса на вытягивание веб-перехватчика.

Имя Путь Тип Описание
Действие выполнено
 action string

Действие, которое было выполнено.
Номер запроса на вытягивание
 number integer

Номер запроса на вытягивание.
pull_request
 pull_request PullRequest

Запросы на вытягивание позволяют другим пользователям сообщать о изменениях, которые вы добавили в репозиторий на сайте GitHub. После отправки запроса на вытягивание заинтересованные стороны могут просмотреть набор изменений, обсудить возможные изменения и даже отправить фиксации последующих действий при необходимости.

объект

Это тип object.