@hubex/mcp 0.2.0

package/swagger/prod/NEWS.json

@@ -0,0 +1,295 @@
+{
+  "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"
+  },
+  "paths": {
+    "/Articles": {
+      "get": {
+        "tags": [
+          "Articles"
+        ],
+        "summary": "Возвращает список доступных пользователю новостей.",
+        "description": "<br />* Для выполнения данного метода требуется любое из перечисленных полномочий: **ArticleListForTenantMember**<br />* Метод поддерживает диапазонный запрос через строку или заголовок запроса.",
+        "parameters": [
+          {
+            "name": "Authorization",
+            "in": "header",
+            "description": "Bearer",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "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": {
+              "enum": [
+                "true",
+                "false"
+              ],
+              "type": "boolean",
+              "default": null
+            }
+          },
+          {
+            "name": "isPublished",
+            "in": "query",
+            "description": "Признак публикации статьи",
+            "schema": {
+              "enum": [
+                "true",
+                "false"
+              ],
+              "type": "boolean",
+              "default": null
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "#/components/schemas/HubEx.Service.NEWS.Api.Results.Articles.ListResult"
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "#/components/schemas/HubEx.Service.NEWS.Api.Results.Articles.ListResult"
+                  }
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "#/components/schemas/HubEx.Service.NEWS.Api.Results.Articles.ListResult"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "206": {
+            "description": "PartialContent",
+            "headers": {
+              "Content-Range": {
+                "description": "items=FROM-TILL/OF , где FROM - начальный элемент (включая), TILL - конечный элемент (включая) OF - общее количество элементов",
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "put": {
+        "tags": [
+          "Articles"
+        ],
+        "summary": "Помечет новость как прочитанную у текущего пользователя",
+        "description": "<br />* Для выполнения данного метода требуется любое из перечисленных полномочий: **ArticleDeliveryMerge**",
+        "parameters": [
+          {
+            "name": "Authorization",
+            "in": "header",
+            "description": "Bearer",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json-patch+json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
+                }
+              }
+            },
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
+                }
+              }
+            },
+            "text/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
+                }
+              }
+            },
+            "application/*+json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "202": {
+            "description": "Accepted"
+          },
+          "409": {
+            "description": "Conflict",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/SmartService.Common.ExceptionHandling.Models.ErrorModel"
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/SmartService.Common.ExceptionHandling.Models.ErrorModel"
+                  }
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/SmartService.Common.ExceptionHandling.Models.ErrorModel"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData": {
+        "required": [
+          "articleID"
+        ],
+        "type": "object",
+        "properties": {
+          "articleID": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "additionalProperties": false
+      },
+      "HubEx.Service.NEWS.Api.Results.Articles.ListResult": {
+        "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": "Список новостей"
+      },
+      "SmartService.Common.ExceptionHandling.Models.ErrorModel": {
+        "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
+      }
+    }
+  }
+}