Публичный APICI/CD1. GET /repos/{username}/{reponame}/actions/workflows/{workflow}/dispatches — получить входные параметры для запуска потока

16. GET /repos/{username}/{reponame}/actions/workflows/{workflow}/dispatches — получить входные параметры для запуска потока

Описание

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

Параметры URL:

ПараметрОбязательныйОписание
usernameДаИмя владельца репозитория
reponameДаНазвание репозитория
workflowДаНазвание потока

Параметры запроса:

ПараметрОбязательныйОписание
branchНетИмя ветки для запуска потока
tagНетИмя тега для запуска потока

Тело запроса:

Данный метод не требует тела запроса.

Пример запроса:

curl -X GET "https://api.gitverse.ru/repos/dlborun/APInewTestRepo4.3/actions/workflows/main/dispatches?branch=master" \
  -H "ApiKey: YOUR_API_KEY"

Ответ (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

Коды ответов

КодСтатусОписание
200OkЗапрос выполнен успешно, параметры получены
400Bad RequestНекорректные параметры запроса
403ForbiddenДоступ запрещен
404Not FoundУказанный поток или репозиторий не найдены
406Not AcceptableТип контента не поддерживается
500Internal Server ErrorВнутренняя ошибка сервера

Примечания:

  • Убедитесь, что ключ API указан корректно и обладает необходимыми правами для доступа к репозиторию.
  • Возвращаемый список параметров может варьироваться в зависимости от конфигурации потока.