mirror of
https://github.com/Govor-team/Govor.git
synced 2026-11-18 05:15:06 +00:00
docs: split messaging and privileges guides
Organize reply/forward and friendship guidance into focused endpoint docs, add Govor+ privilege, profile-tag, and realtime guides, and document migrations and verification results.
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
# Привилегии и Govor+
|
||||
|
||||
Govor+ — назначаемый администратором специальный статус пользователя. Платёжная подписка пока не требуется. Права хранятся в БД и проверяются при каждой операции: выдача и отзыв работают во время работы API, без перезапуска и обновления JWT. Govor+ не выдаёт административных ролей.
|
||||
|
||||
## Набор прав
|
||||
|
||||
| Значение privileges | Права |
|
||||
| ------------------- | ------------------------------------------------------- |
|
||||
| 0 | Без специальных прав |
|
||||
| 1 | Govor+: официальный статус и настройка профильного тега |
|
||||
| 2 | Настройка профильного тега без статуса Govor+ |
|
||||
| 3 | Оба явно назначенных бита |
|
||||
|
||||
Это битовая маска: GovorPlus = 1, CustomProfileTag = 2. Неизвестные биты сервер отклоняет. Новые возможности добавляются отдельными битами с проверкой в соответствующем сервисе.
|
||||
|
||||
## Выдача и отзыв
|
||||
|
||||
`PUT /api/admin/users/{userId}/privileges` требует access JWT с ролью Admin. Запрос заменяет весь набор прав пользователя.
|
||||
|
||||
Выдать Govor+:
|
||||
|
||||
```json
|
||||
{ "privileges": 1 }
|
||||
```
|
||||
|
||||
Отозвать все специальные права:
|
||||
|
||||
```json
|
||||
{ "privileges": 0 }
|
||||
```
|
||||
|
||||
Успех — 200 с UserBenefitsView. Ошибки: 400 — неизвестные биты; 404 — пользователь не найден; 409 — конкурентное первое создание прав, перечитайте состояние и повторите запрос. Без JWT — 401, без роли Admin — 403.
|
||||
|
||||
## Чтение состояния
|
||||
|
||||
`GET /api/profile/{userId}/benefits` требует действующего access JWT. Тот же объект benefits входит в `GET /api/profile/download/me` и `GET /api/profile/download/{id}`.
|
||||
|
||||
| Поле | Назначение |
|
||||
| ---------------------- | ------------------------------------------------------- |
|
||||
| privileges | Явно назначенная битовая маска |
|
||||
| isGovorPlus | Наличие официального статуса Govor+ |
|
||||
| canCustomizeProfileTag | Право изменять оформление тега, включая право от Govor+ |
|
||||
| tag | Текущее доступное оформление или null |
|
||||
| revision | Монотонная ревизия состояния пользователя |
|
||||
|
||||
Официальный статус определяйте по isGovorPlus, а доступность редактора — по canCustomizeProfileTag. Текст тега произволен и не доказывает наличие статуса.
|
||||
|
||||
Обычный пользователь получает tag: null. У Govor+ без собственного оформления отображается стандартный тег. При отзыве всех прав настройки сохранённое оформление скрывается и перестаёт редактироваться; при повторной выдаче восстанавливается.
|
||||
|
||||
## Разделы
|
||||
|
||||
* [Профильные теги: HTTP-контракт и оформление](profile-tags.md).
|
||||
* [Обновления статуса и тега: SignalR и ревизии](realtime.md).
|
||||
|
||||
## Установка
|
||||
|
||||
Контракт реализован в дополнениях от 31.10.2026. Перед запуском версии примените миграции `MessagingAndUserBenefits` и `UserBenefitsRevision`; существующим пользователям права автоматически не назначаются. [Порядок обновления сервера](../operations.md).
|
||||
Reference in New Issue
Block a user