H-3729: GET /system-notifications/active

Co-Authored-By: Claude Opus 5.5 (1M context)

v2/swagger.yaml

@@ -79,12 +79,8 @@ tags:
     description: Methods for admin oversight of personal API tokens. Requires "api-tokens-admin" permission.
   - name: admin-employment
     description: Methods for administrative read-only access to employee employments, including external identifiers used by integrations. Requires "user-edit" permission.
-  - name: library
+  - name: system-notifications
-    description: Корпоративная библиотека (книги). Требуется право `book-access`.
+    description: Methods for reading active HRBox system announcements (home page banner for portal administrators). Requires "admin-controls" permission.
-  - name: admin-library-category
-    description: |
-      Редактор каталога библиотеки: дерево категорий и книг (H-1267). Требуется
-      право `book-manager`.
 
 paths:
   /mobile/bind/{id}/{token}:
@@ -8270,311 +8266,62 @@ paths:
             Запись не найдена. Включает случаи обращения к записям,
             принадлежащим другим тенантам.
 
-
+  /system-notifications/active:
-  /library/catalog:
     get:
-      tags: [library]
+      tags: [system-notifications]
-      summary: Каталог библиотеки (категории и книги)
+      summary: Получить активные системные объявления
       description: |
-        Клиентский каталог библиотеки (H-1267). Контракт идентичен /article/category:
+        Возвращает постраничный список активных системных объявлений HRBox
-        без параметров — корень каталога, с id/hash_id — содержимое категории.
+        (по умолчанию 20 на страницу, максимум 50). По умолчанию сортировка
-        Видимость категорий и книг по группам пользователей применяется автоматически.
+        по дате публикации, сначала новые. Используется для баннера
-      operationId: libraryCatalog
+        на главной странице портала.
-      security:
+
-        - SessionAuth: [ ]
+        Тело каждого объявления (`body_html`) рендерится из markdown на языке
+        профиля текущего пользователя с откатом на русский, если перевод
+        отсутствует, и очищается до ограниченного набора тегов: `p`, `br`,
+        `strong`, `em`, `del`, `ul`, `ol`, `li`, `a` (только `http`/`https`,
+        с `target="_blank" rel="noopener noreferrer"`). Если после очистки
+        текста не осталось, объявление всё равно попадает в выдачу
+        с пустым `body_html` — клиенты такие объявления не показывают.
+
+        Скрытие объявлений хранится только на стороне клиента (локально)
+        и не влияет на ответ этого метода.
+      operationId: systemNotificationsActive
       parameters:
-        - name: id
+        - name: per-page
           in: query
-          required: false
+          schema: { type: integer, minimum: 1, maximum: 50, default: 20 }
-          description: ID категории (пусто — корень каталога)
+          description: Значение больше 50 урезается до 50.
-          schema: { type: string, format: uuid }
+        - name: page
-        - name: hash_id
           in: query
-          required: false
+          schema: { type: integer, minimum: 1, default: 1 }
-          description: Хэш категории, альтернатива id
+        - name: sort
-          schema: { type: string }
-        - name: q
           in: query
-          required: false
+          schema:
-          description: Поиск по названию, автору и серии книги
+            type: string
-          schema: { type: string }
+            enum:
-        - name: tags
+              - published_at
-          in: query
+              - -published_at
-          required: false
+          description: По умолчанию `-published_at`.
-          description: ID тегов через запятую
-          schema: { type: string }
       responses:
         200:
-          description: Содержимое категории или результаты поиска
+          description: Список активных объявлений.
           content:
             application/json:
               schema:
                 type: object
                 properties:
-                  category:
+                  data:
-                    description: Текущая категория (null для корня)
-                    nullable: true
-                    allOf:
-                      - $ref: '#/components/schemas/libraryCatalogCategory'
-                  categories:
                     type: array
-                    description: Подкатегории текущей категории
                     items:
-                      $ref: '#/components/schemas/libraryCatalogCategory'
+                      $ref: '#/components/schemas/SystemNotification'
-                  items:
+                  _links:
-                    type: array
+                    $ref: '#/components/schemas/_links'
-                    description: Книги текущей категории
+                  _meta:
-                    items:
+                    $ref: '#/components/schemas/_meta'
-                      $ref: '#/components/schemas/libraryCatalogBook'
+        403:
-                  tags:
-                    type: array
-                    description: Теги, доступные в текущей категории
-                    items:
-                      $ref: '#/components/schemas/tag'
-                  breadcrumbs:
-                    type: array
-                    description: Хлебные крошки (пусто для корня)
-                    items:
-                      type: object
-                      properties:
-                        id: { type: string, format: uuid }
-                        label: { type: string }
-                        url: { type: string }
-                  q:
-                    type: string
-                    nullable: true
-                    description: Поисковый запрос
-        400: { description: Некорректный id категории }
-        404: { description: Категория не найдена }
-        401: { description: Unauthorized request }
-        403: { description: Unauthorized request }
-
-  /admin/library-category/items:
-    get:
-      tags: [admin-library-category]
-      summary: Дерево каталога (один уровень)
           description: |
-        Узлы одного уровня дерева для редактора каталога. Без id — корень,
+            У текущего пользователя отсутствует право `admin-controls`.
-        с id категории — её дети. Дети категорий грузятся лениво повторным
-        запросом. У категорий в data есть children_count.
-      operationId: adminLibraryCategoryItems
-      security:
-        - SessionAuth: [ ]
-      parameters:
-        - name: id
-          in: query
-          required: false
-          description: ID категории (item_id узла, не узла дерева)
-          schema: { type: string, format: uuid }
-      responses:
-        200:
-          description: Массив узлов дерева
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/libraryCatalogTreeNode'
-        403: { description: Нет права book-manager }
-
-  /admin/library-category/create:
-    post:
-      tags: [admin-library-category]
-      summary: Создать категорию
-      operationId: adminLibraryCategoryCreate
-      security:
-        - SessionAuth: [ ]
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              required: [name]
-              properties:
-                name: { type: string }
-                parent_id:
-                  type: string
-                  format: uuid
-                  nullable: true
-                  description: ID родительского узла дерева (null — корень)
-      responses:
-        200:
-          description: Результат (errors при ошибке валидации)
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/libraryCatalogEditorResult'
-        403: { description: Нет права book-manager }
-
-  /admin/library-category/update:
-    put:
-      tags: [admin-library-category]
-      summary: Обновить узел дерева (категорию или книгу)
-      description: |
-        id — идентификатор УЗЛА дерева (key из items). Для категории принимает
-        name/description/status_id/thumb_style_id/content_style_id/tags_id/
-        userGroupsVisibleId/userGroupsHiddenId/image; для книги — title и другие
-        поля книги. tags_id — строка с ID через запятую. image — объект {id, fid}
-        (fid обязателен для построения URL картинки категории; image: null — не менять).
-        Узлы чужих каталогов недоступны (404).
-      operationId: adminLibraryCategoryUpdate
-      security:
-        - SessionAuth: [ ]
-      parameters:
-        - name: id
-          in: query
-          required: true
-          schema: { type: string, format: uuid }
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-      responses:
-        200:
-          description: Результат
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/libraryCatalogEditorResult'
-        400: { description: Некорректный uuid }
-        404: { description: Узел не найден или принадлежит другому каталогу }
-
-  /admin/library-category/delete:
-    delete:
-      tags: [admin-library-category]
-      summary: Удалить узел дерева
-      description: |
-        Категория удаляется вместе с поддеревом; для книги удаляется только узел
-        (книга остаётся в библиотеке). id — идентификатор узла дерева.
-      operationId: adminLibraryCategoryDelete
-      security:
-        - SessionAuth: [ ]
-      parameters:
-        - name: id
-          in: query
-          required: true
-          schema: { type: string, format: uuid }
-      responses:
-        200: { description: Удалено (true) }
-        400: { description: Некорректный uuid }
-        404: { description: Узел не найден или принадлежит другому каталогу }
-
-  /admin/library-category/update-tree:
-    post:
-      tags: [admin-library-category]
-      summary: Перенести узел в другую категорию
-      operationId: adminLibraryCategoryUpdateTree
-      security:
-        - SessionAuth: [ ]
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              required: [childId]
-              properties:
-                childId:
-                  type: string
-                  format: uuid
-                  description: ID переносимого узла дерева
-                parentId:
-                  type: string
-                  format: uuid
-                  nullable: true
-                  description: ID узла целевой категории (null — в корень)
-      responses:
-        200: { description: Перенесено }
-        400: { description: Не передан childId }
-        404: { description: Узел не найден, либо родитель — не категория }
-        500: { description: Перенос не выполнен }
-
-  /admin/library-category/sort:
-    post:
-      tags: [admin-library-category]
-      summary: Сохранить порядок узлов
-      description: Карта «ID узла дерева → порядковый номер». Чужие узлы игнорируются.
-      operationId: adminLibraryCategorySort
-      security:
-        - SessionAuth: [ ]
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              required: [sort]
-              properties:
-                sort:
-                  type: object
-                  additionalProperties: { type: integer }
-      responses:
-        200: { description: Сохранено }
-        400: { description: sort — не объект }
-
-  /admin/library-category/create-item:
-    post:
-      tags: [admin-library-category]
-      summary: Добавить книгу в категорию
-      description: |
-        entity_id принудительно Entity::Book (375) — подменить нельзя. Дубликаты
-        по (parent_id, item_id) не создаются.
-      operationId: adminLibraryCategoryCreateItem
-      security:
-        - SessionAuth: [ ]
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              required: [item_id]
-              properties:
-                item_id:
-                  type: string
-                  format: uuid
-                  description: ID книги
-                parent_id:
-                  type: string
-                  format: uuid
-                  nullable: true
-                  description: ID узла категории (null — корень)
-      responses:
-        200:
-          description: Результат
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/libraryCatalogEditorResult'
-        404: { description: Родитель не найден или не категория }
-
-  /admin/library-category/create-items:
-    post:
-      tags: [admin-library-category]
-      summary: Добавить несколько книг (мультивыбор)
-      description: Транзакционно; при ошибке валидации любого элемента — полный откат.
-      operationId: adminLibraryCategoryCreateItems
-      security:
-        - SessionAuth: [ ]
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: array
-              items:
-                type: object
-                required: [item_id]
-                properties:
-                  item_id: { type: string, format: uuid }
-                  parent_id:
-                    type: string
-                    format: uuid
-                    nullable: true
-      responses:
-        200:
-          description: Результат (data — массив созданных узлов)
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/libraryCatalogEditorResult'
 
 components:
   securitySchemes:
@@ -9187,101 +8934,6 @@ components:
           items:
             $ref: '#/components/schemas/tag'
 
-    libraryCatalogCategory:
-      type: object
-      description: Категория каталога библиотеки
-      properties:
-        id: { type: string, format: uuid }
-        name: { type: string }
-        title: { type: string }
-        description: { type: string, nullable: true }
-        hash_id: { type: string }
-        url: { type: string }
-        status_id:
-          type: integer
-          description: 1 - Active, 2 - Disabled
-        thumb_style_id:
-          type: integer
-          description: Превью 1 - картинка и текст, 2 - только текст, 3 - только картинка
-        content_style_id:
-          type: integer
-          description: Вид содержимого 1 - плитка, 2 - список
-        thumbUrl: { type: string }
-        imageUrl: { type: string }
-        iconUrl: { type: string }
-        tags:
-          type: array
-          items:
-            $ref: '#/components/schemas/tag'
-
-    libraryCatalogBook:
-      type: object
-      description: Книга в каталоге библиотеки (состав полей карточки книги)
-      properties:
-        id: { type: string, format: uuid }
-        entity_id: { type: integer, example: 375 }
-        entityId: { type: integer, example: 375 }
-        name: { type: string, description: Совпадает с title }
-        title: { type: string }
-        description: { type: string, nullable: true }
-        url: { type: string }
-        status_id:
-          type: integer
-          description: 1 - В библиотеке, 2 - На руках, 3 - Удалена
-        statusName: { type: string }
-        author: { type: string, nullable: true }
-        series: { type: string, nullable: true }
-        publishing_house: { type: string, nullable: true }
-        year_issue: { type: integer, nullable: true }
-        page_quantity: { type: integer, nullable: true }
-        read_quantity: { type: integer, nullable: true }
-        is_print: { type: boolean, description: Есть бумажная версия }
-        thumbUrl: { type: string, description: Обложка (или плейсхолдер) }
-        thumbMiniCubeUrl: { type: string }
-        tags:
-          type: array
-          items:
-            $ref: '#/components/schemas/tag'
-        countLike: { type: integer }
-        isLikeUser: { type: boolean }
-        isFavoriteUser: { type: boolean }
-        isOnHandUser: { type: boolean, description: Книга сейчас на руках }
-
-    libraryCatalogTreeNode:
-      type: object
-      description: Узел дерева редактора каталога библиотеки
-      properties:
-        key:
-          type: string
-          format: uuid
-          description: ID узла дерева (hr_category_tree_item)
-        title: { type: string }
-        folder: { type: boolean, description: true — категория }
-        lazy: { type: boolean, description: Дети грузятся отдельным запросом }
-        children:
-          type: array
-          nullable: true
-          description: null — не загружены (лениво)
-          items: { type: object }
-        data:
-          type: object
-          description: |
-            treeData сущности. Для категории — поля libraryCatalogCategory плюс item_id,
-            children_count, userGroupsVisible/Hidden, organization_id, isTenantSynced.
-            Для книги — поля libraryCatalogBook плюс item_id.
-
-    libraryCatalogEditorResult:
-      type: object
-      description: Единый формат ответа редактора каталога
-      properties:
-        success: { type: boolean }
-        data:
-          nullable: true
-          description: Созданный/обновлённый узел (или массив узлов для create-items)
-        errors:
-          nullable: true
-          description: Ошибки валидации (null при успехе)
-
     calendarEventType:
       type: object
       properties:
@@ -14237,6 +13889,31 @@ components:
         _meta:
           $ref: '#/components/schemas/_meta'
 
+    SystemNotification:
+      type: object
+      description: Системное объявление HRBox в баннере на главной странице портала.
+      properties:
+        id:
+          type: string
+          format: uuid
+          description: Идентификатор объявления.
+        body_html:
+          type: string
+          description: |
+            Текст объявления, отрендеренный из markdown в HTML на языке
+            профиля пользователя (откат на русский, если перевод отсутствует)
+            и очищенный до ограниченного набора тегов: `p`, `br`, `strong`,
+            `em`, `del`, `ul`, `ol`, `li`, `a` (только `http`/`https`,
+            с `target="_blank" rel="noopener noreferrer"`). Пустая строка,
+            если после очистки текста не осталось — такие объявления клиенты
+            не показывают.
+          example: "<p>Плановые работы <strong>1 октября</strong> с 02:00 до 04:00 МСК.</p>"
+        published_at:
+          type: string
+          format: date-time
+          description: Дата и время публикации, ISO 8601 со смещением.
+          example: "2026-09-24T16:30:04+03:00"
+
   parameters:
     boardDateTypeParam:
       in: query