diff --git a/docs/Admin manuals/sheduler/API.md b/docs/Admin manuals/sheduler/API.md deleted file mode 100644 index aabeec9..0000000 --- a/docs/Admin manuals/sheduler/API.md +++ /dev/null @@ -1 +0,0 @@ -Описание API \ No newline at end of file diff --git a/docs/Admin manuals/sheduler/SUMMARY.md b/docs/Admin manuals/sheduler/SUMMARY.md deleted file mode 100644 index 3befe4a..0000000 --- a/docs/Admin manuals/sheduler/SUMMARY.md +++ /dev/null @@ -1,6 +0,0 @@ -* [Описание](description.md) -* [Зависимости](dependencies.md) -* [Настройка](configuration.md) -* [API](API.md) -* [Интеграция](integration.md) -* [Примеры](examples.md) \ No newline at end of file diff --git a/docs/Admin manuals/sheduler/configuration.md b/docs/Admin manuals/sheduler/configuration.md deleted file mode 100644 index 6e0bd1d..0000000 --- a/docs/Admin manuals/sheduler/configuration.md +++ /dev/null @@ -1,24 +0,0 @@ -# Настройки сервиса - планировщика заданий - -!!! note - Раздел applications { scheduler { }} конфигурационного файла ./config/production.js - -- _**protocol**_ - используемый веб-протокол (рекомендуемое `'http'`). -- _**host**_ - имя хоста (рекомендуемое `'localhost'`). -- _**port**_ - порт для запуска (рекомендуемое - `3075`). -- _**route**_ - используемый маршрут (по умолчанию `'/api/v2.0/scheduler'`). -- _**script**_ - путь к модулю, запускающему сервис (рекомендуемое `'ecosoft-lexema8-scheduler-service'`). -- _**clientInfo**_ - Объект содкржащий данные для получения токенов для работы с приложением. - - _**clientId**_ - id стороннего приложения. Указанный id не рекомендуется испльзовать для других сторонних приложений. - - _**clientSecret**_ - секретный ключ стороннего приложения. - - _**defaultUser**_ - ключ пользователя из объекта _users_ для работы с приложением. - - _**users**_ - объект содержащий данные о пользователях для работы с приложением. Пример: - -default: { // default - ключ пользователя - userName: %Имя пользователя%, - password: %Пароль пользователя% -} - -- _**functions**_ - массив названий подключаемых к сервису пакетов функций. -- _**attemptsLimit**_ - количество попыток инициализации сервиса (по умолчанию `6`) -- _**beginTimeout**_ - таймаут между попыток инициализации сервиса (по умолчанию `1000`) \ No newline at end of file diff --git a/docs/Admin manuals/sheduler/dependencies.md b/docs/Admin manuals/sheduler/dependencies.md deleted file mode 100644 index 1c1a1f8..0000000 --- a/docs/Admin manuals/sheduler/dependencies.md +++ /dev/null @@ -1 +0,0 @@ -описание зависимостей \ No newline at end of file diff --git a/docs/Admin manuals/sheduler/description.md b/docs/Admin manuals/sheduler/description.md deleted file mode 100644 index 1f2a2d8..0000000 --- a/docs/Admin manuals/sheduler/description.md +++ /dev/null @@ -1,4 +0,0 @@ -# Сервис планировщик задач - -!!! note - Опциональный элемент системы. API доступно только внутри инфраструктуры серверной части lexema8. \ No newline at end of file diff --git a/docs/Admin manuals/sheduler/examples.md b/docs/Admin manuals/sheduler/examples.md deleted file mode 100644 index aef6e98..0000000 --- a/docs/Admin manuals/sheduler/examples.md +++ /dev/null @@ -1 +0,0 @@ -примеры использования \ No newline at end of file diff --git a/docs/Admin manuals/sheduler/index.md b/docs/Admin manuals/sheduler/index.md deleted file mode 100644 index d658fb1..0000000 --- a/docs/Admin manuals/sheduler/index.md +++ /dev/null @@ -1,8 +0,0 @@ -{% - include-markdown "./description.md" - heading-offset=1 -%} -{% - include-markdown "./configuration.md" - heading-offset=1 -%} \ No newline at end of file diff --git a/docs/Admin manuals/sheduler/integration.md b/docs/Admin manuals/sheduler/integration.md deleted file mode 100644 index b35b87c..0000000 --- a/docs/Admin manuals/sheduler/integration.md +++ /dev/null @@ -1 +0,0 @@ -описание интеграции, подключение сервиса, использование библиотеки \ No newline at end of file