@hubex/mcp 0.2.0

package/swagger/dev/PROXY.json

@@ -0,0 +1,416 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API for remote calling 3rd party services.",
+    "description": "Proxy service offers methods for calling 3rd party services that assumes authorization via tokens that cannot be safety saved in frontend applications.",
+    "contact": {
+      "name": "SmartService Backend Team",
+      "email": "fmbackend@melston.ru"
+    },
+    "version": "v1.0.0.0"
+  },
+  "servers": [
+    {
+      "url": "/PROXY"
+    }
+  ],
+  "paths": {
+    "/Bypass": {
+      "post": {
+        "tags": [
+          "Bypass"
+        ],
+        "summary": "Прокидывает запрос на заданный в теле адрес, применяя к нему дополнительные заголовки по имени домена",
+        "description": "## Пример запроса:\r\n`POST /Bypass`\r\n            \r\n```json\r\n{\r\n  \"url\": \"https://api.example.com/v1/items\",\r\n  \"method\": \"POST\",\r\n  \"headers\": [\r\n    { \"key\": \"Content-Type\", \"value\": \"application/json\" },\r\n    { \"key\": \"Authorization\", \"value\": \"Bearer <token>\" }\r\n  ],\r\n  \"body\": \"eyJuYW1lIjoiZGVtbyJ9\"\r\n}\r\n```\r\n            \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n  \"headers\": {\r\n    \"content-type\": [\"application/json; charset=utf-8\"]\r\n  },\r\n  \"content\": \"eyJpZCI6MTIzfQ==\",\r\n  \"statusCode\": 200\r\n}\r\n```\r\nПоле `content` содержит тело ответа, закодированное в Base64.\r\n            \r\n## Негативные сценарии:\r\n- 400 BadRequest: некорректные входные данные, неподдерживаемый метод, отсутствует Content-Type при передаче тела запроса или ошибка выполнения внешнего запроса.\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"
+              ]
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "Данные проксируемого HTTP-запроса.",
+          "content": {
+            "application/json-patch+json": {
+              "schema": {
+                "$ref": "#/components/schemas/PostData"
+              }
+            },
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PostData"
+              }
+            },
+            "text/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PostData"
+              }
+            },
+            "application/*+json": {
+              "schema": {
+                "$ref": "#/components/schemas/PostData"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Ответ внешнего сервиса успешно получен и возвращён клиенту.",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/PostResult"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PostResult"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PostResult"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Некорректные входные данные или ошибка выполнения внешнего запроса."
+          },
+          "401": {
+            "description": "Отсутствует или некорректен Bearer-токен."
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        },
+        "security": [
+          {
+            "Bearer": [ ]
+          }
+        ]
+      }
+    },
+    "/NavigateTo/{appCode}": {
+      "get": {
+        "tags": [
+          "NavigateTo"
+        ],
+        "summary": "Возвращает ссылку на указанное приложение или расширение с одноразовым токеном для авторизации",
+        "description": "## Пример запроса:\r\n`GET /NavigateTo/MainWeb?deepLink=/tasks/123`\r\n            \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n  \"url\": \"https://app.hubex.ru/tenant-name/tasks/123?oneTimeLoginToken=abc123&tenantID=1&tenantUrlName=tenant-name\"\r\n}\r\n```\r\n            \r\n## Негативные сценарии:\r\n- 400 BadRequest: указан неизвестный `appCode` или некорректный `deepLink`.\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.",
+        "parameters": [
+          {
+            "name": "appCode",
+            "in": "path",
+            "description": "Код приложения HubEx: MainWeb, AdminApp или идентификатор пакета в формате packageID:version.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "deepLink",
+            "in": "query",
+            "description": "Относительная ссылка для перехода в приложении, добавляется к базовому URL.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "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/GetResult"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetResult"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetResult"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Неизвестный код приложения или некорректная ссылка для перехода."
+          },
+          "401": {
+            "description": "Отсутствует или некорректен Bearer-токен."
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        },
+        "security": [
+          {
+            "Bearer": [ ]
+          }
+        ]
+      }
+    },
+    "/TaskTemplates/{codeDynamicPart}": {
+      "get": {
+        "tags": [
+          "TaskTemplates"
+        ],
+        "summary": "Перенаправляет запрос на электронный паспорт оборудования",
+        "description": "## Пример запроса:\r\n`GET /TaskTemplates/abc123`\r\n            \r\nЗаголовки:\r\n- Referer: https://example.com/tasktemplates/abc123\r\n            \r\n## Пример успешного ответа (307):\r\nHTTP 307 Temporary Redirect\r\n            \r\nЗаголовок ответа:\r\n- Location: https://plate.hubex.ru/assets/<taskTemplateID>\r\n            \r\n## Негативные сценарии:\r\n- 400 BadRequest: не указана динамическая часть кода, заголовок Referer отсутствует или не совпадает с `codeDynamicPart`.\r\n- 500 InternalServerError: либо не настроен URL сервиса паспортов.",
+        "parameters": [
+          {
+            "name": "codeDynamicPart",
+            "in": "path",
+            "description": "Динамическая часть кода шаблона заявки.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "referer",
+            "in": "header",
+            "description": "URL исходного запроса, передаётся в заголовке Referer.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "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": {
+          "307": {
+            "description": "Редирект на URL электронного паспорта оборудования."
+          },
+          "400": {
+            "description": "Некорректные входные данные."
+          },
+          "500": {
+            "description": "Ошибка конфигурации сервиса паспортов."
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "GetResult": {
+        "type": "object",
+        "properties": {
+          "url": {
+            "type": "string",
+            "description": "Полная ссылка для перехода в целевое приложение с параметрами авторизации",
+            "nullable": true,
+            "example": "https://app.hubex.ru/tenant-name/tasks/123?oneTimeLoginToken=abc123&tenantID=1&tenantUrlName=tenant-name"
+          }
+        },
+        "additionalProperties": false,
+        "description": "Результат формирования ссылки для перехода в приложение"
+      },
+      "KeyValuePairOfStringAndString": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "nullable": true
+          },
+          "value": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
+      "PostData": {
+        "required": [
+          "method",
+          "url"
+        ],
+        "type": "object",
+        "properties": {
+          "url": {
+            "minLength": 1,
+            "type": "string",
+            "description": "Адрес, на который будет отправлен запрос",
+            "example": "https://api.example.com/v1/items"
+          },
+          "method": {
+            "minLength": 1,
+            "type": "string",
+            "description": "HTTP-метод отправляемого запроса",
+            "example": "POST"
+          },
+          "headers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/KeyValuePairOfStringAndString"
+            },
+            "description": "Передаваемые заголовки запроса",
+            "nullable": true,
+            "example": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ]
+          },
+          "body": {
+            "type": "string",
+            "description": "Тело запроса, закодированное в Base64",
+            "nullable": true,
+            "example": "eyJuYW1lIjoiZGVtbyJ9"
+          }
+        },
+        "additionalProperties": false,
+        "description": "Данные проксируемого HTTP-запроса"
+      },
+      "PostResult": {
+        "type": "object",
+        "properties": {
+          "headers": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "nullable": true
+            },
+            "description": "Заголовки ответа внешнего сервиса",
+            "nullable": true,
+            "example": {
+              "content-type": [
+                "application/json; charset=utf-8"
+              ]
+            }
+          },
+          "content": {
+            "type": "string",
+            "description": "Тело ответа, закодированное в Base64",
+            "nullable": true,
+            "example": "eyJpZCI6MTIzfQ=="
+          },
+          "statusCode": {
+            "type": "integer",
+            "description": "HTTP-статус ответа внешнего сервиса",
+            "format": "int32",
+            "example": 200
+          }
+        },
+        "additionalProperties": false,
+        "description": "Результат выполнения проксируемого HTTP-запроса"
+      }
+    },
+    "securitySchemes": {
+      "Bearer": {
+        "type": "http",
+        "description": "Введите токен для авторизации",
+        "scheme": "Bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Bypass",
+      "description": "Контроллер прокидывает запросы через бэк для добавления к ним авторизационных данных и секретов"
+    },
+    {
+      "name": "NavigateTo",
+      "description": "Контроллер навигации между приложениями системы"
+    },
+    {
+      "name": "TaskTemplates",
+      "description": "Контроллер обработки ссылок и редиректа клиента на сервис FDL"
+    },
+    {
+      "name": "Bypass",
+      "description": "Контроллер прокидывает запросы через бэк для добавления к ним авторизационных данных и секретов"
+    },
+    {
+      "name": "NavigateTo",
+      "description": "Контроллер навигации между приложениями системы"
+    },
+    {
+      "name": "TaskTemplates",
+      "description": "Контроллер обработки ссылок и редиректа клиента на сервис FDL"
+    }
+  ]
+}