{"swagger":"2.0","info":{"description":"Система сбора информации 3iCrawler","version":"1.0.0","title":"3iCrawler","contact":{"email":"e.sadovnik@3itech.ru"}},"consumes":["application/json"],"produces":["application/json"],"paths":{"/":{"get":{"tags":["admins"],"summary":"Информация о системе","description":"Информация о состоянии системы сбора информации.\n","responses":{"200":{"description":"Информация о состоянии системы сбора информации","schema":{"$ref":"#/definitions/Status"}}}}},"/projects":{"get":{"tags":["admins"],"summary":"Получить список проектов.","description":"Получить список проектов в системе.","responses":{"200":{"description":"Список проектов.","schema":{"type":"array","items":{"$ref":"#/definitions/File"}}}}},"post":{"tags":["admins"],"summary":"Создать проект","description":"Создать проект","parameters":[{"name":"data","in":"body","description":"Название проекта","required":true,"schema":{"$ref":"#/definitions/ProjectName"}}],"responses":{"201":{"description":"Информация о проекте.","schema":{"$ref":"#/definitions/ProjectFull"}}}}},"/projects/{id}":{"get":{"tags":["admins"],"summary":"Получить информацию о проекте.","description":"Получить информацию о проекте по конкретному идентификатору.","parameters":[{"$ref":"#/parameters/ProjectId"}],"responses":{"200":{"description":"Информация о проекте.","schema":{"$ref":"#/definitions/ProjectFull"}}}},"delete":{"tags":["admins"],"summary":"Удалить проект.","description":"Удалить проект по идентификатору проекта.","parameters":[{"$ref":"#/parameters/ProjectId"}],"responses":{"204":{"description":"Проект успешно удалён."}}},"post":{"tags":["admins"],"summary":"Изменить проект","description":"Добавить файлы в проект, изменить название проекта, отключить/включить проект","parameters":[{"$ref":"#/parameters/ProjectId"},{"name":"data","in":"body","description":"Настройки проекта","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","description":"новое название проекта"},"enabled":{"type":"boolean","description":"активировть проект"},"files":{"type":"array","description":"добавить/заменить файлы","items":{"type":"object","properties":{"name":{"type":"string","description":"имя файла"},"content":{"type":"string","format":"binary","description":"содержимое файла"}}}}}}}],"responses":{"200":{"description":"Информация о проекте.","schema":{"$ref":"#/definitions/ProjectFull"}}}}},"/projects/{id}/templates":{"get":{"tags":["admins"],"summary":"Получить список шаблонов запуска.","description":"Получить список шаблонов запуска.","parameters":[{"$ref":"#/parameters/ProjectId"}],"responses":{"200":{"description":"Список шаблонов запуска.","schema":{"type":"array","items":{"$ref":"#/definitions/Template"}}}}}},"/projects/{id}/templates/{tid}":{"delete":{"tags":["admins"],"summary":"Удалить шаблон","description":"Удалить шаблон","parameters":[{"$ref":"#/parameters/ProjectId"},{"$ref":"#/parameters/TemplateId"}],"responses":{"204":{"description":"Шаблон успешно удалён."}}},"put":{"tags":["admins"],"summary":"Изменить шаблон","description":"Добавить файлы в проект, изменить название проекта, отключить/включить проект","parameters":[{"$ref":"#/parameters/ProjectId"},{"$ref":"#/parameters/TemplateId"},{"name":"data","in":"body","description":"Настройки шаблона","required":true,"schema":{"$ref":"#/definitions/Template"}}],"responses":{"204":{"description":"Шаблон изменен о проекте."}}}},"/launches":{"get":{"tags":["admins"],"summary":"Получить список выполняемых заданий.","description":"Получить список выполняемых заданий.","responses":{"200":{"description":"Список выполняемых заданий.","schema":{"type":"array","items":{"$ref":"#/definitions/Launch"}}}}},"post":{"tags":["admins"],"summary":"Запустить роботы","description":"Запустить роботы","parameters":[{"name":"data","in":"body","description":"Параметры запуска","required":true,"schema":{"$ref":"#/definitions/ProjectStart"}}],"responses":{"201":{"description":"Список созданных заданий","schema":{"type":"array","items":{"$ref":"#/definitions/Launch"}}}}}},"/launches/{id}":{"get":{"tags":["admins"],"summary":"Информация о выполняемом задании","description":"Информация о выполняемом задании","parameters":[{"$ref":"#/parameters/LaunchId"}],"responses":{"200":{"description":"Информация о проекте.","schema":{"$ref":"#/definitions/LaunchFull"}}}},"delete":{"tags":["admins"],"summary":"Остановить выполнение задания","description":"Остановить выполнение задания","parameters":[{"$ref":"#/parameters/ProjectId"}],"responses":{"204":{"description":"Задание остановлено."}}}}},"definitions":{"Status":{"type":"object","required":["slots"],"properties":{"slots":{"type":"integer","format":"int32","description":"максимальное количество потоков","example":50},"launches":{"type":"integer","format":"int32","description":"количество занятых потоков","example":4},"queue":{"type":"integer","format":"int32","description":"количество заданий в очереди","example":80},"pools":{"type":"array","description":"пулы потоков","items":{"$ref":"#/definitions/Pool"}}}},"Pool":{"properties":{"id":{"type":"integer","minimum":-1,"description":"идентификатор пула потоков (-1 - реального времени, 0 - по умолчанию)"},"name":{"type":"string","description":"название пула потоков"},"size":{"type":"integer","format":"int32","description":"количество потоков","example":20},"launches":{"type":"integer","format":"int32","description":"количество занятых потоков","example":4},"queue":{"type":"integer","format":"int32","description":"количество заданий в очереди","example":4},"priority":{"type":"integer","format":"int32","description":"приоритет потоков (от 0 до 5)","minimum":0,"maximum":5,"example":2}}},"ProjectName":{"properties":{"name":{"type":"string","description":"название проекта"},"enabled":{"type":"boolean","description":"проект активен"}}},"Project":{"properties":{"id":{"type":"string","description":"идентификатор проекта"},"name":{"type":"string","description":"название проекта"},"enabled":{"type":"boolean","description":"проект активен"},"robots":{"type":"integer","format":"int32","description":"количество роботов в проекте","example":4},"collections":{"type":"integer","format":"int32","description":"количество коллекций в проекте","example":1},"tasks":{"type":"integer","format":"int32","description":"количество заданий в планировщике","example":0}}},"ProjectFull":{"properties":{"id":{"type":"string","description":"идентификатор проекта"},"name":{"type":"string","description":"название проекта"},"enabled":{"type":"boolean","description":"проект активен"},"files":{"type":"array","items":{"$ref":"#/definitions/File"}},"collections":{"type":"array","items":{"$ref":"#/definitions/Collection"}},"tasks":{"type":"array","items":{"$ref":"#/definitions/Task"}}}},"File":{"properties":{"name":{"type":"string","description":"имя файла"},"type":{"type":"string","description":"тип файла","enum":["robot","type","database"]},"enabled":{"type":"boolean","description":"файл активен"},"created":{"type":"string","format":"date-time","description":"дата создания файла"},"modified":{"type":"string","format":"date-time","description":"дата изменения файла"},"description":{"type":"string","description":"описание файла"}}},"Collection":{"properties":{"id":{"type":"string","description":"идентификатор коллекции"},"name":{"type":"string","description":"название коллекции"},"description":{"type":"string","description":"описание коллекции"},"robots":{"type":"array","items":{"type":"string"}}}},"Template":{"properties":{"id":{"type":"string","description":"идентификатор шаблона"},"name":{"type":"string","description":"название шаблона"},"timeout":{"type":"integer","minimum":0,"description":"ограничение времени выполнения задания в минутах"},"input":{"type":"array","items":{"$ref":"#/definitions/InputValue"}}}},"Task":{"properties":{"id":{"type":"string","description":"идентификатор коллекции"},"name":{"type":"string","description":"название коллекции"},"triggers":{"type":"array","items":{"$ref":"#/definitions/Trigger"}},"robots":{"type":"array","description":"список запускаемых роботов","items":{"type":"string"}},"collections":{"type":"array","description":"список запускаемых коллекций роботов","items":{"type":"string"}},"all":{"type":"boolean","description":"запустить все роботы"},"priority":{"type":"integer","description":"приоритет запускаемых роботов","minimum":1,"maximum":5},"pool":{"type":"integer","description":"пул потоков в которых выполняются роботы","example":0},"template":{"type":"integer","description":"шаблон значений входных параметров"},"timeout":{"type":"integer","minimum":0,"description":"ограничение времени выполнения задания в минутах"},"input":{"type":"array","items":{"$ref":"#/definitions/InputValue"}}}},"Trigger":{"properties":{"cron":{"type":"string"}}},"ProjectStart":{"properties":{"projectId":{"type":"integer","format":"int64"},"taskId":{"type":"string","description":"задание планировщика"},"robots":{"type":"array","description":"список запускаемых роботов","items":{"type":"string"}},"collections":{"type":"array","description":"список запускаемых коллекций роботов","items":{"type":"string"}},"all":{"type":"boolean","description":"запустить все роботы"},"priority":{"type":"integer","description":"приоритет запускаемых роботов","minimum":1,"maximum":5},"pool":{"type":"string","description":"пул потоков в которых выполняются роботы","example":"default"},"template":{"type":"string","description":"шаблон значений входных параметров"},"input":{"type":"array","items":{"$ref":"#/definitions/InputValue"}}}},"InputValue":{"properties":{"name":{"type":"string","description":"название входной переменной"},"value":{"type":"string","description":"значение входной переменной (строка)"},"expression":{"type":"string","description":"значение входной переменной (в виде выражения)"},"binary":{"type":"string","format":"binary","description":"значение входной переменной (двоичные данные)"}}},"Launch":{"properties":{"launchId":{"type":"string"},"projectId":{"description":"Идентификатор проекта.","type":"integer","format":"int64"},"projectName":{"type":"string"},"robot":{"type":"string"},"input":{"type":"string"},"state":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"pid":{"type":"integer","format":"int64"},"return":{"type":"string"},"exceptions":{"type":"integer"}}},"LaunchFull":{"properties":{"launchId":{"type":"string"},"projectId":{"description":"Идентификатор проекта.","type":"integer","format":"int64"},"projectName":{"type":"string"},"robot":{"type":"string"},"input":{"$ref":"#/definitions/InputValue"},"state":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"pid":{"type":"integer","format":"int64"},"return":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"integer"}}}},"exceptions":{"type":"array","items":{"$ref":"#/definitions/Exception"}},"log":{"type":"string"}}},"Exception":{"properties":{"path":{"type":"string"},"pathString":{"type":"string"},"error":{"type":"string"},"errorString":{"type":"string"},"step":{"type":"string"},"stepString":{"type":"string"},"action":{"type":"string"},"actionString":{"type":"string"},"variables":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"parameters":{"ProjectId":{"in":"path","name":"id","description":"Идентификатор проекта.","required":true,"type":"integer","format":"int64"},"LaunchId":{"in":"path","name":"id","description":"Идентификатор задания.","required":true,"type":"string"},"TemplateId":{"in":"path","name":"tid","description":"Идентификатор шаблона","required":true,"type":"integer","format":"int64"}},"host":"virtserver.swaggerhub.com","basePath":"/seug/3iCrawler/1.0.0","schemes":["https","http"]}