@hubex/mcp 0.2.0

package/swagger/dev/LIC.json

@@ -0,0 +1,224 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API for LIC in HubEx",
+    "description": "Service offers application programming interface for work with licenses.",
+    "contact": {
+      "name": "SmartService Development Team",
+      "email": "fmbackend@melston.ru"
+    },
+    "version": "v1.0.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://dev-api.hubex.ru/fsm/LIC"
+    }
+  ],
+  "paths": {
+    "/LicenseScanner/State": {
+      "get": {
+        "tags": [
+          "LicenseScanner"
+        ],
+        "summary": "Получение состояния сервиса мониторинга лицензий",
+        "description": "## Пример запроса:\r\n`GET /LicenseScanner/State`\r\n            \r\n## Пример успешного ответа (200):\r\n```json\r\n1\r\n```\r\nВозможные значения HubEx.Actor.LIC.Watcher.Interfaces.WatcherStateEnum:\r\n- `0` (`Stopped`) — сервис мониторинга не работает. Это же значение возвращается, если актор недоступен.\r\n- `1` (`Started`) — сервис мониторинга запущен.\r\n            \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.",
+        "parameters": [
+          {
+            "name": "X-Application-ID",
+            "in": "header",
+            "description": "Идентификатор приложения. EngineerMobile - 1, CustomerMobile - 2, MainWeb - 3, AdminWeb - 4, Api - 5, PlateWeb - 6",
+            "schema": {
+              "enum": [
+                1,
+                2,
+                3,
+                4,
+                5,
+                6
+              ],
+              "type": "integer",
+              "format": "int32",
+              "default": 3,
+              "x-enumNames": [
+                "EngineerMobile",
+                "CustomerMobile",
+                "MainWeb",
+                "AdminWeb",
+                "Api",
+                "PlateWeb"
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Текущее состояние сервиса мониторинга лицензий.",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/WatcherStateEnum"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/WatcherStateEnum"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/WatcherStateEnum"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Отсутствует или некорректен Bearer-токен."
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        },
+        "security": [
+          {
+            "Bearer": [ ]
+          }
+        ]
+      }
+    },
+    "/LicenseScanner/Start": {
+      "post": {
+        "tags": [
+          "LicenseScanner"
+        ],
+        "summary": "Запуск сервиса периодического мониторинга лицензий",
+        "description": "## Пример запроса:\r\n`POST /LicenseScanner/Start`\r\n            \r\nТело запроса отсутствует.\r\n            \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует. Запрос на запуск мониторинга принят в обработку.\r\nПовторный вызов при уже запущенном сервисе не приводит к ошибке.\r\n            \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `LicenseServiceMonitorManagement`.",
+        "parameters": [
+          {
+            "name": "X-Application-ID",
+            "in": "header",
+            "description": "Идентификатор приложения. EngineerMobile - 1, CustomerMobile - 2, MainWeb - 3, AdminWeb - 4, Api - 5, PlateWeb - 6",
+            "schema": {
+              "enum": [
+                1,
+                2,
+                3,
+                4,
+                5,
+                6
+              ],
+              "type": "integer",
+              "format": "int32",
+              "default": 3,
+              "x-enumNames": [
+                "EngineerMobile",
+                "CustomerMobile",
+                "MainWeb",
+                "AdminWeb",
+                "Api",
+                "PlateWeb"
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "202": {
+            "description": "Запрос на запуск сервиса мониторинга принят в обработку."
+          },
+          "401": {
+            "description": "Отсутствует или некорректен Bearer-токен."
+          },
+          "403": {
+            "description": "Недостаточно прав для управления сервисом мониторинга лицензий."
+          }
+        },
+        "security": [
+          {
+            "Bearer": [ ]
+          }
+        ]
+      }
+    },
+    "/LicenseScanner/Stop": {
+      "post": {
+        "tags": [
+          "LicenseScanner"
+        ],
+        "summary": "Остановка сервиса периодического мониторинга лицензий",
+        "description": "## Пример запроса:\r\n`POST /LicenseScanner/Stop`\r\n            \r\nТело запроса отсутствует.\r\n            \r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует. Запрос на остановку мониторинга принят в обработку.\r\nПовторный вызов при уже остановленном сервисе не приводит к ошибке.\r\n            \r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав `LicenseServiceMonitorManagement`.",
+        "parameters": [
+          {
+            "name": "X-Application-ID",
+            "in": "header",
+            "description": "Идентификатор приложения. EngineerMobile - 1, CustomerMobile - 2, MainWeb - 3, AdminWeb - 4, Api - 5, PlateWeb - 6",
+            "schema": {
+              "enum": [
+                1,
+                2,
+                3,
+                4,
+                5,
+                6
+              ],
+              "type": "integer",
+              "format": "int32",
+              "default": 3,
+              "x-enumNames": [
+                "EngineerMobile",
+                "CustomerMobile",
+                "MainWeb",
+                "AdminWeb",
+                "Api",
+                "PlateWeb"
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "202": {
+            "description": "Запрос на остановку сервиса мониторинга принят в обработку."
+          },
+          "401": {
+            "description": "Отсутствует или некорректен Bearer-токен."
+          },
+          "403": {
+            "description": "Недостаточно прав для управления сервисом мониторинга лицензий."
+          }
+        },
+        "security": [
+          {
+            "Bearer": [ ]
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "WatcherStateEnum": {
+        "enum": [
+          "Stopped",
+          "Started"
+        ],
+        "type": "string"
+      }
+    },
+    "securitySchemes": {
+      "Bearer": {
+        "type": "http",
+        "description": "Введите токен для авторизации",
+        "scheme": "Bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "LicenseScanner",
+      "description": "Контроллер управления сервисом периодической проверки статуса лицензий"
+    },
+    {
+      "name": "LicenseScanner",
+      "description": "Контроллер управления сервисом периодической проверки статуса лицензий"
+    }
+  ]
+}