очистка инструкций

This commit is contained in:
mirzakaev_tf 2023-05-31 08:51:07 +05:00
parent d83bf03571
commit 176030f2de
8 changed files with 0 additions and 46 deletions

View File

@ -1 +0,0 @@
Описание API

View File

@ -1,6 +0,0 @@
* [Описание](description.md)
* [Зависимости](dependencies.md)
* [Настройка](configuration.md)
* [API](API.md)
* [Интеграция](integration.md)
* [Примеры](examples.md)

View File

@ -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`)

View File

@ -1 +0,0 @@
описание зависимостей

View File

@ -1,4 +0,0 @@
# Сервис планировщик задач
!!! note
Опциональный элемент системы. API доступно только внутри инфраструктуры серверной части lexema8.

View File

@ -1 +0,0 @@
примеры использования

View File

@ -1,8 +0,0 @@
{%
include-markdown "./description.md"
heading-offset=1
%}
{%
include-markdown "./configuration.md"
heading-offset=1
%}

View File

@ -1 +0,0 @@
описание интеграции, подключение сервиса, использование библиотеки