Skip to content
Эта страница создана и переведена с помощью ИИ. Если вы заметили неточности, помогите нам улучшить её. Редактировать на GitHub

Справочник API-эндпоинтов

Эта страница предоставляет полный справочник по всем REST API-эндпоинтам OpenPR. Все эндпоинты требуют аутентификации, если не указано иное.

Аутентификация

МетодЭндпоинтОписаниеAuth
POST/api/auth/registerСоздать новый аккаунтНет
POST/api/auth/loginВойти и получить токеныНет
POST/api/auth/refreshОбновить токен доступаНет
GET/api/auth/meПолучить информацию о текущем пользователеДа

Рабочие пространства

МетодЭндпоинтОписание
GET/api/workspacesСписок рабочих пространств пользователя
POST/api/workspacesСоздать рабочее пространство
GET/api/workspaces/:idПолучить детали рабочего пространства
PUT/api/workspaces/:idОбновить рабочее пространство
DELETE/api/workspaces/:idУдалить рабочее пространство (только owner)

Участники рабочего пространства

МетодЭндпоинтОписание
GET/api/workspaces/:id/membersСписок участников
POST/api/workspaces/:id/membersДобавить участника
PUT/api/workspaces/:id/members/:user_idОбновить роль участника
DELETE/api/workspaces/:id/members/:user_idУдалить участника

Токены ботов

МетодЭндпоинтОписание
GET/api/workspaces/:id/botsСписок токенов ботов
POST/api/workspaces/:id/botsСоздать токен бота
DELETE/api/workspaces/:id/bots/:bot_idУдалить токен бота

Проекты

МетодЭндпоинтОписание
GET/api/workspaces/:ws_id/projectsСписок проектов
POST/api/workspaces/:ws_id/projectsСоздать проект
GET/api/workspaces/:ws_id/projects/:idПолучить проект с количеством задач
PUT/api/workspaces/:ws_id/projects/:idОбновить проект
DELETE/api/workspaces/:ws_id/projects/:idУдалить проект

Задачи (рабочие элементы)

МетодЭндпоинтОписание
GET/api/projects/:id/issuesСписок задач (пагинация, фильтры)
POST/api/projects/:id/issuesСоздать задачу
GET/api/issues/:idПолучить задачу по UUID
PATCH/api/issues/:idОбновить поля задачи
DELETE/api/issues/:idУдалить задачу

Поля задачи (создание/обновление)

json
{
  "title": "string (required on create)",
  "description": "string (markdown)",
  "state": "backlog | todo | in_progress | done",
  "priority": "low | medium | high | urgent",
  "assignee_id": "uuid",
  "sprint_id": "uuid",
  "due_at": "ISO 8601 datetime"
}

Доска

МетодЭндпоинтОписание
GET/api/projects/:id/boardПолучить состояние kanban-доски

Комментарии

МетодЭндпоинтОписание
GET/api/issues/:id/commentsСписок комментариев к задаче
POST/api/issues/:id/commentsСоздать комментарий
DELETE/api/comments/:idУдалить комментарий

Метки

МетодЭндпоинтОписание
GET/api/labelsСписок всех меток рабочего пространства
POST/api/labelsСоздать метку
PUT/api/labels/:idОбновить метку
DELETE/api/labels/:idУдалить метку
POST/api/issues/:id/labelsДобавить метку к задаче
DELETE/api/issues/:id/labels/:label_idУдалить метку из задачи

Спринты

МетодЭндпоинтОписание
GET/api/projects/:id/sprintsСписок спринтов
POST/api/projects/:id/sprintsСоздать спринт
PUT/api/sprints/:idОбновить спринт
DELETE/api/sprints/:idУдалить спринт

Предложения

МетодЭндпоинтОписание
GET/api/proposalsСписок предложений
POST/api/proposalsСоздать предложение
GET/api/proposals/:idПолучить детали предложения
POST/api/proposals/:id/voteОтдать голос
POST/api/proposals/:id/submitОтправить на голосование
POST/api/proposals/:id/archiveАрхивировать предложение

Управление

МетодЭндпоинтОписание
GET/api/governance/configПолучить конфигурацию управления
PUT/api/governance/configОбновить конфигурацию управления
GET/api/governance/audit-logsСписок журналов аудита управления

Решения

МетодЭндпоинтОписание
GET/api/decisionsСписок решений
GET/api/decisions/:idПолучить детали решения

Оценки доверия

МетодЭндпоинтОписание
GET/api/trust-scoresСписок оценок доверия
GET/api/trust-scores/:user_idПолучить оценку доверия пользователя
GET/api/trust-scores/:user_id/historyПолучить историю оценки
POST/api/trust-scores/:user_id/appealsПодать апелляцию

Вето

МетодЭндпоинтОписание
GET/api/vetoСписок событий вето
POST/api/vetoСоздать вето
POST/api/veto/:id/escalateЭскалировать вето

AI-агенты

МетодЭндпоинтОписание
GET/api/projects/:id/ai-agentsСписок AI-агентов
POST/api/projects/:id/ai-agentsЗарегистрировать AI-агента
GET/api/projects/:id/ai-agents/:agent_idПолучить детали агента
PUT/api/projects/:id/ai-agents/:agent_idОбновить агента
DELETE/api/projects/:id/ai-agents/:agent_idУдалить агента

AI-задачи

МетодЭндпоинтОписание
GET/api/projects/:id/ai-tasksСписок AI-задач
POST/api/projects/:id/ai-tasksСоздать AI-задачу
PUT/api/projects/:id/ai-tasks/:task_idОбновить статус задачи
POST/api/projects/:id/ai-tasks/:task_id/callbackОбратный вызов задачи

Загрузка файлов

МетодЭндпоинтОписание
POST/api/v1/uploadЗагрузить файл (multipart/form-data)

Поддерживаемые типы: изображения (PNG, JPG, GIF, WebP), документы (PDF, TXT), данные (JSON, CSV, XML), архивы (ZIP, GZ), логи.

Webhooks

МетодЭндпоинтОписание
GET/api/workspaces/:id/webhooksСписок webhooks
POST/api/workspaces/:id/webhooksСоздать webhook
PUT/api/workspaces/:id/webhooks/:wh_idОбновить webhook
DELETE/api/workspaces/:id/webhooks/:wh_idУдалить webhook
GET/api/workspaces/:id/webhooks/:wh_id/deliveriesЖурнал доставки

Поиск

МетодЭндпоинтОписание
GET/api/search?q=<query>Полнотекстовый поиск по всем сущностям

Администрирование

МетодЭндпоинтОписание
GET/api/admin/usersСписок всех пользователей (только admin)
PUT/api/admin/users/:idОбновить пользователя (только admin)

Работоспособность

МетодЭндпоинтОписаниеAuth
GET/healthПроверка работоспособностиНет

Следующие шаги

Released under the Apache-2.0 License.