1. GET /repos/{owner}/{repo}/actions/workflows/{workflow}/dispatches — получить входные параметры для запуска потока
Beta
Описание
Возвращает список входных параметров, необходимых для ручного запуска указанного потока в репозитории.
Параметры URL:
| Параметр | Обязательный | Описание |
|---|---|---|
owner | Да | Имя владельца репозитория |
repo | Да | Название репозитория |
workflow | Да | Название потока |
Параметры запроса:
| Параметр | Обязательный | Описание |
|---|---|---|
branch | Нет | Имя ветки для запуска потока |
tag | Нет | Имя тега для запуска потока |
Тело запроса:
Данный метод не требует тела запроса.
Пример запроса:
curl -X GET "https://api.gitverse.ru/repos/dlborun/APInewTestRepo4.3/actions/workflows/main/dispatches?branch=master" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/vnd.gitverse.object+json;version=1"Ответ (200 OK):
Ответ содержит список входных параметров, необходимых для запуска потока.
{
"inputs": {
"logLevel": {
"description": "Log level for the workflow",
"default": "info",
"type": "choice",
"options": ["info", "warning", "error"]
},
"tags": {
"description": "Comma-separated list of tags",
"default": "",
"type": "string"
},
"environment": {
"description": "Environment for the workflow",
"default": "development",
"type": "choice",
"options": ["development", "staging", "production"]
}
}
}Формат ответа: application/vnd.gitverse.object+json;version=1
Коды ответов
| Код | Статус | Описание |
|---|---|---|
200 | Ok | Запрос выполнен успешно, параметры получены |
400 | Bad Request | Некорректные параметры запроса |
403 | Forbidden | Доступ запрещен |
404 | Not Found | Указанный поток или репозиторий не найдены |
406 | Not Acceptable | Тип контента не поддерживается |
500 | Internal Server Error | Внутренняя ошибка сервера |
Примечания:
- убедитесь, что ключ API указан корректно и обладает необходимыми правами для доступа к репозиторию;
- возвращаемый список параметров может варьироваться в зависимости от конфигурации потока.