From 7e5f39854f6052b491ccd7a29ef57577f28302b1 Mon Sep 17 00:00:00 2001 From: "pavel.korolkov" Date: Fri, 17 Apr 2026 15:42:09 +0500 Subject: [PATCH] docs: Add widgets & healthcheck PT AI --- .../admin/external-services.ru.md | 18 +++++++++++ .../admin/healthchecks/types.ru.md | 26 ++++++++++++++++ .../documentation/admin/widgets/types.ru.md | 30 +++++++++++++++++++ .../documentation/release-notes/v1.5.0.ru.md | 19 ++++++++++++ 4 files changed, 93 insertions(+) create mode 100644 content/documentation/release-notes/v1.5.0.ru.md diff --git a/content/documentation/admin/external-services.ru.md b/content/documentation/admin/external-services.ru.md index bffb608..5695f35 100644 --- a/content/documentation/admin/external-services.ru.md +++ b/content/documentation/admin/external-services.ru.md @@ -349,6 +349,24 @@ Authorization: Basic Authorization: Bearer <ваш-токен> ``` +### PT Application Inspector + +**Тип авторизации:** токен доступа. + +**Заголовки:** + +| Заголовок | Формат значения | +|----------------|-------------------| +| `Access-Token` | `<токен доступа>` | + +Платформа обменивает токен доступа на JWT через API PT Application Inspector и дальше обращается к API с заголовком `Authorization: Bearer `. + +**Пример:** + +```sh +Access-Token: <ваш-токен-доступа> +``` + ### Vault **Тип авторизации:** Token Authentication. diff --git a/content/documentation/admin/healthchecks/types.ru.md b/content/documentation/admin/healthchecks/types.ru.md index a66eb51..29d34cf 100644 --- a/content/documentation/admin/healthchecks/types.ru.md +++ b/content/documentation/admin/healthchecks/types.ru.md @@ -97,6 +97,32 @@ conditions: Конфигурация авторизации описана в разделе [внешний сервис DefectDojo](../external-services/#defectdojo). +## PT AI Scan Issues + +Правило типа **PT AI Scan Issues** проверяет количество замечаний сканирования в выбранном результате сканирования PT Application Inspector для заданного проекта и ветки. Сравнение выполняется по блоку **Условия**: для каждого уровня задаётся **Уровень**, **Оператор** и **Значение**. В интерфейсе уровень отображается как «Всего», «Критический», «Высокий», «Средний», «Низкий» или «Информационный»; «Всего» соответствует общему числу замечаний. + +Во всех текстовых полях поддерживается шаблонизация. Например, в поле **Проект** можно подставить название из параметров сущности: + +```go +{{ .entity.properties.ptai_project }} +``` + +### Параметры конфигурации + +| Название | Обязательность | Описание | Возможные значения | +|----------|----------------|---------------------------------------------------------------------------------------------------------------|--------------------| +| Проект | **Да** | Название проекта в PT Application Inspector; допускаются шаблоны из полей сущности | | +| Ветка | Нет | Название ветки; если пусто, используется рабочая ветка или первая доступная | | +| Условия | Нет | Условия для сравнения количества замечаний сканирования по уровню | | + +#### Условия + +Каждое условие задаётся в форме строки с полями **Уровень**, **Оператор** и **Значение**. Операторы: `>`, `<`, `=`, `>=`, `<=`. + +### Авторизация + +Конфигурация авторизации описана в разделе [внешний сервис PT Application Inspector](../external-services/#pt-application-inspector). + ## CodeScoring Vulnerabilities Правило типа **CodeScoringVulnerabilities** выполняет проверку по количеству уязвимостей различной критичности (severity) для заданного проекта в CodeScoring. diff --git a/content/documentation/admin/widgets/types.ru.md b/content/documentation/admin/widgets/types.ru.md index a7d00d7..2e47662 100644 --- a/content/documentation/admin/widgets/types.ru.md +++ b/content/documentation/admin/widgets/types.ru.md @@ -156,6 +156,36 @@ title: Типы виджетов | URL | **Да** | URL CodeScoring | - | | ID проекта | **Да** | Идентификатор проекта в CodeScoring | - | +## PT Application Inspector. Зависимости (SCA) + +Виджет показывает зависимости проекта (SCA) из PT Application Inspector: пакет, версию, количество уязвимостей, связанную находку по компоненту и использование в коде. Доступны действия **Запустить сканирование** и **Остановить сканирование** для выбранной ветки (при включённых действиях виджета и достаточных правах в PT Application Inspector). На виджете можно выбрать **Ветку**, выполнить **Поиск по названию пакета**, отфильтровать строки по **Степени уязвимости** и изменить **Сортировку**. + +### Авторизация + +Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#pt-application-inspector). + +### Конфигурация + +| Название | Обязательность | Описание | Значение по умолчанию | +|------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Название проекта | **Да** | Название проекта, как в PT Application Inspector (как в интерфейсе продукта) | - | +| Название ветки | Нет | Название ветки, как в PT Application Inspector; если пусто, используется рабочая ветка. Должно совпадать с интерфейсом (без учёта регистра) | - | + +## PT Application Inspector. Уязвимости + +Виджет показывает таблицу находок сканирования PT Application Inspector: файл, уровень, тип находки, правило, зависимость, модуль сканирования. Доступны **Подробности** по строке, **Запустить сканирование** и **Остановить сканирование** для выбранной ветки (при включённых действиях виджета и достаточных правах в PT Application Inspector). На виджете можно выбрать **Ветку**, использовать **Поиск по пакету, файлу, уровню, серьёзности, правилу или модулю сканирования**, отфильтровать по **Степени уязвимости**, **Модулю сканирования** и **Правилу**, изменить **Сортировку**. + +### Авторизация + +Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#pt-application-inspector). + +### Конфигурация + +| Название | Обязательность | Описание | Значение по умолчанию | +|------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Название проекта | **Да** | Название проекта, как в PT Application Inspector (как в интерфейсе продукта) | - | +| Название ветки | Нет | Название ветки, как в PT Application Inspector; если пусто, используется рабочая ветка. Должно совпадать с интерфейсом (без учёта регистра) | - | + ## DefectDojo. Уязвимости в продукте (детали) Виджет позволяет вывести таблицу с уязвимостями продукта на основе информации из DefectDojo с указанием уровня критичности, описания и даты обнаружения для каждой уязвимости. diff --git a/content/documentation/release-notes/v1.5.0.ru.md b/content/documentation/release-notes/v1.5.0.ru.md new file mode 100644 index 0000000..5f47974 --- /dev/null +++ b/content/documentation/release-notes/v1.5.0.ru.md @@ -0,0 +1,19 @@ +--- +title: v1.5.0 +weight: 920 +--- + +{{< alert level="info" >}} +Релиз запланирован. +{{< /alert >}} + +## Новые возможности + +### Виджеты + +- **PT Application Inspector. Зависимости (SCA)** — зависимости и уязвимости компонентов по данным сканирования ([подробнее](../../admin/widgets/types/#pt-application-inspector-зависимости-sca)). +- **PT Application Inspector. Уязвимости** — таблица находок сканирования ([подробнее](../../admin/widgets/types/#pt-application-inspector-уязвимости)). + +### Проверки статуса + +Добавлено правило **PT AI Scan Issues** для проверки количества замечаний сканирования PT Application Inspector по уровням ([подробнее](../../admin/healthchecks/types/#ptai-scan-issues)).