Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ weight: 10
CreateCodeScoringProject — creates a new project in CodeScoring.
The action uses the CodeScoring API to register a project with the specified parameters:

- project name
- repository URL
- Project name
- Repository URL
- VCS ID
- option to automatically run SCA analysis after cloning the repository
- Option to automatically run SCA analysis after cloning the repository

### Request example
## Request example

Example of the action request body:

```yaml
name: example-project
Expand All @@ -20,15 +22,17 @@ vcs_id: 2
run_sca_after_clone: true
```

### Request specification
## Request specification

The action request body supports the following parameters:

| Name | Required | Description |
| -------------------- | -------- | ---------------------------------------------------------------------------- |
| name | Yes | Project name in CodeScoring |
| repository | Yes | Repository URL (e.g., <https://gitlab.example.com/group/project.git>) |
| vcs_id | Yes | VCS ID in CodeScoring (must be greater than 0) |
| run_sca_after_clone | No | Automatically run SCA analysis after cloning the repository |
| `name` | Yes | Project name in CodeScoring |
| `repository` | Yes | Repository URL, for example, `https://gitlab.example.com/group/project.git` |
| `vcs_id` | Yes | VCS ID in CodeScoring (must be greater than 0) |
| `run_sca_after_clone` | No | Automatically run SCA analysis after cloning the repository |

### Response
## Response

The response contains the created project object with the following information: project identifier (pk), name, project type, description, repository information, project status, access permissions, license, number of dependencies and vulnerabilities, project languages, scan schedule status, and the dates of the first and last SCA scans.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ CreateCodeScoringProject — создаёт новый проект в сист
- ID VCS-системы;
- опция автоматического запуска SCA-анализа после клонирования репозитория.

### Пример запроса
## Пример запроса

Пример тела запроса действия:

```yaml
name: example-project
Expand All @@ -20,15 +22,17 @@ vcs_id: 2
run_sca_after_clone: true
```

### Спецификация запроса
## Спецификация запроса

Тело запроса действия поддерживает следующие параметры:

| Название | Обязательность | Описание |
| -------------------- | ---------------- | ---------------------------------------------------------------------------- |
| name | Да | Название проекта в CodeScoring |
| repository | Да | URL репозитория (например, <https://gitlab.example.com/group/project.git>) |
| vcs_id | Да | ID VCS системы в CodeScoring (должен быть больше 0) |
| run_sca_after_clone | Нет | Автоматический запуск SCA-анализа после клонирования репозитория |
| `name` | Да | Название проекта в CodeScoring |
| `repository` | Да | URL репозитория (например, <https://gitlab.example.com/group/project.git>) |
| `vcs_id` | Да | ID VCS системы в CodeScoring (должен быть больше 0) |
| `run_sca_after_clone` | Нет | Автоматический запуск SCA-анализа после клонирования репозитория |

### Ответ
## Ответ

В ответе возвращается объект созданного проекта со следующей информацией: идентификатор проекта (pk), название, тип проекта, описание, информация о репозитории, статус проекта, права доступа, лицензия, количество зависимостей и уязвимостей, языки проекта, статус расписания сканирования и даты первого и последнего SCA-сканирования.
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ weight: 20

DeleteCodeScoringProject — deletes a project in CodeScoring by its ID.

### Request example
## Request example

Example of the action request body:

```yaml
id: 1
```

### Request specification
## Request specification

The action request body supports the following parameters:

| Name | Required | Description |
| ---------- | -------- | --------------------------- |
| id | Yes | Project ID in CodeScoring |
| `id` | Yes | Project ID in CodeScoring |
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ weight: 20

DeleteCodeScoringProject — удаляет проект в системе CodeScoring по его ID.

### Пример запроса
## Пример запроса

Пример тела запроса действия:

```yaml
id: 1
```

### Спецификация запроса
## Спецификация запроса

Тело запроса действия поддерживает следующие параметры:

| Название | Обязательность | Описание |
| ---------- | ---------------- | ----------------------------- |
| id | Да | ID проекта в CodeScoring |
| `id` | Да | ID проекта в CodeScoring |
22 changes: 14 additions & 8 deletions content/documentation/admin/actions/debug/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ title: Debug
weight: 10
---

Debug runs a debugging action. It performs a specified number of wait cycles, writes arbitrary data to the log, and returns the request in the action response.
Debug runs a debugging action.
It performs a specified number of wait cycles, writes arbitrary data to the log, and returns the request in the action response.

### Request example
## Request example

Example of the action request body:

```yaml
sleep_time: 1
Expand All @@ -14,17 +17,20 @@ extra:
example_key: example_value
```

### Request specification
## Request specification

The action request body supports the following parameters:

| Name | Required | Description | Default value |
| --------------- | -------- | ---------------------------------------------------------------------------------------------------- | ----------------------- |
| sleep_time | No | Duration of one wait cycle, in seconds | `0` |
| sleep_count | No | Number of wait cycles | `0` |
| extra | No | An arbitrary set of key-value pairs that is written to the log and returned in the action's response | - |
| `sleep_time` | No | Duration of one wait cycle, in seconds | `0` |
| `sleep_count` | No | Number of wait cycles | `0` |
| `extra` | No | An arbitrary set of key-value pairs that is written to the log and returned in the action's response | — |

With `0` values, the action finishes immediately. Negative values are not allowed: `sleep_time and sleep_count must not be negative`.
With `0` values, the action finishes immediately.
Negative values are not allowed: `sleep_time and sleep_count must not be negative`.

### Response
## Response

The action returns the whole request: the `sleep_time`, `sleep_count` and `extra` fields with their values.
Use them in templates of subsequent actions, for example `{{ .response.extra.example_key }}`.
22 changes: 14 additions & 8 deletions content/documentation/admin/actions/debug/debug.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ title: Debug
weight: 10
---

Debug выполняет отладочное действие. Позволяет сделать заданное число циклов ожидания, а также записать произвольные данные в лог и вернуть запрос в ответе действия.
Debug выполняет отладочное действие.
Позволяет сделать заданное число циклов ожидания, а также записать произвольные данные в лог и вернуть запрос в ответе действия.

### Пример запроса
## Пример запроса

Пример тела запроса действия:

```yaml
sleep_time: 1
Expand All @@ -14,17 +17,20 @@ extra:
example_key: example_value
```

### Спецификация запроса
## Спецификация запроса

Тело запроса действия поддерживает следующие параметры:

| Название | Обязательность | Описание | Значение по умолчанию |
| --------------- | ---------------- | ----------------------------------------------------------------------------------------------------- | ----------------------- |
| sleep_time | Нет | Длительность одного цикла ожидания в секундах | `0` |
| sleep_count | Нет | Число циклов ожидания | `0` |
| extra | Нет | Произвольный набор пар «ключ–значение», который записывается в лог и возвращается в ответе действия | - |
| `sleep_time` | Нет | Длительность одного цикла ожидания в секундах | `0` |
| `sleep_count` | Нет | Число циклов ожидания | `0` |
| `extra` | Нет | Произвольный набор пар «ключ–значение», который записывается в лог и возвращается в ответе действия | — |

При значениях `0` действие завершается сразу. Отрицательные значения не допускаются: `sleep_time and sleep_count must not be negative`.
При значениях `0` действие завершается сразу.
Отрицательные значения не допускаются: `sleep_time and sleep_count must not be negative`.

### Ответ
## Ответ

Действие возвращает весь запрос: поля `sleep_time`, `sleep_count` и `extra` с их значениями.
Используйте их в шаблонах последующих действий, например `{{ .response.extra.example_key }}`.
10 changes: 7 additions & 3 deletions content/documentation/admin/actions/debug/fail.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ weight: 20

Fail simulates an action execution error. It is intended for use as a debugging step in processes.

### Request example
## Request example

Example of the action request body:

```yaml
fail: true
```

### Request specification
## Request specification

The action request body supports the following parameters:

| Name | Required | Description | Default value |
| ---------- | -------- | -------------------------------------------------------------------------------------- | ----------------------- |
| fail | No | If `true`, the action completes with an error; if `false`, the action completes successfully | `true` |
| `fail` | No | If `true`, the action completes with an error; if `false`, the action completes successfully | `true` |
10 changes: 7 additions & 3 deletions content/documentation/admin/actions/debug/fail.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ weight: 20

Fail эмулирует ошибку исполнения действия. Предназначен для использования в процессах в качестве отладочного элемента.

### Пример запроса
## Пример запроса

Пример тела запроса действия:

```yaml
fail: true
```

### Спецификация запроса
## Спецификация запроса

Тело запроса действия поддерживает следующие параметры:

| Название | Обязательность | Описание | Значение по умолчанию |
| ---------- | ---------------- | ----------------------------------------------------------------------------------------- | ----------------------- |
| fail | Нет | Если `true`, действие завершается с ошибкой; если `false`, действие завершается успешно | `true` |
| `fail` | Нет | Если `true`, действие завершается с ошибкой; если `false`, действие завершается успешно | `true` |
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ This action requires an API v2 key for the user on whose behalf it will run.

CreateDefectdojoEngagement — creates a new engagement in DefectDojo. The action uses the DefectDojo API v2.

### Request example
## Request example

Example of the action request body:

```yaml
name: example engagement
Expand All @@ -19,6 +21,7 @@ target_end: '2024-06-30'
lead: '1'
```

### Request specification
## Request specification

The fields correspond to the official DefectDojo API endpoint `/api/v2/engagements`. For details, see the [DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/).
The fields correspond to the official DefectDojo API endpoint `/api/v2/engagements`.
For details, see the [DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/).
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ weight: 30
---

{{< alert level="info" >}}
Для выполнения действия необходимо наличие токена — API v2 Key пользователя, от имени которого будет запускаться выполнение действия.
Для выполнения действия требуется токен API v2 Key пользователя, от имени которого выполняется действие.
{{< /alert >}}

CreateDefectdojoEngagement — создаёт новый engagement в системе DefectDojo. Действие использует DefectDojo API v2.

### Пример запроса
## Пример запроса

Пример тела запроса действия:

```yaml
name: example engagement
Expand All @@ -19,6 +21,6 @@ target_end: '2024-06-30'
lead: '1'
```

### Спецификация запроса
## Спецификация запроса

Список полей соответствует официальному API DefectDojo, `/api/v2/engagements`, подробнее — [в документации DefectDojo](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/).
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,17 @@ This action requires an API v2 key for the user on whose behalf it will run.

CreateDefectdojoProduct — creates a new product in DefectDojo. The action uses the DefectDojo API v2.

### Request example
## Request example

Example of the action request body:

```yaml
name: example
description: example description
prod_type: 1
```

### Request specification
## Request specification

The fields correspond to the official DefectDojo API endpoint `/api/v2/products`. For details, see the [DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/).
The fields correspond to the official DefectDojo API endpoint `/api/v2/products`.
For details, see the [DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/).
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@ weight: 10
---

{{< alert level="info" >}}
Для выполнения действия необходимо наличие токена — API v2 Key пользователя, от имени которого будет запускаться выполнение действия.
Для выполнения действия требуется токен API v2 Key пользователя, от имени которого выполняется действие.
{{< /alert >}}

CreateDefectdojoProduct — создаёт новый продукт в системе DefectDojo. Действие использует DefectDojo API v2.

### Пример запроса
## Пример запроса

Пример тела запроса действия:

```yaml
name: example
description: example description
prod_type: 1
```

### Спецификация запроса
## Спецификация запроса

Список полей соответствует официальному API DefectDojo, `/api/v2/products`, подробнее — [в документации DefectDojo](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/).
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@ This action requires an API v2 key for the user on whose behalf it will run.

DeleteDefectdojoProduct — deletes a product from DefectDojo. The action uses the DefectDojo API v2.

### Request example
## Request example

Example of the action request body:

```yaml
id: 1
```

### Request specification
## Request specification

The action request body supports the following parameters:

| Name | Required | Description | Default value |
| ------------- | -------- | ------------------------------------------------ | ------------------------ |
| id | Yes | Identifier of the product to delete | - |
| `id` | Yes | Identifier of the product to delete | — |
Loading
Loading