@hubex/mcp 0.9.20260922 → 0.9.20260925

package/swagger/prod/CM.json

@@ -2,29 +2,80 @@
   "openapi": "3.0.1",
   "info": {
     "title": "API for CM in HubEx",
-    "description": "Service offers application programming interface for ....",
+    "description": "Service offers application programming interface for client mobile geolocation and tracking data.",
     "contact": {
       "name": "SmartService Backend Team",
       "email": "fmbackend@melston.ru"
     },
     "version": "v1.0.0.0"
   },
+  "servers": [
+    {
+      "url": "/CM"
+    }
+  ],
   "paths": {
     "/Clients/locations": {
       "post": {
         "tags": [
           "Clients"
         ],
-        "summary": "Сохраняет данные о местоположении",
-        "description": "<br />* Выполнение данного метода резрешино от **анонимного пользователя**.",
+        "summary": "Сохранение данных о местоположении клиента",
+        "description": "## Пример запроса:\r\n`POST /Clients/locations`\r\n            \r\nЗаголовки:\r\n- `X-CLIENT-IDENTIFIER` — уникальный идентификатор клиента (устройства), обязателен.\r\n- `X-Client-Utc-Offset` — смещение часового пояса клиента в минутах от UTC, необязателен (по умолчанию `0`).\r\n- `X-Application-ID` — идентификатор приложения-источника запроса (enum 1..6), необязателен.\r\n            \r\n```json\r\n[\r\n  {\r\n    \"coordinate\": \"55.75:37.62\",\r\n    \"clientTimestamp\": \"2026-08-17T08:30:00Z\",\r\n    \"altitude\": 150.5,\r\n    \"bearing\": 90.0,\r\n    \"accuracy\": 10.0,\r\n    \"speed\": 5.2\r\n  }\r\n]\r\n```\r\n            \r\nАльтернативный формат координат через объект `coords`:\r\n```json\r\n[\r\n  {\r\n    \"coords\": {\r\n      \"latitude\": 55.75,\r\n      \"longitude\": 37.62,\r\n      \"altitude\": 150.5,\r\n      \"accuracy\": 10.0,\r\n      \"speed\": 5.2,\r\n      \"bearing\": 90.0\r\n    },\r\n    \"timestamp\": \"2026-08-17T08:30:00Z\"\r\n  }\r\n]\r\n```\r\n            \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n  \"clientId\": \"device-uuid-12345\",\r\n  \"clientOffset\": 180\r\n}\r\n```\r\n            \r\n## Негативные сценарии:\r\n- 404 Not Found: не передан обязательный заголовок `X-CLIENT-IDENTIFIER`.\r\n- 409 Conflict: пустое или отсутствующее тело запроса.\r\n- 409 Conflict: отсутствуют или некорректны координаты (`coordinate` / `coords`).\r\n- 409 Conflict: `clientTimestamp` раньше 2018-10-01.",
+        "parameters": [
+          {
+            "name": "X-CLIENT-IDENTIFIER",
+            "in": "header",
+            "description": "Уникальный идентификатор клиента (устройства)",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Client-Utc-Offset",
+            "in": "header",
+            "description": "Смещение часового пояса клиента в минутах от UTC",
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          },
+          {
+            "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": "Геоданные",
+          "description": "Коллекция геоданных для сохранения.",
           "content": {
             "application/json-patch+json": {
               "schema": {
                 "type": "array",
                 "items": {
-                  "$ref": "#/components/schemas/HubEx.Service.CM.Api.Data.Clients.PostData"
+                  "$ref": "#/components/schemas/DataClientsPostData"
                 }
               }
             },
@@ -32,7 +83,7 @@
               "schema": {
                 "type": "array",
                 "items": {
-                  "$ref": "#/components/schemas/HubEx.Service.CM.Api.Data.Clients.PostData"
+                  "$ref": "#/components/schemas/DataClientsPostData"
                 }
               }
             },
@@ -40,7 +91,7 @@
               "schema": {
                 "type": "array",
                 "items": {
-                  "$ref": "#/components/schemas/HubEx.Service.CM.Api.Data.Clients.PostData"
+                  "$ref": "#/components/schemas/DataClientsPostData"
                 }
               }
             },
@@ -48,7 +99,7 @@
               "schema": {
                 "type": "array",
                 "items": {
-                  "$ref": "#/components/schemas/HubEx.Service.CM.Api.Data.Clients.PostData"
+                  "$ref": "#/components/schemas/DataClientsPostData"
                 }
               }
             }
@@ -56,10 +107,56 @@
         },
         "responses": {
           "200": {
-            "description": "OK"
+            "description": "Геоданные успешно сохранены.",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/ResultsClientsLocationPostResult"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ResultsClientsLocationPostResult"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ResultsClientsLocationPostResult"
+                }
+              }
+            }
           },
           "404": {
-            "description": "Not Found"
+            "description": "Не передан обязательный заголовок X-CLIENT-IDENTIFIER."
+          },
+          "409": {
+            "description": "Ошибка валидации входных данных. Тело ошибки: SmartService.Common.ExceptionHandling.Models.ErrorModel[].",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ExceptionHandlingModelsErrorModel"
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ExceptionHandlingModelsErrorModel"
+                  }
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ExceptionHandlingModelsErrorModel"
+                  }
+                }
+              }
+            }
           }
         }
       }
@@ -67,96 +164,164 @@
   },
   "components": {
     "schemas": {
-      "HubEx.Service.CM.Api.Data.Clients.CoordinateData": {
+      "DataClientsCoordinateData": {
         "type": "object",
         "properties": {
           "altitude": {
             "type": "number",
-            "description": "Высота",
+            "description": "Высота над уровнем моря, метры",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 150.5
           },
           "bearing": {
             "type": "number",
-            "description": "Азимут",
+            "description": "Азимут (направление движения), градусы",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 90
           },
           "accuracy": {
             "type": "number",
-            "description": "Точность",
+            "description": "Точность определения координат, метры",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 10
           },
           "speed": {
             "type": "number",
-            "description": "Скорость",
+            "description": "Скорость движения, м/с",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 5.2
           },
           "latitude": {
             "type": "number",
             "description": "Широта",
-            "format": "double"
+            "format": "double",
+            "example": 55.75
           },
           "longitude": {
             "type": "number",
             "description": "Долгота",
-            "format": "double"
+            "format": "double",
+            "example": 37.62
           }
         },
         "additionalProperties": false,
-        "description": "Гео данные"
+        "description": "Координаты и дополнительные параметры местоположения"
       },
-      "HubEx.Service.CM.Api.Data.Clients.PostData": {
+      "DataClientsPostData": {
         "type": "object",
         "properties": {
           "coordinate": {
             "type": "string",
             "description": "Координаты в формате \"широта:долгота\"",
-            "nullable": true
+            "nullable": true,
+            "example": "55.75:37.62"
           },
           "clientTimestamp": {
             "type": "string",
-            "description": "Дата события UTC",
-            "format": "date-time"
+            "description": "Дата и время события в UTC",
+            "format": "date-time",
+            "example": "2026-08-17T08:30:00Z"
           },
           "timestamp": {
             "type": "string",
-            "description": "Дата события UTC",
-            "format": "date-time"
+            "description": "Дата и время события в UTC (альтернативное поле, используется если не задано ClientTimestamp)",
+            "format": "date-time",
+            "example": "2026-08-17T08:30:00Z"
           },
           "altitude": {
             "type": "number",
-            "description": "Высота",
+            "description": "Высота над уровнем моря, метры",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 150.5
           },
           "bearing": {
             "type": "number",
-            "description": "Азимут",
+            "description": "Азимут (направление движения), градусы",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 90
           },
           "accuracy": {
             "type": "number",
-            "description": "Точность",
+            "description": "Точность определения координат, метры",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 10
           },
           "speed": {
             "type": "number",
-            "description": "Скорость",
+            "description": "Скорость движения, м/с",
             "format": "float",
-            "nullable": true
+            "nullable": true,
+            "example": 5.2
           },
           "coords": {
-            "$ref": "#/components/schemas/HubEx.Service.CM.Api.Data.Clients.CoordinateData"
+            "$ref": "#/components/schemas/DataClientsCoordinateData"
           }
         },
         "additionalProperties": false,
-        "description": "Гео данные"
+        "description": "Геоданные точки местоположения клиента"
+      },
+      "ExceptionHandlingModelsErrorModel": {
+        "type": "object",
+        "properties": {
+          "traceIdentifier": {
+            "type": "string",
+            "nullable": true
+          },
+          "code": {
+            "type": "string",
+            "nullable": true
+          },
+          "message": {
+            "type": "string",
+            "nullable": true
+          },
+          "arguments": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "nullable": true
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
+      "ResultsClientsLocationPostResult": {
+        "type": "object",
+        "properties": {
+          "clientId": {
+            "type": "string",
+            "description": "Уникальный идентификатор клиента (устройства)",
+            "nullable": true,
+            "example": "device-uuid-12345"
+          },
+          "clientOffset": {
+            "type": "integer",
+            "description": "Смещение часового пояса клиента в минутах от UTC",
+            "format": "int32",
+            "example": 180
+          }
+        },
+        "additionalProperties": false,
+        "description": "Результат сохранения геоданных клиента"
       }
     }
-  }
+  },
+  "tags": [
+    {
+      "name": "Clients",
+      "description": "Контроллер работы с API-клиентами (устройствами)"
+    },
+    {
+      "name": "Clients",
+      "description": "Контроллер работы с API-клиентами (устройствами)"
+    }
+  ]
 }