@hubex/mcp 0.9.20260922 → 0.9.20260925

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,24 +9,20 @@
9
9
  },
10
10
  "version": "v1.0.0.0"
11
11
  },
12
+ "servers": [
13
+ {
14
+ "url": "/NEWS"
15
+ }
16
+ ],
12
17
  "paths": {
13
18
  "/Articles": {
14
19
  "get": {
15
20
  "tags": [
16
21
  "Articles"
17
22
  ],
18
- "summary": "Возвращает список доступных пользователю новостей.",
19
- "description": "<br />* Для выполнения данного метода требуется любое из перечисленных полномочий: **ArticleListForTenantMember**<br />* Метод поддерживает диапазонный запрос через строку или заголовок запроса.",
23
+ "summary": "Получение списка доступных пользователю новостей",
24
+ "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.",
20
25
  "parameters": [
21
- {
22
- "name": "Authorization",
23
- "in": "header",
24
- "description": "Bearer",
25
- "required": true,
26
- "schema": {
27
- "type": "string"
28
- }
29
- },
30
26
  {
31
27
  "name": "Range",
32
28
  "in": "header",
@@ -46,7 +42,7 @@
46
42
  {
47
43
  "name": "fetch",
48
44
  "in": "query",
49
- "description": "количество эементов, которое необходимо вернуть",
45
+ "description": "количество элементов, которое необходимо вернуть",
50
46
  "schema": {
51
47
  "type": "string"
52
48
  }
@@ -56,37 +52,53 @@
56
52
  "in": "query",
57
53
  "description": "Признак чтения статьи",
58
54
  "schema": {
59
- "enum": [
60
- "true",
61
- "false"
62
- ],
63
- "type": "boolean",
64
- "default": null
55
+ "type": "boolean"
65
56
  }
66
57
  },
67
58
  {
68
59
  "name": "isPublished",
69
60
  "in": "query",
70
61
  "description": "Признак публикации статьи",
62
+ "schema": {
63
+ "type": "boolean"
64
+ }
65
+ },
66
+ {
67
+ "name": "X-Application-ID",
68
+ "in": "header",
69
+ "description": "Идентификатор приложения. EngineerMobile - 1, CustomerMobile - 2, MainWeb - 3, AdminWeb - 4, Api - 5, PlateWeb - 6",
71
70
  "schema": {
72
71
  "enum": [
73
- "true",
74
- "false"
72
+ 1,
73
+ 2,
74
+ 3,
75
+ 4,
76
+ 5,
77
+ 6
75
78
  ],
76
- "type": "boolean",
77
- "default": null
79
+ "type": "integer",
80
+ "format": "int32",
81
+ "default": 3,
82
+ "x-enumNames": [
83
+ "EngineerMobile",
84
+ "CustomerMobile",
85
+ "MainWeb",
86
+ "AdminWeb",
87
+ "Api",
88
+ "PlateWeb"
89
+ ]
78
90
  }
79
91
  }
80
92
  ],
81
93
  "responses": {
82
94
  "200": {
83
- "description": "OK",
95
+ "description": "Полный список новостей.",
84
96
  "content": {
85
97
  "text/plain": {
86
98
  "schema": {
87
99
  "type": "object",
88
100
  "additionalProperties": {
89
- "$ref": "#/components/schemas/HubEx.Service.NEWS.Api.Results.Articles.ListResult"
101
+ "$ref": "#/components/schemas/ResultsArticlesListResult"
90
102
  }
91
103
  }
92
104
  },
@@ -94,7 +106,7 @@
94
106
  "schema": {
95
107
  "type": "object",
96
108
  "additionalProperties": {
97
- "$ref": "#/components/schemas/HubEx.Service.NEWS.Api.Results.Articles.ListResult"
109
+ "$ref": "#/components/schemas/ResultsArticlesListResult"
98
110
  }
99
111
  }
100
112
  },
@@ -102,55 +114,73 @@
102
114
  "schema": {
103
115
  "type": "object",
104
116
  "additionalProperties": {
105
- "$ref": "#/components/schemas/HubEx.Service.NEWS.Api.Results.Articles.ListResult"
117
+ "$ref": "#/components/schemas/ResultsArticlesListResult"
106
118
  }
107
119
  }
108
120
  }
109
121
  }
110
122
  },
123
+ "206": {
124
+ "description": "Частичный список новостей при использовании Range-заголовка."
125
+ },
126
+ "204": {
127
+ "description": "Новости не найдены."
128
+ },
111
129
  "401": {
112
- "description": "Unauthorized"
130
+ "description": "Отсутствует или некорректен Bearer-токен."
113
131
  },
114
132
  "403": {
115
- "description": "Forbidden"
116
- },
117
- "206": {
118
- "description": "PartialContent",
119
- "headers": {
120
- "Content-Range": {
121
- "description": "items=FROM-TILL/OF , где FROM - начальный элемент (включая), TILL - конечный элемент (включая) OF - общее количество элементов",
122
- "schema": {
123
- "type": "string"
124
- }
125
- }
126
- }
133
+ "description": "Недостаточно прав для просмотра новостей."
127
134
  }
128
- }
135
+ },
136
+ "security": [
137
+ {
138
+ "Bearer": [ ]
139
+ }
140
+ ]
129
141
  },
130
142
  "put": {
131
143
  "tags": [
132
144
  "Articles"
133
145
  ],
134
- "summary": "Помечет новость как прочитанную у текущего пользователя",
135
- "description": "<br />* Для выполнения данного метода требуется любое из перечисленных полномочий: **ArticleDeliveryMerge**",
146
+ "summary": "Отметка новостей как прочитанных",
147
+ "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: конфликт при сохранении данных доставки.",
136
148
  "parameters": [
137
149
  {
138
- "name": "Authorization",
150
+ "name": "X-Application-ID",
139
151
  "in": "header",
140
- "description": "Bearer",
141
- "required": true,
152
+ "description": "Идентификатор приложения. EngineerMobile - 1, CustomerMobile - 2, MainWeb - 3, AdminWeb - 4, Api - 5, PlateWeb - 6",
142
153
  "schema": {
143
- "type": "string"
154
+ "enum": [
155
+ 1,
156
+ 2,
157
+ 3,
158
+ 4,
159
+ 5,
160
+ 6
161
+ ],
162
+ "type": "integer",
163
+ "format": "int32",
164
+ "default": 3,
165
+ "x-enumNames": [
166
+ "EngineerMobile",
167
+ "CustomerMobile",
168
+ "MainWeb",
169
+ "AdminWeb",
170
+ "Api",
171
+ "PlateWeb"
172
+ ]
144
173
  }
145
174
  }
146
175
  ],
147
176
  "requestBody": {
177
+ "description": "Коллекция данных для отметки новостей как прочитанных.",
148
178
  "content": {
149
179
  "application/json-patch+json": {
150
180
  "schema": {
151
181
  "type": "array",
152
182
  "items": {
153
- "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
183
+ "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
154
184
  }
155
185
  }
156
186
  },
@@ -158,7 +188,7 @@
158
188
  "schema": {
159
189
  "type": "array",
160
190
  "items": {
161
- "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
191
+ "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
162
192
  }
163
193
  }
164
194
  },
@@ -166,7 +196,7 @@
166
196
  "schema": {
167
197
  "type": "array",
168
198
  "items": {
169
- "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
199
+ "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
170
200
  }
171
201
  }
172
202
  },
@@ -174,7 +204,7 @@
174
204
  "schema": {
175
205
  "type": "array",
176
206
  "items": {
177
- "$ref": "#/components/schemas/HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData"
207
+ "$ref": "#/components/schemas/DataNEWSMergeDeliveryData"
178
208
  }
179
209
  }
180
210
  }
@@ -182,16 +212,22 @@
182
212
  },
183
213
  "responses": {
184
214
  "202": {
185
- "description": "Accepted"
215
+ "description": "Данные приняты в обработку."
216
+ },
217
+ "401": {
218
+ "description": "Отсутствует или некорректен Bearer-токен."
219
+ },
220
+ "403": {
221
+ "description": "Недостаточно прав для изменения статуса прочтения."
186
222
  },
187
223
  "409": {
188
- "description": "Conflict",
224
+ "description": "Конфликт при сохранении данных.",
189
225
  "content": {
190
226
  "text/plain": {
191
227
  "schema": {
192
228
  "type": "array",
193
229
  "items": {
194
- "$ref": "#/components/schemas/SmartService.Common.ExceptionHandling.Models.ErrorModel"
230
+ "$ref": "#/components/schemas/ExceptionHandlingModelsErrorModel"
195
231
  }
196
232
  }
197
233
  },
@@ -199,7 +235,7 @@
199
235
  "schema": {
200
236
  "type": "array",
201
237
  "items": {
202
- "$ref": "#/components/schemas/SmartService.Common.ExceptionHandling.Models.ErrorModel"
238
+ "$ref": "#/components/schemas/ExceptionHandlingModelsErrorModel"
203
239
  }
204
240
  }
205
241
  },
@@ -207,25 +243,24 @@
207
243
  "schema": {
208
244
  "type": "array",
209
245
  "items": {
210
- "$ref": "#/components/schemas/SmartService.Common.ExceptionHandling.Models.ErrorModel"
246
+ "$ref": "#/components/schemas/ExceptionHandlingModelsErrorModel"
211
247
  }
212
248
  }
213
249
  }
214
250
  }
215
- },
216
- "401": {
217
- "description": "Unauthorized"
218
- },
219
- "403": {
220
- "description": "Forbidden"
221
251
  }
222
- }
252
+ },
253
+ "security": [
254
+ {
255
+ "Bearer": [ ]
256
+ }
257
+ ]
223
258
  }
224
259
  }
225
260
  },
226
261
  "components": {
227
262
  "schemas": {
228
- "HubEx.DataProvider.Api.Data.NEWS.MergeDeliveryData": {
263
+ "DataNEWSMergeDeliveryData": {
229
264
  "required": [
230
265
  "articleID"
231
266
  ],
@@ -238,58 +273,76 @@
238
273
  },
239
274
  "additionalProperties": false
240
275
  },
241
- "HubEx.Service.NEWS.Api.Results.Articles.ListResult": {
276
+ "ExceptionHandlingModelsErrorModel": {
242
277
  "type": "object",
243
278
  "properties": {
244
- "id": {
245
- "type": "integer",
246
- "format": "int32"
247
- },
248
- "title": {
279
+ "traceIdentifier": {
249
280
  "type": "string",
250
- "description": "Заголовок новости",
251
281
  "nullable": true
252
282
  },
253
- "text": {
283
+ "code": {
254
284
  "type": "string",
255
- "description": "Содержание новости, разметка",
256
285
  "nullable": true
257
286
  },
258
- "footer": {
287
+ "message": {
259
288
  "type": "string",
260
- "description": "Нижний колонтитул новости",
289
+ "nullable": true
290
+ },
291
+ "arguments": {
292
+ "type": "object",
293
+ "additionalProperties": {
294
+ "type": "string",
295
+ "nullable": true
296
+ },
261
297
  "nullable": true
262
298
  }
263
299
  },
264
- "additionalProperties": false,
265
- "description": "Список новостей"
300
+ "additionalProperties": false
266
301
  },
267
- "SmartService.Common.ExceptionHandling.Models.ErrorModel": {
302
+ "ResultsArticlesListResult": {
268
303
  "type": "object",
269
304
  "properties": {
270
- "traceIdentifier": {
271
- "type": "string",
272
- "nullable": true
305
+ "id": {
306
+ "type": "integer",
307
+ "format": "int32"
273
308
  },
274
- "code": {
309
+ "title": {
275
310
  "type": "string",
311
+ "description": "Заголовок новости",
276
312
  "nullable": true
277
313
  },
278
- "message": {
314
+ "text": {
279
315
  "type": "string",
316
+ "description": "Содержание новости, разметка",
280
317
  "nullable": true
281
318
  },
282
- "arguments": {
283
- "type": "object",
284
- "additionalProperties": {
285
- "type": "string",
286
- "nullable": true
287
- },
319
+ "footer": {
320
+ "type": "string",
321
+ "description": "Нижний колонтитул новости",
288
322
  "nullable": true
289
323
  }
290
324
  },
291
- "additionalProperties": false
325
+ "additionalProperties": false,
326
+ "description": "Список новостей"
292
327
  }
328
+ },
329
+ "securitySchemes": {
330
+ "Bearer": {
331
+ "type": "http",
332
+ "description": "Введите токен для авторизации",
333
+ "scheme": "Bearer",
334
+ "bearerFormat": "JWT"
335
+ }
336
+ }
337
+ },
338
+ "tags": [
339
+ {
340
+ "name": "Articles",
341
+ "description": "Контроллер управления новостями"
342
+ },
343
+ {
344
+ "name": "Articles",
345
+ "description": "Контроллер управления новостями"
293
346
  }
294
- }
347
+ ]
295
348
  }