diff --git a/docs/server-api-v1/auth.md b/docs/server-api-v1/auth.md index a407def..2072033 100644 --- a/docs/server-api-v1/auth.md +++ b/docs/server-api-v1/auth.md @@ -6,7 +6,7 @@ Для авторизации и получения токена общения с сервером. По умолчанию жизнь токена ограничена по времени -### Пример запроса +#### Пример запроса ```json { "login": "JohnDoe", @@ -15,7 +15,7 @@ } ``` -### Пример успешного ответа +#### Пример успешного ответа ```json { "status": "ok", @@ -23,7 +23,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -36,14 +36,14 @@ ### GET `/api/v1/auth/logout` Убить токен авторизации, выйти из системы. При этом в заголовке должен присутствовать токен -### Ответ в случае успеха +#### Ответ в случае успеха ```json { "status": "ok" } ``` -### Ответ, если что-то пошло не так +#### Ответ, если что-то пошло не так ```json { "status": "error" diff --git a/docs/server-api-v1/devices.md b/docs/server-api-v1/devices.md index d2f7f31..48929ad 100644 --- a/docs/server-api-v1/devices.md +++ b/docs/server-api-v1/devices.md @@ -208,7 +208,7 @@ ### 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/general.md b/docs/server-api-v1/general.md index 533a939..8e09129 100644 --- a/docs/server-api-v1/general.md +++ b/docs/server-api-v1/general.md @@ -1,4 +1,4 @@ -# Спецификация REST API для сервера +## Спецификация REST API для сервера Для доступа к серверу необходимо авторизоваться и получить токен API и передавать его каждый раз в заголовке ``` @@ -11,7 +11,7 @@ ### GET `/api/v1/status` должен вернуть статус сервера, и ссылку на документацию -### Пример ответа +#### Пример ответа ```json { "status": "active", diff --git a/docs/server-api-v1/groups.md b/docs/server-api-v1/groups.md index 6c9f2fa..7f5e61c 100644 --- a/docs/server-api-v1/groups.md +++ b/docs/server-api-v1/groups.md @@ -29,7 +29,7 @@ Получить список существующих груп - **Примечание:** Доступно лишь админу и выше. -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -41,7 +41,7 @@ } ``` -### Пример НЕ успешного ответа. Не хватает прав +#### Пример НЕ успешного ответа. Не хватает прав ```json { "status": "error", @@ -56,7 +56,7 @@ - **Все права по умолчанию будут отключены.** - Создавать группу может только админ или выше. -### Пример запроса +#### Пример запроса ```json { "alias": "home", // Required @@ -65,7 +65,7 @@ } ``` -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -73,7 +73,7 @@ } ``` -### Пример НЕ успешного ответа. Не хватает прав +#### Пример НЕ успешного ответа. Не хватает прав ```json { "status": "error", @@ -81,7 +81,7 @@ } ``` -### Пример НЕ успешного ответа. Невалидные поля +#### Пример НЕ успешного ответа. Невалидные поля ```json { "status": "error", @@ -95,7 +95,7 @@ ### GET `/api/v1/groups/id/{{id}}` OR GET `/api/v1/groups/alias/{{alias}}` Получить группу по id -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -109,7 +109,7 @@ Добавить пользователя в группу - **Доступно лишь админу и выше** -### Пример запроса +#### Пример запроса ```json { "user_id": 12 @@ -121,7 +121,7 @@ ### GET `/api/v1/groups/id/{{id}}/users` OR GET `/api/v1/groups/alias/{{alias}}/users` Получить список пользователей группы -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -139,7 +139,7 @@ Удалить группу, пользователи в этой группе должны стать безправными. - **Доступно лишь админу и выше** -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -147,7 +147,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -160,7 +160,7 @@ ### POST `/api/v1/groups/id/{{id}}/update` Редактировать группу -### Пример запроса +#### Пример запроса ```json { "name": "Changed name", @@ -168,7 +168,7 @@ } ``` -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -181,7 +181,7 @@ ### POST `/api/v1/groups/id/{{id}}/permissions/update` Редактировать флаги доступа к устройствам и скриптам -### Пример запроса +#### Пример запроса ```json { "permissions": { @@ -192,7 +192,7 @@ } ``` -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -200,7 +200,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", diff --git a/docs/server-api-v1/logs.md b/docs/server-api-v1/logs.md index 7586235..231e4aa 100644 --- a/docs/server-api-v1/logs.md +++ b/docs/server-api-v1/logs.md @@ -44,7 +44,7 @@ Получить последние 50 записей в журнале - **Доступно админу и выше** -### Пример ответа +#### Пример ответа ```json { "status": "ok", diff --git a/docs/server-api-v1/notifications.md b/docs/server-api-v1/notifications.md index 17b3be2..4b15eac 100644 --- a/docs/server-api-v1/notifications.md +++ b/docs/server-api-v1/notifications.md @@ -23,7 +23,7 @@ ### GET `/api/v1/notifications/list` Список непрочитанных уведомлений -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -40,7 +40,7 @@ ### GET `/api/v1/notifications/id/{{id}}/read` Отметить выбранноео уведомление как прочитанное -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -55,7 +55,7 @@ - `type` будет установлен в **aside** - Пушить сторонние уведомления можно лишь от имени администратора и выше. -### Пример запроса +#### Пример запроса ```json { "icon": "home", // Load from icon pack or url to img @@ -65,7 +65,7 @@ } ``` -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -73,7 +73,7 @@ } ``` -### Пример НЕ успешного ответа. Не хватает прав +#### Пример НЕ успешного ответа. Не хватает прав ```json { "status": "error", diff --git a/docs/server-api-v1/scripts.md b/docs/server-api-v1/scripts.md index c936695..338cc00 100644 --- a/docs/server-api-v1/scripts.md +++ b/docs/server-api-v1/scripts.md @@ -61,7 +61,7 @@ } ``` -### Пример НЕ успешного ответа. Невалидные поля +#### Пример НЕ успешного ответа. Невалидные поля ```json { "status": "error", @@ -85,7 +85,7 @@ } ``` -### Пример НЕ успешного ответа. Невалидные поля +#### Пример НЕ успешного ответа. Невалидные поля ```json { "status": "error", diff --git a/docs/server-api-v1/users.md b/docs/server-api-v1/users.md index f6db48e..c468b0b 100644 --- a/docs/server-api-v1/users.md +++ b/docs/server-api-v1/users.md @@ -30,7 +30,7 @@ Добавить в систему нового пользователя. - Нового пользователя может добавить как админ так и суперадмин, но назначить группу прав ниже своей. -### Пример запроса +#### Пример запроса ```json { "first_name": "John", @@ -43,7 +43,7 @@ } ``` -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -51,7 +51,7 @@ } ``` -### Пример НЕ успешного ответа. Невалидные поля +#### Пример НЕ успешного ответа. Невалидные поля ```json { "status": "error", @@ -60,7 +60,7 @@ } ``` -### Пример НЕ успешного ответа. Не хватает прав +#### Пример НЕ успешного ответа. Не хватает прав ```json { "status": "error", @@ -70,7 +70,7 @@ --- -### GET `/api/v1/users/list` +#### GET `/api/v1/users/list` Получить список пользователей ### Пример ответа @@ -85,7 +85,7 @@ } ``` -### Пример НЕ успешного ответа. Не хватает прав +#### Пример НЕ успешного ответа. Не хватает прав ```json { "status": "error", @@ -98,7 +98,7 @@ ### GET `/api/v1/users/id/{{id}}` Получить все доступные данные о пользователе. -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -106,7 +106,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -119,7 +119,7 @@ ### GET `/api/v1/users/current/` Получить все доступные данные о текущем авторизованом пользователе -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -133,7 +133,7 @@ Редактирование пользователя. Можно передать только необходимое поле для редактирования. - **Внимание!** Поле `role` будет проигнорировано, используй для этого специальный эндпоинт -### Пример запроса +#### Пример запроса ```json { "last_name": "Smith", @@ -141,7 +141,7 @@ } ``` -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -155,14 +155,14 @@ Установка новой аватарки пользователя. - **Примечание:** через `/update` можно установить прямую ссылку на аватарку -### Пример запроса +#### Пример запроса ```json { "upload_userpic": "base64;...", // Обязательно в base64, разрешение 512*512 пикс. } ``` -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -170,7 +170,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -184,14 +184,14 @@ Смена роли пользователя. - **ВНИМАНИЕ!** доступно лишь суперадмину -### Пример запроса +#### Пример запроса ```json { "role": "admin", // | "user" } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -204,7 +204,7 @@ ### POST `/api/v1/users/id/{{id}}/update/password` Изменить пароль, от 6 любых символов, больше критериев нет. -### Пример запроса +#### Пример запроса ```json { "password": "current_password", @@ -212,7 +212,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -229,7 +229,7 @@ - Админ может сбросить пароль лишь простым пользователям. - Админу сбросить пароль может лишь суперадминистратор -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -237,7 +237,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -254,7 +254,7 @@ - Суперадмин может получить таблицу прав любого пользователя. Сам при этом обладает по умолчанию всеми доступными правами. - **ВАЖНО!** Это права не отдельно взятого пользователя, а группы в которой состоит пользователь. -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -262,7 +262,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", @@ -273,7 +273,7 @@ ### GET `/api/v1/users/id/{{id}}/remove` Удалить пользователя. **Может быть выполнено только администратором или выше** -### Пример ответа +#### Пример ответа ```json { "status": "ok", @@ -281,7 +281,7 @@ } ``` -### Пример НЕ успешного ответа +#### Пример НЕ успешного ответа ```json { "status": "error", diff --git a/docs/server-spec.md b/docs/server-spec.md index 36c2703..e177a5f 100644 --- a/docs/server-spec.md +++ b/docs/server-spec.md @@ -12,7 +12,7 @@ --- -### Формат запроса +#### Формат запроса ```json {