diff --git a/docs/server-api-v1/auth.md b/docs/server-api-v1/auth.md index 479dd7d..a407def 100644 --- a/docs/server-api-v1/auth.md +++ b/docs/server-api-v1/auth.md @@ -1,11 +1,17 @@ +## Система авторизации + +--- + ### POST `/api/v1/auth` -Для авторизации и получения токена общения с сервером +Для авторизации и получения токена общения с сервером. +По умолчанию жизнь токена ограничена по времени ### Пример запроса ```json { "login": "JohnDoe", - "password": "strong_password" + "password": "strong_password", + "unlimited": true // Не обязательное. Для отключения лимита жизни токена } ``` diff --git a/docs/server-api-v1/devices.md b/docs/server-api-v1/devices.md index 3cb7fe6..fd063b1 100644 --- a/docs/server-api-v1/devices.md +++ b/docs/server-api-v1/devices.md @@ -1,3 +1,7 @@ +## Управление устройствами умного дома + +--- + ### GET `/api/v1/devices/list` Получить список устройств о которых знает сервер @@ -188,10 +192,24 @@ --- ### GET `/api/v1/devices/id/{{id}}/forget` OR GET `/api/v1/devices/alias/{{alias}}/forget` -Забыть выбраный девайс. Сам девайс при этом будет ресетнуть +Забыть выбраный девайс. Сам девайс при этом будет ресетнуть. **Доступно лишь супер админу.** + +### Пример успешного ответа +```json + { + "status": "ok" + } + ``` --- ### GET `/api/v1/devices/id/{{id}}/reboot` OR GET `/api/v1/devices/alias/{{alias}}/reboot` -Принудительно перезагрузить устройство +Принудительно перезагрузить устройство. **Доступно лишь админу** + +### Пример успешного ответа +```json + { + "status": "ok" + } + ``` diff --git a/docs/server-api-v1/groups.md b/docs/server-api-v1/groups.md index e14b7c9..e0624a7 100644 --- a/docs/server-api-v1/groups.md +++ b/docs/server-api-v1/groups.md @@ -2,26 +2,42 @@ - В основном это нужно для назначения прав пользователям. - Группами пользователей может управлять только администратор или выше. +--- + ### GET `/api/v1/groups/list` Получить список существующих груп +--- + ### POST `/api/v1/groups/new_group` Добавить новую групу +--- + ### GET `/api/v1/groups/id/{{id}}` OR GET `/api/v1/groups/alias/{{alias}}` Получить группу по id +--- + ### GET `/api/v1/groups/id/{{id}}/permissions` OR GET `/api/v1/groups/alias/{{alias}}/permissions` Получить все доступные флаги доступа группы к устройствам и к скриптам +--- + ### POST `/api/v1/groups/id/{{id}}/add_user` Добавить пользователя в группу +--- + ### GET `/api/v1/groups/id/{{id}}/remove` Удалить группу, пользователи в этой группе должны стать безправными. +--- + ### POST `/api/v1/groups/id/{{id}}/update` Редактировать группу +--- + ### POST `/api/v1/groups/id/{{id}}/permissions/update` Редактировать флаги доступа к устройствам и скриптам diff --git a/docs/server-api-v1/logs.md b/docs/server-api-v1/logs.md index 95177e2..d318952 100644 --- a/docs/server-api-v1/logs.md +++ b/docs/server-api-v1/logs.md @@ -4,14 +4,20 @@ - скриптов, - и прочего. -**Доступно лишь падминистраторам и выше** +**Доступно лишь администраторам и выше** + +--- ### POST `/api/v1/logs/new` Добавить новую, кастомную запись в журнал +--- + ### GET `/api/v1/logs/list` Получить последние 50 записей в журнале +--- + ### GET `/api/v1/logs/list/filtered` Получить фильтрованый, сортированый, порционный вывод записей. **Аргементы:** diff --git a/docs/server-api-v1/notifications.md b/docs/server-api-v1/notifications.md index 226548c..4338c32 100644 --- a/docs/server-api-v1/notifications.md +++ b/docs/server-api-v1/notifications.md @@ -4,11 +4,17 @@ - Уведомления могут быть предназначены всем, отдельным группам пользователей или отдельным пользователям. Со стороны использования 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/scripts.md b/docs/server-api-v1/scripts.md index c194426..712f903 100644 --- a/docs/server-api-v1/scripts.md +++ b/docs/server-api-v1/scripts.md @@ -2,21 +2,33 @@ - Все действия должны выполняться от имени авторизованого пользователя. - Все скриптами может управлять только администратор. +--- + ### GET `/api/v1/scripts/list` Получить список скриптов +--- + ### GET `/api/v1/scripts/id/{{id}}` OR GET `/api/v1/scripts/alias/{{alias}}` Получить выбраный скрипт +--- + ### POST `/api/v1/scripts/new_script` Зарегистрировать в системе новый скрипт +--- + ### POST `/api/v1/scripts/id/{{id}}/update` Редактировать скрипт +--- + ### GET `/api/v1/scripts/id/{{id}}/remove` Удалить скрипт из системы. (Сам скрипт при этом вполне может оставаться в файловой системе) +--- + ### POST `/api/v1/scripts/id/{{id}}/run` Запустить выполнение скрипта. - При этом проверяется от имени какого пользователя был запущен скрипт.