@hubex/mcp 0.2.0

package/swagger/dev/NEWS.json

@@ -0,0 +1,348 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API for managing news and advertisements in HubEx",
+    "description": "Service offers various methods for managing news and advertisements",
+    "contact": {
+      "name": "SmartService Backend Team",
+      "email": "fmbackend@melston.ru"
+    },
+    "version": "v1.0.0.0"
+  },
+  "servers": [
+    {
+      "url": "/NEWS"
+    }
+  ],
+  "paths": {
+    "/Articles": {
+      "get": {
+        "tags": [
+          "Articles"
+        ],
+        "summary": "Получение списка доступных пользователю новостей",
+        "description": "## Пример запроса:\r\n`GET /Articles?isRead=false&isPublished=true`\r\n            \r\n## Пример успешного ответа (200):\r\n```json\r\n{\r\n  \"1\": {\r\n    \"id\": 1,\r\n    \"title\": \"Обновление системы\",\r\n    \"text\": \"Текст новости\",\r\n    \"footer\": \"Команда HubEx\"\r\n  }\r\n}\r\n```\r\n## Негативные сценарии:\r\n- 204 NoContent: новости не найдены.\r\n- 206 PartialContent: частичный ответ при использовании Range-заголовка.\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав ArticleListForTenantMember.",
+        "parameters": [
+          {
+            "name": "Range",
+            "in": "header",
+            "description": "Формат: items=FROM-TILL , где FROM - начальный элемент (включая), TILL - конечный элемент (включая)",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "offset",
+            "in": "query",
+            "description": "количество элементов, которое нобходимо пропустить",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "fetch",
+            "in": "query",
+            "description": "количество элементов, которое необходимо вернуть",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "isRead",
+            "in": "query",
+            "description": "Признак чтения статьи",
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "name": "isPublished",
+            "in": "query",
+            "description": "Признак публикации статьи",
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "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": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "#/components/schemas/ResultsArticlesListResult"
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "#/components/schemas/ResultsArticlesListResult"
+                  }
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "#/components/schemas/ResultsArticlesListResult"
+                  }
+                }
+              }
+            }
+          },
+          "206": {
+            "description": "Частичный список новостей при использовании Range-заголовка."
+          },
+          "204": {
+            "description": "Новости не найдены."
+          },
+          "401": {
+            "description": "Отсутствует или некорректен Bearer-токен."
+          },
+          "403": {
+            "description": "Недостаточно прав для просмотра новостей."
+          }
+        },
+        "security": [
+          {
+            "Bearer": [ ]
+          }
+        ]
+      },
+      "put": {
+        "tags": [
+          "Articles"
+        ],
+        "summary": "Отметка новостей как прочитанных",
+        "description": "## Пример запроса:\r\n`PUT /Articles`\r\n            \r\n```json\r\n[\r\n  {\r\n    \"articleID\": 1,\r\n    \"isRead\": true\r\n  }\r\n]\r\n```\r\n## Пример успешного ответа (202):\r\nТело ответа отсутствует.\r\n## Негативные сценарии:\r\n- 401 Unauthorized: отсутствует или некорректен Bearer-токен.\r\n- 403 Forbidden: недостаточно прав ArticleDeliveryMerge.\r\n- 409 Conflict: конфликт при сохранении данных доставки.",
+        "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": "Коллекция данных для отметки новостей как прочитанных.",
+          "content": {
+            "application/json-patch+json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
+                }
+              }
+            },
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
+                }
+              }
+            },
+            "text/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
+                }
+              }
+            },
+            "application/*+json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "202": {
+            "description": "Данные приняты в обработку."
+          },
+          "401": {
+            "description": "Отсутствует или некорректен Bearer-токен."
+          },
+          "403": {
+            "description": "Недостаточно прав для изменения статуса прочтения."
+          },
+          "409": {
+            "description": "Конфликт при сохранении данных.",
+            "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"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "Bearer": [ ]
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "DataNEWSMergeDeliveryData": {
+        "required": [
+          "articleID"
+        ],
+        "type": "object",
+        "properties": {
+          "articleID": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "additionalProperties": false
+      },
+      "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
+      },
+      "ResultsArticlesListResult": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "title": {
+            "type": "string",
+            "description": "Заголовок новости",
+            "nullable": true
+          },
+          "text": {
+            "type": "string",
+            "description": "Содержание новости, разметка",
+            "nullable": true
+          },
+          "footer": {
+            "type": "string",
+            "description": "Нижний колонтитул новости",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "Список новостей"
+      }
+    },
+    "securitySchemes": {
+      "Bearer": {
+        "type": "http",
+        "description": "Введите токен для авторизации",
+        "scheme": "Bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Articles",
+      "description": "Контроллер управления новостями"
+    },
+    {
+      "name": "Articles",
+      "description": "Контроллер управления новостями"
+    }
+  ]
+}