diff --git a/docs/server-api-v1/events.md b/docs/server-api-v1/events.md deleted file mode 100644 index e69de29..0000000 --- a/docs/server-api-v1/events.md +++ /dev/null diff --git a/docs/server-api-v1/notifications.md b/docs/server-api-v1/notifications.md new file mode 100644 index 0000000..226548c --- /dev/null +++ b/docs/server-api-v1/notifications.md @@ -0,0 +1,14 @@ +## Система нотификации +- Основное предназначение - комутировать системные и генерируемые скриптами уведомления, для централизованого вывода. +- Уведомления доступны лишь авторизированным пользователям. +- Уведомления могут быть предназначены всем, отдельным группам пользователей или отдельным пользователям. Со стороны использования API это не играет роли. +- Сторонними считаются уведомлениями сгенерированные скриптами или инициированные внешним источним через API + +### GET `/api/v1/notifications/list` +Список непрочитанных уведомлений + +### GET `/api/v1/notifications/id/{{id}}/read` +Отметить выбранноео уведомление как прочитанное + +### POST `/api/v1/notifications/new` +Запушить новое уведомление diff --git a/docs/server-api-v1/users.md b/docs/server-api-v1/users.md index 7c6031e..e634324 100644 --- a/docs/server-api-v1/users.md +++ b/docs/server-api-v1/users.md @@ -47,4 +47,4 @@ - **ВАЖНО!** Это права не отдельно взятого пользователя, а группы в которой состоит пользователь. ### GET `/api/v1/users/id/{{id}}/remove` -Удалить пользователя. **Может быть выполнено только администратором или выше** \ No newline at end of file +Удалить пользователя. **Может быть выполнено только администратором или выше**