Метаданные веб-приложения мониторинга

Содержание

Путь расположения
Обзор

Путь расположения

Путь в сборочном каталоге

Путь в сборочном каталоге
`/era_env/priv/metadata/<SOLUTION>/monitor.json`

/era_env/priv/metadata/<SOLUTION>/monitor.json

Обзор

Файл метаданных для веб-приложения "Мониторинг". Устанавливает структуру объектов, методов, параметров, фильтров и их описаний.

Обеспечивает веб-приложению описание структуры методов API /api/monitor/v1/<OBJECT>/<METHOD>.

Непосредственно системой «Era» не используется, служит только для выдачи через API. На этом основании содержание файлов произвольно, включая внутреннюю структуру.

Для использования в REST устарело.

Формат:

{
  "objects": {
    "<OBJECT>": {
      "title": "<TITLE>",
      "methods": [
        {
          "method": "<METHOD_NAME>",
          "modes": ["<MODE_1>", ...],
          "filters": [
            {
              "name": str,
              "type": str,
              "min": int,
              "inputtype": str,
              "title": str,
              "help": ["String1", "String2", ...]
            },
            ...
		  ],
          "params": [
            {
              "name": str,
              "type": str ("integer", "text"),
              "inputtype": str ("select", "text"),
              "min": int,
              "options": {
                "Key1": "Title1",
                "Key2": "Title2",
                ...
              },
              "title": string,
              "help": ["String1", "String2", ...]
            },
            ...
          ]
        },
        ...
      ]
    },
    ...
  }
}

Table 1. Поля структуры
Поле	Описание
`<OBJECT>`	название типа объекта, подставляемое в placeholder URL-адреса.
`title и <TITLE>`	название типа объекта, отображаемое в списке/таблице выбора в веб-приложении.
`method и <METHOD_NAME>`	название метода объекта, подставляемое в placeholder URL-адреса.
modes и <MODE_X>`	(опционально) список возможных режимов как одного из параметров выполняемого API-метода (параметр `mode`).
`filters`	(опционально) список возможных к использованию фильтров как параметров выполняемого API-метода. Поля дескриптора параметра
`params`	(опционально) список возможных к назначению параметров. Поля дескриптора параметра

Table 2. Поля дескриптора параметра
Поле	Описание
`name`	имя параметра.
`type`	отображаемый в приложении заголовок параметра.
`inputtype`	отображаемый в приложении заголовок параметра (`text`, `select`).
`min`	(опционально, для `type = integer`) минимально допустимое значение.
`max`	(опционально, для `type = integer`) максимально допустимое значение.
`options`	(для `inputtype = select`) список вариантов значений в формате `key-title`.
`title`	отображаемый в приложении заголовок параметра.
`help`	отображаемая в приложении многострочная подсказка, в виде списка строк.