diff --git a/docs/devices/button.md b/docs/devices/button.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/devices/button.md diff --git a/docs/devices/pin_keyboard.md b/docs/devices/pin_keyboard.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/devices/pin_keyboard.md diff --git a/docs/server-api-v1/notifications.md b/docs/server-api-v1/notifications.md index 4338c32..968c1a4 100644 --- a/docs/server-api-v1/notifications.md +++ b/docs/server-api-v1/notifications.md @@ -4,17 +4,78 @@ - Уведомления могут быть предназначены всем, отдельным группам пользователей или отдельным пользователям. Со стороны использования API это не играет роли. - Сторонними считаются уведомлениями сгенерированные скриптами или инициированные внешним источним через API +### Notification STRUCT +```json + { + "id": 42, + "user_id": 12, + "type": "system", // "system" | "script" | "aside" + "icon": "home", // Load from icon pack or url to img + "title": "The notification", + "body": "body of notification", + "link": "http://...", + "create_at": "2025-07-28 18:35" + } + ``` + --- ### GET `/api/v1/notifications/list` Список непрочитанных уведомлений +### Пример ответа +```json + { + "status": "ok", + "notifications": { + notification_struct... + }, + "total": 10 + } + ``` + --- ### GET `/api/v1/notifications/id/{{id}}/read` Отметить выбранноео уведомление как прочитанное +### Пример ответа +```json + { + "status": "ok", + "notification": notification_struct... + } + ``` + --- ### POST `/api/v1/notifications/new` -Запушить новое уведомление +Запушить новое уведомление. **Примечания:** +- `type` будет установлен в **aside** +- Пушить сторонние уведомления можно лишь от имени администратора и выше. + +### Пример запроса +```json + { + "icon": "home", // Load from icon pack or url to img + "title": "The notification", + "body": "body of notification", + "link": "http://...", + } + ``` + +### Пример ответа +```json + { + "status": "ok", + "notification": notification_struct... + } + ``` + +### Пример НЕ успешного ответа. Не хватает прав +```json + { + "status": "error", + "message": "Permissions error" // "Permission error" + } + ``` \ No newline at end of file