Пространства и участники
Рабочие пространства
Заголовок раздела «Рабочие пространства»| Метод | Путь | Что делает |
|---|---|---|
GET |
/api/workspaces/ |
Ваши пространства (токен видит только своё) |
POST |
/api/workspaces/ |
Создать: { "name": "…", "slug": "…" } |
GET |
/api/workspaces/{id} |
Прочитать одно, вместе с вашей ролью |
PATCH |
/api/workspaces/{id} |
Изменить: name, image, piiRedaction, timezone — владелец или администратор |
DELETE |
/api/workspaces/{id} |
Удалить со всем содержимым — только владелец |
timezone — часовой пояс IANA (по умолчанию Europe/Moscow). По нему запускаются регулярные задачи
и боты понимают, какое сегодня число.
Создавать может только вошедший участник, токен — нет. slug необязателен; если его нет,
он получается из названия.
Участники
Заголовок раздела «Участники»Пути указаны относительно /api/workspaces/{workspaceId}.
| Метод | Путь | Что делает |
|---|---|---|
GET |
/members/ |
Список участников |
POST |
/members/ |
Пригласить, как POST /invitations/: { "email", "role" } |
PATCH |
/members/{userId} |
Сменить роль: { "role": "admin" } |
DELETE |
/members/{userId} |
Удалить из пространства |
Роли: owner (владелец), admin (администратор) и member (участник). Менять состав
участников может только вошедший владелец или администратор.
Приглашения
Заголовок раздела «Приглашения»| Метод | Путь | Что делает |
|---|---|---|
GET |
/invitations/ |
Ожидающие приглашения в это пространство |
POST |
/invitations/ |
Пригласить: { "email": "…", "role": "member" } |
DELETE |
/invitations/{invitationId} |
Отозвать |
Приглашение отправляет письмо со ссылкой, которая действует 14 дней. Пригласить другого
владельца может только владелец; приглашение того, кто уже участник, возвращает 409.
Приглашения, адресованные вам, во всех пространствах — в GET /api/invitations/; принять
приглашение — POST /api/invitations/{invitationId}/accept, отклонить —
DELETE /api/invitations/{invitationId}.