diff --git a/content/documentation/admin/actions/types.ru.md b/content/documentation/admin/actions/types.ru.md index db1f968..cc94295 100644 --- a/content/documentation/admin/actions/types.ru.md +++ b/content/documentation/admin/actions/types.ru.md @@ -18,7 +18,7 @@ lead: '1' ### Спецификация запроса -Список полей соответствует официальному API DefectDojo, `/api/v2/engagements`, подробнее [в документации Defectdojo](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). +Список полей соответствует официальному API DefectDojo, `/api/v2/engagements`, подробнее — [в документации Defectdojo](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). ### Учетные данные @@ -38,7 +38,7 @@ prod_type: 1 ### Спецификация запроса -Список полей соответствует официальному API DefectDojo, `/api/v2/products`, подробнее [в документации Defectdojo](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). +Список полей соответствует официальному API DefectDojo, `/api/v2/products`, подробнее — [в документации Defectdojo](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). ### Учетные данные @@ -59,12 +59,12 @@ branches: ### Спецификация запроса -| Название | Обязательность | Описание | -|-----------------|-----------------|------------------------------------------------------------------------------| -| project_id | **обязательно** | Идентификатор проекта, в котором необходимо создать ветки | -| branches | **обязательно** | Список создаваемых веток | -| branches.branch | **обязательно** | Название новой ветки | -| branches.ref | **обязательно** | Название существующей ветки или SHA-хеш коммита | +| Название | Обязательность | Описание | +|-----------------|----------------|------------------------------------------------------------------------------| +| project_id | Да | Идентификатор проекта, в котором необходимо создать ветки | +| branches | Да | Список создаваемых веток | +| branches.branch | Да | Название новой ветки | +| branches.ref | Да | Название существующей ветки или SHA-хеш коммита | ### Учетные данные @@ -91,12 +91,12 @@ variables: ### Спецификация запроса -| Название | Обязательность | Описание | -|-----------------|-----------------|------------------------------------------------------------------------------| -| group_id | **обязательно** | Идентификатор группы, в котором необходимо создать переменные | -| variables | **обязательно** | Список создаваемых переменных | +| Название | Обязательность | Описание | +|-----------------|----------------|------------------------------------------------------------------------------| +| group_id | Да | Идентификатор группы, в котором необходимо создать переменные | +| variables | Да | Список создаваемых переменных | -Список полей для переменных соответствует официальному GitLab Group-level Variables API, `/groups/:id/variables`, подробнее [в документации Gitlab](https://docs.gitlab.com/api/group_level_variables/#create-variable). +Список полей для переменных соответствует официальному GitLab Group-level Variables API, `/groups/:id/variables`, подробнее — [в документации Gitlab](https://docs.gitlab.com/api/group_level_variables/#create-variable). ### Учетные данные @@ -135,15 +135,15 @@ values: ### Спецификация запроса -| Название | Опциональность | Описание | Значение по умолчанию | -|-------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------| -| source_project_id | **обязательно** | Идентификатор проекта, который служит источником для Merge Request | - | -| target_project_id | **обязательно** | Идентификатор целевого проекта, в котором будет сформирован Merge Request | - | -| merge_request_spec | **обязательно** | Спецификация, соответствующая [GitLab Merge Requests API](https://docs.gitlab.com/ee/api/merge_requests.html#create-mr) | - | -| source_project_tag | опционально | Тег в проекте-источнике, из которого будет сформирован Merge Request. Если не указан, используется ветка в проекте-источнике | - | -| source_project_branch | опционально | Ветка в проекте-источнике, из которой будет сформирован Merge Request | main | -| additionalIgnoreFiles | опционально | Список файлов, содержащих пути для исключения из MR. Заполняется по аналогии с [.templateignore](#templateignore) | - | -| values | опционально | Переменные, используемые при шаблонизации, в формате `ключ: значение` | - | +| Название | Обязательность | Описание | Значение по умолчанию | +|-------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| source_project_id | Да | Идентификатор проекта, который служит источником для Merge Request | - | +| target_project_id | Да | Идентификатор целевого проекта, в котором будет сформирован Merge Request | - | +| merge_request_spec | Да | Спецификация, соответствующая [GitLab Merge Requests API](https://docs.gitlab.com/ee/api/merge_requests.html#create-mr) | - | +| source_project_tag | Нет | Тег в проекте-источнике, из которого будет сформирован Merge Request. Если не указан, используется ветка в проекте-источнике | - | +| source_project_branch | Нет | Ветка в проекте-источнике, из которой будет сформирован Merge Request | main | +| additionalIgnoreFiles | Нет | Список файлов, содержащих пути для исключения из MR. Заполняется по аналогии с [.templateignore](#templateignore) | - | +| values | Нет | Переменные, используемые при шаблонизации, в формате `ключ: значение` | - | ### Учетные данные @@ -185,14 +185,14 @@ namespace_id: '0' ### Спецификация запроса -| Название | Обязательность | Описание | Значение по умолчанию | -|------------------------|------------------|--------------------------------------------------------------------------------------------|-----------------------| -| name | **обязательно** | Название проекта, который будет создан в GitLab | - | -| path | **обязательно** | URL-совместимый путь проекта. Обычно совпадает с названием, но может отличаться | - | -| default_branch | **обязательно** | Название ветки, которая будет использоваться по умолчанию, например, «main» | - | -| namespace_id | **обязательно** | Идентификатор пространства имен (namespace) в GitLab, в котором будет создан проект | - | -| initialize_with_readme | опционально | Флаг, определяющий, нужно ли инициализировать проект с файлом README | false | -| description | опционально | Описание проекта, которое будет видно пользователям | - | +| Название | Обязательность | Описание | Значение по умолчанию | +|------------------------|----------------|--------------------------------------------------------------------------------------------|-----------------------| +| name | Да | Название проекта, который будет создан в GitLab | - | +| path | Да | URL-совместимый путь проекта. Обычно совпадает с названием, но может отличаться | - | +| default_branch | Да | Название ветки, которая будет использоваться по умолчанию, например, «main» | - | +| namespace_id | Да | Идентификатор пространства имен (namespace) в GitLab, в котором будет создан проект | - | +| initialize_with_readme | Нет | Флаг, определяющий, нужно ли инициализировать проект с файлом README | false | +| description | Нет | Описание проекта, которое будет видно пользователям | - | ### Учетные данные @@ -219,12 +219,12 @@ variables: ### Спецификация запроса -| Название | Обязательность | Описание | -|-----------------|-----------------|------------------------------------------------------------------------------| -| project_id | **обязательно** | Идентификатор проекта, в котором необходимо создать переменные | -| variables | **обязательно** | Список создаваемых переменных | +| Название | Обязательность | Описание | +|-----------------|----------------|------------------------------------------------------------------------------| +| project_id | Да | Идентификатор проекта, в котором необходимо создать переменные | +| variables | Да | Список создаваемых переменных | -Список полей для переменных соответствует официальному GitLab Project-level CI/CD variables API, `/projects/:id/variables`, подробнее [в документации Gitlab](https://docs.gitlab.com/api/project_level_variables/#create-a-variable) +Список полей для переменных соответствует официальному GitLab Project-level CI/CD variables API, `/projects/:id/variables`, подробнее — [в документации Gitlab](https://docs.gitlab.com/api/project_level_variables/#create-a-variable). ### Учетные данные @@ -253,14 +253,14 @@ pipeline_events: true ### Спецификация запроса -| Название | Обязательность | Описание | -|----------------------|-----------------|------------------------------------------------------------| -| project_id | **обязательно** | Идентификатор проекта, в котором необходимо создать вебхук | -| url | **обязательно** | URL-адрес вебхука | -| push_events | **обязательно** | Запускать вебхук при push в репозиторий | -| issues_events | **обязательно** | Запускать вебхук при создании Issue | -| merge_request_events | **обязательно** | Запускать вебхук при создании Merge rRequest | -| pipeline_events | **обязательно** | Запускать вебхук при запуске Pipeline | +| Название | Обязательность | Описание | +|----------------------|------------------|------------------------------------------------------------| +| project_id | Да | Идентификатор проекта, в котором необходимо создать вебхук | +| url | Да | URL-адрес вебхука | +| push_events | Да | Запускать вебхук при push в репозиторий | +| issues_events | Да | Запускать вебхук при создании Issue | +| merge_request_events | Да | Запускать вебхук при создании Merge rRequest | +| pipeline_events | Да | Запускать вебхук при запуске Pipeline | ### Учетные данные @@ -287,12 +287,12 @@ message: Tag description ### Спецификация запроса -| Название | Обязательность | Описание | -|----------------------|-----------------|-------------------------------------------------------------------------------| -| project_id | **обязательно** | Идентификатор проекта, в котором необходимо создать тег | -| tag_name | **обязательно** | Название тега | -| ref | **обязательно** | Название ветки, тег или SHA-хеш коммита, на который будет ссылаться новый тег | -| message | опционально | Описание тега | +| Название | Обязательность | Описание | +|----------------------|----------------|-------------------------------------------------------------------------------| +| project_id | Да | Идентификатор проекта, в котором необходимо создать тег | +| tag_name | Да | Название тега | +| ref | Да | Название ветки, тег или SHA-хеш коммита, на который будет ссылаться новый тег | +| message | Да | Описание тега | ### Учетные данные @@ -322,12 +322,12 @@ description: | ### Спецификация запроса -| Название | Обязательность | Описание | -|--------------|-----------------|--------------------------------------------------------------------------------------------| -| project_id | **обязательно** | Идентификатор проекта, в котором необходимо создать релиз | -| tag_name | **обязательно** | Название существующего тега, на основе которого формируется релиз | -| name | **обязательно** | Название релиза, отображаемое в GitLab | -| description | опционально | Описание релиза в формате Markdown | +| Название | Обязательность | Описание | +|--------------|----------------|--------------------------------------------------------------------------------------------| +| project_id | Да | Идентификатор проекта, в котором необходимо создать релиз | +| tag_name | Да | Название существующего тега, на основе которого формируется релиз | +| name | Да | Название релиза, отображаемое в GitLab | +| description | Нет | Описание релиза в формате Markdown | ### Учетные данные @@ -383,28 +383,27 @@ acls: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию | -|-------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|------------------------| -| securityProtocol | **обязательно** | Протокол для подключения к Kafka. Подробнее [в документации Kafka](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | -| saslMechanism | опционально | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Подробнее [в документации Kafka](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | -| acls | **обязательно** | Набор ACL, которые необходимо создать | - | - | -| acls.ops | **обязательно** | Список операций, для которых будет создано правило | См. список возможных операций | - | -| acls.pattern | **обязательно** | Тип шаблона | См. список возможных шаблонов | - | -| acls.topics | опционально | Список из названий топиков, для которых применяется правило | - | - | -| acls.groups | опционально | Список из названий групп, для которых применяется правило | - | - | -| acls.transactional_ids | опционально | Список из ID транзакций, для которых применяется правило | - | - | -| acls.tokens | опционально | Список токенов, для которых применяется правило | - | - | -| acls.allow | опционально | Список принципалов (user, group), для которых разрешается правило | - | - | -| acls.allow_hosts | опционально | Список хостов, для которых разрешается операция | - | - | -| acls.deny | опционально | Список принципалов (user, group), для которых запрещается правило | - | - | -| acls.deny_hosts | опционально | Список хостов, для которых запрещается операция | - | - | +| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию | +|-------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|------------------------| +| securityProtocol | Да | Протокол для подключения к Kafka. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | +| saslMechanism | Нет | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | +| acls | Да | Набор ACL, которые необходимо создать | - | - | +| acls.ops | Да | Список операций, для которых будет создано правило | [Список возможных операций](#список-возможных-операций) | - | +| acls.pattern | Да | Тип шаблона | [Список возможных шаблонов](#список-возможных-шаблонов) | - | +| acls.topics | Нет | Список из названий топиков, для которых применяется правило | - | - | +| acls.groups | Нет | Список из названий групп, для которых применяется правило | - | - | +| acls.transactional_ids | Нет | Список из ID транзакций, для которых применяется правило | - | - | +| acls.tokens | Нет | Список токенов, для которых применяется правило | - | - | +| acls.allow | Нет | Список хостов, для которых разрешается операция | - | - | +| acls.deny | Нет | Список принципалов (user, group), для которых запрещается правило | - | - | +| acls.deny_hosts | Нет | Список хостов, для которых запрещается операция | - | - | ### Учетные данные * **user** — имя пользователя, от которого будет запускаться выполнение действия. * **password** — пароль пользователя, от имени которого будет запускаться выполнение действия. -### Список возможных паттернов +### Список возможных шаблонов * ANY. * MATCH. @@ -413,7 +412,7 @@ acls: ### Список возможных операций -Подробнее — [в документации Kafka](https://kafka.apache.org) +Подробнее — [в документации Kafka](https://kafka.apache.org). **Topic:** @@ -463,14 +462,14 @@ topics: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | -|-------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------| -| securityProtocol | **обязательно** | Протокол для подключения к Kafka. Подробнее [в документации Kafka](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | -| saslMechanism | опционально | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. [Подробнее](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | -| partitions | **обязательно** | Количество разделов (партиций), на которые будет разделён топик | - | -| replication_factor | **обязательно** | Количество копий (реплик) каждой партиции топика, которые необходимо разместить на разных брокерах | - | -| configs | **обязательно** | Конфигурация в формате ключ-значение для создаваемых топиков | [Документация](https://kafka.apache.org/documentation/#topicconfigs) | -| topics | **обязательно** | Список названий топиков, которые необходимо создать | - | +| Название | Обязательность | Описание | Возможные значения | +|-------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| securityProtocol | Да | Протокол для подключения к Kafka. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | Нет | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| partitions | Да | Количество разделов (партиций), на которые будет разделён топик | - | +| replication_factor | Да | Количество копий (реплик) каждой партиции топика, которые необходимо разместить на разных брокерах | - | +| configs | Да | Конфигурация в формате ключ-значение для создаваемых топиков | Значения приведены [в документации Kafka](https://kafka.apache.org/documentation/#topicconfigs) | +| topics | Да | Список названий топиков, которые необходимо создать | - | ### Учетные данные @@ -499,15 +498,15 @@ users: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | -|-------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| -| securityProtocol | **обязательно** | Протокол для подключения к Kafka. [Подробнее](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | -| saslMechanism | опционально | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. [Подробнее](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | -| users | **обязательно** | Набор пользователей, которых необходимо создать | - | -| users.user | **обязательно** | Имя создаваемого пользователя | - | -| users.password | **обязательно** | Пароль создаваемого пользователя | - | -| users.mechanism | **обязательно** | Механизм аутентификации создаваемого пользователя | SCRAM-SHA-256, SCRAM-SHA-512 | -| users.iterations | **обязательно** | Количество итераций, которые будут применяться для хеширования пароля | От 4096 до 16384 | +| Название | Обязательность | Описание | Возможные значения | +|-------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| +| securityProtocol | Да | Протокол для подключения к Kafka. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | Нет | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| users | Да | Набор пользователей, которых необходимо создать | - | +| users.user | Да | Имя создаваемого пользователя | - | +| users.password | Да | Пароль создаваемого пользователя | - | +| users.mechanism | Да | Механизм аутентификации создаваемого пользователя | SCRAM-SHA-256, SCRAM-SHA-512 | +| users.iterations | Да | Количество итераций, которые будут применяться для хеширования пароля | От 4096 до 16384 | ### Учетные данные @@ -530,12 +529,12 @@ run_sca_after_clone: true ### Спецификация запроса -| Название | Обязательность | Описание | -|--------------------|-----------------|-------------------------------------------------------------------------------| -| name | **обязательно** | Название проекта в CodeScoring | -| repository | **обязательно** | URL репозитория (например, ) | -| vcs_id | **обязательно** | ID VCS системы в CodeScoring (должен быть больше 0) | -| run_sca_after_clone| опционально | Автоматический запуск SCA-анализа после клонирования репозитория | +| Название | Обязательность | Описание | +|--------------------|----------------|-------------------------------------------------------------------------------| +| name | Да | Название проекта в CodeScoring | +| repository | Да | URL репозитория (например, ) | +| vcs_id | Да | ID VCS системы в CodeScoring (должен быть больше 0) | +| run_sca_after_clone| Нет | Автоматический запуск SCA-анализа после клонирования репозитория | ### Ответ @@ -553,9 +552,9 @@ id: 1 ### Спецификация запроса -| Название | Обязательность | Описание | -|----------|-----------------|-----------------------------| -| id | **обязательно** | ID проекта в CodeScoring | +| Название | Обязательность | Описание | +|----------|----------------|-----------------------------| +| id | Да | ID проекта в CodeScoring | ## CreateKeycloakClient @@ -583,10 +582,10 @@ config: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | -|----------|-----------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| -| realm | **обязательно** | Realm в Keycloak, где требуется создать клиента | - | -| config | **обязательно** | Параметры создаваемого клиента в соответствии со спецификацией ClientRepresentation Keycloak | [Документация](https://www.keycloak.org/docs-api/latest/rest-api/index.html#ClientRepresentation) | +| Название | Обязательность | Описание | Возможные значения | +|----------|----------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| realm | Да | Realm в Keycloak, где требуется создать клиента | - | +| config | Да | Параметры создаваемого клиента в соответствии со спецификацией ClientRepresentation Keycloak | [Документация](https://www.keycloak.org/docs-api/latest/rest-api/index.html#ClientRepresentation) | ### Учетные данные @@ -613,9 +612,9 @@ manifests: ### Спецификация запроса -| Название | Обязательность | Описание | -|----------------------------|------------------|----------------------------------------------------------------------------------------------------| -| manifests | **обязательно** | Манифесты Kubernetes, которые будут применены | +| Название | Обязательность | Описание | +|----------------------------|----------------|----------------------------------------------------------------------------------------------------| +| manifests | Да | Манифесты Kubernetes, которые будут применены | ### Учетные данные @@ -645,15 +644,15 @@ values: ### Спецификация запроса -| Название | Опциональность | Описание | Значение по умолчанию | -|--------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------| -| templateRepositoryUrl | **обязательно** | URL шаблонного репозитория | - | -| targetRepositoryUrl | **обязательно** | URL репозитория, который будет создан в результате выполнения действия | - | -| values | **обязательно** | Переменные, используемые при шаблонизации, в формате `ключ: значение` | - | -| additionalIgnoreFiles | опционально | Список файлов, содержащих пути для для исключения из целевого репозитория. Заполняется по аналогии с [.templateignore](#templateignore) | - | -| sourceTag | опционально | Тег шаблонного репозитория, который будет использоваться при шаблонизации. Если не указан, используется ветка шаблонного репозитория | - | -| sourceBranch | опционально | Ветка шаблонного репозитория, которая будет использоваться при шаблонизации | main | -| targetBranch | опционально | Ветка целевого репозитория, которая будет создана в результате выполнения действия | main | +| Название | Обязательность | Описание | Значение по умолчанию | +|--------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| templateRepositoryUrl | Да | URL шаблонного репозитория | - | +| targetRepositoryUrl | Да | URL репозитория, который будет создан в результате выполнения действия | - | +| values | Да | Переменные, используемые при шаблонизации, в формате `ключ: значение` | - | +| additionalIgnoreFiles | Нет | Список файлов, содержащих пути для для исключения из целевого репозитория. Заполняется по аналогии с [.templateignore](#templateignore) | - | +| sourceTag | Нет | Тег шаблонного репозитория, который будет использоваться при шаблонизации. Если не указан, используется ветка шаблонного репозитория | - | +| sourceBranch | Нет | Ветка шаблонного репозитория, которая будет использоваться при шаблонизации | main | +| targetBranch | Нет | Ветка целевого репозитория, которая будет создана в результате выполнения действия | main | ### Учетные данные @@ -776,14 +775,14 @@ visibility: public ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию | -|-------------------------|------------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------| -| project | **обязательно** | Уникальный идентификатор проекта (Project Key) в SonarQube | - | - | -| name | **обязательно** | Название проекта, отображаемое в интерфейсе SonarQube | - | - | -| mainBranch | опционально | Название главной ветки проекта | - | master | -| newCodeDefinitionType | опционально | Метод определения «нового кода» | PREVIOUS_VERSION, NUMBER_OF_DAYS, REFERENCE_BRANCH | - | -| newCodeDefinitionValue | опционально | Значение для определения «нового кода» (например, количество дней, если тип - NUMBER_OF_DAYS) | - | - | -| visibility | опционально | Видимость проекта | private, public | private | +| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию | +|-------------------------|----------------|-------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------| +| project | Да | Уникальный идентификатор проекта (Project Key) в SonarQube | - | - | +| name | Да | Название проекта, отображаемое в интерфейсе SonarQube | - | - | +| mainBranch | Нет | Название главной ветки проекта | - | master | +| newCodeDefinitionType | Нет | Метод определения «нового кода» | PREVIOUS_VERSION, NUMBER_OF_DAYS, REFERENCE_BRANCH | - | +| newCodeDefinitionValue | Нет | Значение для определения «нового кода» (например, количество дней, если тип - NUMBER_OF_DAYS) | - | - | +| visibility | Нет | Видимость проекта | private, public | private | ### Учетные данные @@ -806,13 +805,13 @@ secrets: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | По умолчанию | -|---------------------------|------------------|-----------------------------------------------------------------|--------------------|--------------| -| path | **обязательно** | Путь, по которому будет сохранён секрет в Vault | | - | -| allow_update | опционально | Определяет поведение действия при наличии существующего секрета | true, false, merge | false | -| secrets | **обязательно** | Набор секретов, которые необходимо создать в Vault | | - | -| secrets.key | **обязательно** | Название (идентификатор) секрета | | - | -| secrets.value | **обязательно** | Значение секрета | | - | +| Название | Обязательность | Описание | Возможные значения | По умолчанию | +|---------------------------|----------------|-----------------------------------------------------------------|--------------------|--------------| +| path | Да | Путь, по которому будет сохранён секрет в Vault | | - | +| allow_update | Нет | Определяет поведение действия при наличии существующего секрета | true, false, merge | false | +| secrets | Да | Набор секретов, которые необходимо создать в Vault | | - | +| secrets.key | Да | Название (идентификатор) секрета | | - | +| secrets.value | Да | Значение секрета | | - | ### Учетные данные @@ -838,9 +837,9 @@ path: example/data/path ### Спецификация запроса -| Название | Обязательность | Описание | -|---------------------------|------------------|----------------------------------------------------------------------------------------------------| -| path | **обязательно** | Путь, по которому находится секрет в Vault, который необходимо удалить | +| Название | Обязательность | Описание | +|---------------------------|----------------|----------------------------------------------------------------------------------------------------| +| path | Да | Путь, по которому находится секрет в Vault, который необходимо удалить | ### Учетные данные @@ -858,9 +857,9 @@ id: 1 ### Спецификация запроса -| Название | Обязательность | Описание | Значение по умолчанию | -|-------------|------------------|----------------------------------------------------|------------------------| -| id | **обязательно** | Идентификатор продукта, который необходимо удалить | - | +| Название | Обязательность | Описание | Значение по умолчанию | +|-------------|----------------|----------------------------------------------------|------------------------| +| id | Да | Идентификатор продукта, который необходимо удалить | - | ### Учетные данные @@ -878,9 +877,9 @@ project_id: 0 ### Спецификация запроса -| Название | Обязательность | Описание | -|---------------------------|------------------|----------------------------------------------------------------------------------------------------| -| project_id | **обязательно** | Идентификатор проекта, который необходимо удалить | +| Название | Обязательность | Описание | +|---------------------------|----------------|----------------------------------------------------------------------------------------------------| +| project_id | Да | Идентификатор проекта, который необходимо удалить | ### Учетные данные @@ -946,30 +945,30 @@ acls: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию | -|---------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|------------------------| -| securityProtocol | **обязательно** | Протокол для подключения к Kafka. [Подробнее](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | -| saslMechanism | опционально | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. [Подробнее](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | -| acls | **обязательно** | Набор ACL, которые необходимо создать | - | - | -| acls.ops | **обязательно** | Список операций, для которых будет создано правило. | См. список возможных операций | - | -| acls.pattern | **обязательно** | Тип шаблона | См. список возможных pattern | - | -| acls.any_resource | опционально | Все ресурсы | - | false | -| acls.topics | опционально | Список из названий топиков, для которых применять правило | - | - | -| acls.any_topic | опционально | Все топики | - | false | -| acls.groups | опционально | Список из названий групп, для которых применять правило | - | - | -| acls.any_group | опционально | Все топики | - | false | -| acls.transactional_ids | опционально | Список из ID транзакций, для которых применять правило | - | - | -| acls.any_transactional_id | опционально | Любая транзакция | - | false | -| acls.tokens | опционально | Список токенов, для которых применять правило | - | - | -| acls.any_token | опционально | Все токены | - | false | -| acls.allow | опционально | Список принципалов (user, group), для которых разрешить правило | - | - | -| acls.any_allow | опционально | Любой принципал (user, group) | - | false | -| acls.allow_hosts | опционально | Список хостов, для которых разрешить операцию | - | - | -| acls.any_allow_hosts | опционально | Любой хост, с которого разрешено проводить операцию | - | false | -| acls.deny | опционально | Список принципалов (user, group), для которых запретить правило | - | - | -| acls.any_deny | опционально | Любой принципал (user, group) | - | false | -| acls.deny_hosts | опционально | Список хостов, для которых запретить операцию | - | - | -| acls.any_deny_hosts | опционально | Любой хост, с которого запрещено проводить операцию | - | false | +| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию | +|---------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|------------------------| +| securityProtocol | Да | Протокол для подключения к Kafka. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | +| saslMechanism | Нет | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | +| acls | Да | Набор ACL, которые необходимо создать | - | - | +| acls.ops | Да | Список операций, для которых будет создано правило. | [Список возможных операций](#список-возможных-операций) | - | +| acls.pattern | Да | Тип шаблона | [Список возможных шаблонов](#список-возможных-шаблонов) | - | +| acls.any_resource | Нет | Все ресурсы | - | false | +| acls.topics | Нет | Список из названий топиков, для которых применять правило | - | - | +| acls.any_topic | Нет | Все топики | - | false | +| acls.groups | Нет | Список из названий групп, для которых применять правило | - | - | +| acls.any_group | Нет | Все топики | - | false | +| acls.transactional_ids | Нет | Список из ID транзакций, для которых применять правило | - | - | +| acls.any_transactional_id | Нет | Любая транзакция | - | false | +| acls.tokens | Нет | Список токенов, для которых применять правило | - | - | +| acls.any_token | Нет | Все токены | - | false | +| acls.allow | Нет | Список принципалов (user, group), для которых разрешить правило | - | - | +| acls.any_allow | Нет | Любой принципал (user, group) | - | false | +| acls.allow_hosts | Нет | Список хостов, для которых разрешить операцию | - | - | +| acls.any_allow_hosts | Нет | Любой хост, с которого разрешено проводить операцию | - | false | +| acls.deny | Нет | Список принципалов (user, group), для которых запретить правило | - | - | +| acls.any_deny | Нет | Любой принципал (user, group) | - | false | +| acls.deny_hosts | Нет | Список хостов, для которых запретить операцию | - | - | +| acls.any_deny_hosts | Нет | Любой хост, с которого запрещено проводить операцию | - | false | ### Учетные данные @@ -985,7 +984,7 @@ acls: ### Список возможных операций -Подробное описание - [в документации Kafka](https://kafka.apache.org/39/documentation/#operations_resources_and_protocols) +Подробное описание — [в документации Kafka](https://kafka.apache.org/39/documentation/#operations_resources_and_protocols) **Topic:** @@ -1032,10 +1031,10 @@ topics: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | -|---------------------------|------------------|-----------------------------------------------------|-----------------------------------------| -| auth_type | **обязательно** | Тип авторизации в Kafka | PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512 | -| topics | **обязательно** | Список названий топиков, которые необходимо удалить | - | +| Название | Обязательность | Описание | Возможные значения | +|---------------------------|----------------|-----------------------------------------------------|-----------------------------------------| +| auth_type | Да | Тип авторизации в Kafka | PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512 | +| topics | Да | Список названий топиков, которые необходимо удалить | - | ### Учетные данные @@ -1060,13 +1059,13 @@ users: ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | -|-------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| -| securityProtocol | **обязательно** | Протокол для подключения к Kafka. [Подробнее](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | -| saslMechanism | опционально | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. [Подробнее](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | -| users | **обязательно** | Набор пользователей, которых необходимо удалить | - | -| users.user | **обязательно** | Имя удаляемого пользователя | - | -| users.mechanism | **обязательно** | Механизм аутентификации удаляемого пользователя | SCRAM-SHA-256, SCRAM-SHA-512 | +| Название | Обязательность | Описание | Возможные значения | +|-------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| +| securityProtocol | Да | Протокол для подключения к Kafka. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | Нет | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Подробнее — [в документации Kafka](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| users | Да | Набор пользователей, которых необходимо удалить | - | +| users.user | Да | Имя удаляемого пользователя | - | +| users.mechanism | Да | Механизм аутентификации удаляемого пользователя | SCRAM-SHA-256, SCRAM-SHA-512 | ### Учетные данные @@ -1089,13 +1088,13 @@ namespace: example ### Спецификация запроса -| Название | Обязательность | Описание | Возможные значения | -|---------------------------|------------------|------------------------------------------------------------------------------|----------------------------------------------------------------------| -| group | **обязательно** | API-группа ресурса. Указывает, к какой группе API относится удаляемый объект | См. определение требуемых Group и Version | -| version | **обязательно** | Версия API ресурса | См. определение требуемых Group и Version | -| resource_type | **обязательно** | Тип удаляемого ресурса | pods, services, deployments, statefulsets, daemonsets, replicasets, jobs, cronjobs, nodes, namespaces, configmaps, secrets, persistentvolumes, persistentvolumeclaims, limitranges, resourcequotas, horizontalpodautoscalers, ingresses, networkpolicies, serviceaccounts, roles, clusterroles, rolebindings, clusterrolebindings, podsecuritypolicies, storageclasses, volumeattachments, events, endpoints, customresourcedefinitions | -| resource_name | **обязательно** | Название конкретного ресурса, который необходимо удалить | - | -| namespace | **обязательно** | Неймспейс, в котором находится ресурс | - | +| Название | Обязательность | Описание | Возможные значения | +|---------------------------|-----------------|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| group | Да | API-группа ресурса. Указывает, к какой группе API относится удаляемый объект | [Определение требуемых Group и Version](#определение-требуемых-group-и-version) | +| version | Да | Версия API ресурса | [Определение требуемых Group и Version](#определение-требуемых-group-и-version) | +| resource_type | Да | Тип удаляемого ресурса | pods, services, deployments, statefulsets, daemonsets, replicasets, jobs, cronjobs, nodes, namespaces, configmaps, secrets, persistentvolumes, persistentvolumeclaims, limitranges, resourcequotas, horizontalpodautoscalers, ingresses, networkpolicies, serviceaccounts, roles, clusterroles, rolebindings, clusterrolebindings, podsecuritypolicies, storageclasses, volumeattachments, events, endpoints, customresourcedefinitions | +| resource_name | Да | Название конкретного ресурса, который необходимо удалить | - | +| namespace | Да | Неймспейс, в котором находится ресурс | - | ### Учетные данные @@ -1103,7 +1102,8 @@ namespace: example ### Определение требуемых Group и Version -Каждому типу ресурса соответствует своя версия и группа. Полный список API-ресурсов с их группами и версиями, подробнее [в документации Kubernetes](https://kubernetes.io/docs/reference/kubernetes-api/) +Каждому типу ресурса соответствует своя группа API (Group) и версия (Version). +Полный список API-ресурсов с их группами и версиями приведён [в документации Kubernetes](https://kubernetes.io/docs/reference/kubernetes-api/). Если неизвестно, какие требуются Group и Version, можно использовать актуальные значения. Существует несколько способов их определить: @@ -1143,8 +1143,9 @@ FIELDS: apiVersion: apps/v1 ``` -* **API Group** - apps -* **Version** - v1 + Здесь: + * **API Group** - apps + * **Version** - v1 ## DeleteSonarqubeProject @@ -1160,7 +1161,7 @@ project: example-project | Название | Обязательность | Описание | Значение по умолчанию | |------------------|------------------|-----------------------------------------------------------------|------------------------| -| project | **обязательно** | Идентификатор (Project Key) проекта, который необходимо удалить | - | +| project | Да | Идентификатор (Project Key) проекта, который необходимо удалить | - | ### Учетные данные @@ -1184,11 +1185,11 @@ qualifiers: TRK | Название | Обязательность | Описание | Возможные значения | Примеры значений | |--------------------|------------------|---------------------------------------------------------------------------------|-------------------------------|---------------------------------------| -| analyzedBefore | опционально | Удалить все проекты, в которых последний анализ старше определённой даты | - | 2017-10-19, 2017-10-19T13:00:00+0200 | -| onProvisionedOnly | опционально | Фильтровать проекты по значению `onProvisionedOnly` | true, false, yes, no | - | -| projects | опционально | Список ключей проектов, который необходимо удалить | - | my_project, another_project | -| q | опционально | Удалить все проекты, в названии или ключе которых содержится заданная подстрока | - | example | -| qualifiers | опционально | Фильтровать проекты по указанным квалификаторам | TRK, VW, APP | | +| analyzedBefore | Нет | Удалить все проекты, в которых последний анализ старше определённой даты | - | 2017-10-19, 2017-10-19T13:00:00+0200 | +| onProvisionedOnly | Нет | Фильтровать проекты по значению `onProvisionedOnly` | true, false, yes, no | - | +| projects | Нет | Список ключей проектов, который необходимо удалить | - | my_project, another_project | +| q | Нет | Удалить все проекты, в названии или ключе которых содержится заданная подстрока | - | example | +| qualifiers | Нет | Фильтровать проекты по указанным квалификаторам | TRK, VW, APP | | ### Учетные данные @@ -1212,11 +1213,11 @@ variables: | Название | Обязательность | Описание | |---------------------------|------------------|------------------------------------------------------------------------------| -| project_id | **обязательно** | Идентификатор проекта, в котором необходимо запустить пайплайн | -| ref | **обязательно** | Название ветки, тег или SHA-хеш коммита, на котором будет запущен пайплайн | -| variables | опционально | Список переменных, которые необходимо передать в запускаемый пайплайн | -| variables.key | **обязательно** | Название переменной | -| variables.value | **обязательно** | Значение переменной | +| project_id | Да | Идентификатор проекта, в котором необходимо запустить пайплайн | +| ref | Да | Название ветки, тег или SHA-хеш коммита, на котором будет запущен пайплайн | +| variables | Нет | Список переменных, которые необходимо передать в запускаемый пайплайн | +| variables.key | Да | Название переменной | +| variables.value | Да | Значение переменной | ### Учетные данные @@ -1258,7 +1259,7 @@ optional: | role | обязательно | Название роли, которая создаётся в Vault | | bound_service_account_names | обязательно | Список имён service account'ов, которым разрешён доступ через данную роль | | bound_service_account_namespaces | обязательно | Список пространств имён (namespaces), в которых разрешён доступ через данную роль | -| optional | необязательно | Дополнительные параметры роли (см. ниже) | +| optional | необязательно | Дополнительные параметры роли (приведены в следующей таблице) | Поддерживаемые значения в optional: @@ -1276,7 +1277,7 @@ optional: | token_no_default_policy | bool | Исключение default policy из состава токена | | token_bound_cidrs | []string | Ограничение CIDR-диапазонов, откуда можно использовать выданный токен | -Полный список поддерживаемых параметров см. в [официальной документации](https://developer.hashicorp.com/vault/docs/auth/kubernetes#parameters) HashiCorp Vault. +Полный список поддерживаемых параметров приведён в [официальной документации](https://developer.hashicorp.com/vault/docs/auth/kubernetes#parameters) HashiCorp Vault. ### Учетные данные @@ -1332,21 +1333,21 @@ docker: ### Спецификация запроса -| Поле | Обязательность | Описание | Пример | -|-------------|-----------------|------------------------------------------------------------------------------------------------------|--------------------------| -| `description` | опционально | Документация по назначению этого действия/репозитория. Не используется самим Nexus, только для UI | ... | -| `name` | **обязательно** | Название создаваемого репозитория. Должно быть уникальным в рамках Nexus | my-maven-repo | -| `format` | **обязательно** | Формат (`maven`, `docker`, `npm`, `raw`, ...) | maven | -| `type` | **обязательно** | Тип: `hosted`, `proxy` или `group` | hosted | -| `online` | **обязательно** | Доступен ли репозиторий (`true`/`false`) | true | -| `storage` | **обязательно** | Объект storage: `blobStoreName`, `strictContentTypeValidation`, `writePolicy` | см. пример выше | -| `cleanup` | опционально | Привязанные политики очистки (`policyNames`) | policyNames: [maven-cleanup] | -| `maven` | для maven | Только для maven: `versionPolicy`, `layoutPolicy` | см. пример выше | -| `proxy` | для proxy | Прокси-репозиторий: `remoteUrl`, `contentMaxAge`, `metadataMaxAge` | ... | -| `group` | для group | Список включенных memberNames | memberNames: [...] | -| `docker` | для docker | docker-specific: `httpPort`, `v1Enabled`, `forceBasicAuth` | см. пример выше | -| `component` | очень редко | Только для некоторых нестандартных сценариев | ... | -| `attributes`| опционально | Любые кастомные поля | ... | +| Поле | Обязательность | Описание | Пример | +|-------------|-----------------|---------------------------------------------------------------------------------------------------|----------------------------------------| +| `description` | Нет | Документация по назначению этого действия/репозитория. Не используется самим Nexus, только для UI | - | +| `name` | Да | Название создаваемого репозитория. Должно быть уникальным в рамках Nexus | my-maven-repo | +| `format` | Да | Формат (`maven`, `docker`, `npm`, `raw` и т.д.) | maven | +| `type` | Да | Тип: `hosted`, `proxy` или `group` | hosted | +| `online` | Да | Доступен ли репозиторий (`true`/`false`) | true | +| `storage` | Да | Объект storage: `blobStoreName`, `strictContentTypeValidation`, `writePolicy` | [Пример](#пример-запроса-maven-hosted) | +| `cleanup` | Нет | Привязанные политики очистки (`policyNames`) | policyNames: [maven-cleanup] | +| `maven` | для maven | Только для maven: `versionPolicy`, `layoutPolicy` | [Пример](#пример-запроса-maven-hosted) | +| `proxy` | для proxy | Прокси-репозиторий: `remoteUrl`, `contentMaxAge`, `metadataMaxAge` | - | +| `group` | для group | Список включенных memberNames | [Пример](#пример-запроса-docker-group) | +| `docker` | для docker | docker-specific: `httpPort`, `v1Enabled`, `forceBasicAuth` | [Пример](#пример-запроса-docker-group) | +| `component` | очень редко | Только для некоторых нестандартных сценариев | - | +| `attributes`| Нет | Любые кастомные поля | - | ### Требования @@ -1374,7 +1375,7 @@ name: my-repo-to-delete | Поле | Обязательность | Описание | |------|-----------------|------------------------------------------| -| `name` | **обязательно** | Название репозитория, который требуется удалить | +| `name` | Да | Название репозитория, который требуется удалить | ### Алгоритм @@ -1429,18 +1430,18 @@ actions: ### Спецификация запроса -| Поле | Обязательность | Описание | -|------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------| -| name | **обязательно** | Название создаваемой привилегии. Должно быть уникальным в рамках Nexus | -| description | опционально | Описание привилегии | -| type | **обязательно** | Тип привилегии: `repository-view`, `repository-content-selector`, `repository-admin`, `application`, `wildcard` | -| actions | опционально | Список действий, разрешённых привилегией (например, `READ`, `BROWSE`, `CREATE`, `UPDATE`, `DELETE`) | -| format | опционально | Формат репозитория (например, `maven2`, `docker`, `npm`). Используется для типов `repository-view`, `repository-content-selector`, `repository-admin` | -| repository | опционально | Название репозитория. Используется для типов `repository-view`, `repository-content-selector`, `repository-admin` | -| contentSelector | опционально | Название селектора контента. Обязателен для типа `repository-content-selector`. Если не указан или невалиден, тип автоматически преобразуется в `repository-view` | -| pattern | опционально | Паттерн для типа `wildcard` | -| domain | опционально | Домен для типа `application` | -| attributes | опционально | Дополнительные атрибуты в формате ключ-значение | +| Поле | Обязательность | Описание | +|------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | Да | Название создаваемой привилегии. Должно быть уникальным в рамках Nexus | +| description | Нет | Описание привилегии | +| type | Да | Тип привилегии: `repository-view`, `repository-content-selector`, `repository-admin`, `application`, `wildcard` | +| actions | Нет | Список действий, разрешённых привилегией (например, `READ`, `BROWSE`, `CREATE`, `UPDATE`, `DELETE`) | +| format | Нет | Формат репозитория (например, `maven2`, `docker`, `npm`). Используется для типов `repository-view`, `repository-content-selector`, `repository-admin` | +| repository | Нет | Название репозитория. Используется для типов `repository-view`, `repository-content-selector`, `repository-admin` | +| contentSelector | Нет | Название селектора контента. Обязателен для типа `repository-content-selector`. Если не указан или невалиден, тип автоматически преобразуется в `repository-view` | +| pattern | Нет | Шаблон для типа `wildcard` | +| domain | Нет | Домен для типа `application` | +| attributes | Нет | Дополнительные атрибуты в формате ключ-значение | ### Примечание @@ -1467,8 +1468,8 @@ privileges: | Поле | Обязательность | Описание | |------------|-----------------|------------------------------------------------------------------------------| -| roleId | **обязательно** | Идентификатор роли, которой назначаются привилегии | -| privileges | **обязательно** | Список названий привилегий, которые необходимо назначить роли | +| roleId | Да | Идентификатор роли, которой назначаются привилегии | +| privileges | Да | Список названий привилегий, которые необходимо назначить роли | ### Алгоритм работы @@ -1498,7 +1499,7 @@ name: example-privilege | Поле | Обязательность | Описание | |------|-----------------|---------------------------------------------| -| name | **обязательно** | Название привилегии, которую требуется удалить | +| name | Да | Название привилегии, которую требуется удалить | ### Учетные данные @@ -1524,11 +1525,11 @@ roles: [] | Поле | Обязательность | Описание | |-------------|-----------------|------------------------------------------------------------------------------| -| id | **обязательно** | Уникальный идентификатор роли | -| name | **обязательно** | Название роли | -| description | опционально | Описание роли | -| privileges | опционально | Список названий привилегий, которые назначаются роли | -| roles | опционально | Список идентификаторов других ролей, которые включаются в данную роль | +| id | Да | Уникальный идентификатор роли | +| name | Да | Название роли | +| description | Нет | Описание роли | +| privileges | Нет | Список названий привилегий, которые назначаются роли | +| roles | Нет | Список идентификаторов других ролей, которые включаются в данную роль | ### Учетные данные @@ -1551,8 +1552,8 @@ roles: | Поле | Обязательность | Описание | |--------|-----------------|---------------------------------------------------------------| -| userId | **обязательно** | Идентификатор пользователя, которому назначаются роли | -| roles | **обязательно** | Список идентификаторов ролей, которые необходимо назначить пользователю | +| userId | Да | Идентификатор пользователя, которому назначаются роли | +| roles | Да | Список идентификаторов ролей, которые необходимо назначить пользователю | ### Алгоритм работы @@ -1582,7 +1583,7 @@ id: example-role | Поле | Обязательность | Описание | |------|-----------------|-----------------------------------------| -| id | **обязательно** | Идентификатор роли, которую требуется удалить | +| id | Да | Идентификатор роли, которую требуется удалить | ### Учетные данные @@ -1609,13 +1610,13 @@ roles: | Поле | Обязательность | Описание | |-------------|-----------------|------------------------------------------------------------------------------| -| userId | **обязательно** | Уникальный идентификатор пользователя | -| firstName | **обязательно** | Имя пользователя | -| lastName | **обязательно** | Фамилия пользователя | -| emailAddress| **обязательно** | Email-адрес пользователя | -| password | **обязательно** | Пароль пользователя | -| status | **обязательно** | Статус пользователя: `active` или `disabled` | -| roles | опционально | Список идентификаторов ролей, которые назначаются пользователю при создании | +| userId | Да | Уникальный идентификатор пользователя | +| firstName | Да | Имя пользователя | +| lastName | Да | Фамилия пользователя | +| emailAddress| Да | Email-адрес пользователя | +| password | Да | Пароль пользователя | +| status | Да | Статус пользователя: `active` или `disabled` | +| roles | Нет | Список идентификаторов ролей, которые назначаются пользователю при создании | ### Учетные данные @@ -1635,8 +1636,28 @@ userId: example-user | Поле | Обязательность | Описание | |--------|-----------------|---------------------------------------------| -| userId | **обязательно** | Идентификатор пользователя, которого требуется удалить | +| userId | Да | Идентификатор пользователя, которого требуется удалить | ### Учетные данные * **token** — строка base64(`admin:password`), используется как Basic Auth при запросах к Nexus. + +## Wait + +Wait - ожидает заданное количество секунд (с опциональной случайной добавкой — джиттером). Предназначено для использования в процессах в качестве элемента задержки, например для ожидания применения результатов предыдущего действия. + +### Пример запроса + +```yaml +duration_seconds: 10 +max_jitter_seconds: 0 +description: "Waiting for release" +``` + +### Спецификация запроса + +| Название | Обязательность | Описание | Значение по умолчанию | +|---------------------|----------------|----------------------------------------------------------------------------------|-----------------------| +| duration_seconds | Да | Базовая длительность ожидания в секундах (0–86400, т. е. до 24 часов) | - | +| max_jitter_seconds | Нет | Максимальная случайная добавка к ожиданию в секундах (0–N). 0 — джиттер отключён | 0 | +| description | Нет | Описание для отображения в логах и ответе действия | - | diff --git a/content/documentation/release-notes/v1.4.0.ru.md b/content/documentation/release-notes/v1.4.0.ru.md index 72c2fde..2eca0b4 100644 --- a/content/documentation/release-notes/v1.4.0.ru.md +++ b/content/documentation/release-notes/v1.4.0.ru.md @@ -7,6 +7,12 @@ weight: 930 Выпуск релиза планируется 06.04.2026 {{< /alert >}} +## Новые возможности + +### Действия + +- **Wait** — добавлено действие для паузы на заданное время ([подробнее](../../admin/actions/types/#wait)). + ## Исправленные проблемы - Исправлена синхронизация источников данных при отсутствующих правилах сопоставления: удаление несуществующих сущностей, обновление параметров или создание связей сущностей теперь запускается только при наличии хотя бы одного правила сопоставления. Создание новых сущностей остается возможным, даже если правила сопоставления не заданы.