From 8717124474c5fe71ba0ca64175eef2a82b46f92a Mon Sep 17 00:00:00 2001 From: manan164 <1897158+manan164@users.noreply.github.com> Date: Wed, 20 Sep 2023 22:07:06 +0530 Subject: [PATCH 1/2] Update secret task --- .../reference-docs/operators/update-secret.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/reference-docs/operators/update-secret.md diff --git a/docs/reference-docs/operators/update-secret.md b/docs/reference-docs/operators/update-secret.md new file mode 100644 index 00000000..103e95a3 --- /dev/null +++ b/docs/reference-docs/operators/update-secret.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 14 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Update Secret + +Update Secret is used to update value of any secret given the user has permission to update the secret. + +## Definitions + +```json +{ + "name": "update_secret_task", + "taskReferenceName": "update_secret_task_ref", + "type": "UPDATE_SECRET", + "inputParameters": { + "_secrets": { + "secretKey" : "my_secret", + "secretValue" : "1234" + } + } +} +``` + +### Input Parameters + +| Attributes | Description | +|-------------|-------------------------| +| secretKey | name of the secret key | +| secretValue | value of the secret key | + +**Notes** +1. User must have update permission over the secretKey otherwise workflow will be terminated with 403 error. +2. If the secret does not exist by the secretKey, it will be created and the value will be as per the secretValue + + From b3bcd6b4f123b8309c128f36512db09cf298c294 Mon Sep 17 00:00:00 2001 From: manan164 <1897158+manan164@users.noreply.github.com> Date: Wed, 20 Sep 2023 22:36:52 +0530 Subject: [PATCH 2/2] notes --- docs/reference-docs/operators/update-secret.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/reference-docs/operators/update-secret.md b/docs/reference-docs/operators/update-secret.md index 103e95a3..35f90ba6 100644 --- a/docs/reference-docs/operators/update-secret.md +++ b/docs/reference-docs/operators/update-secret.md @@ -35,5 +35,6 @@ Update Secret is used to update value of any secret given the user has permissio **Notes** 1. User must have update permission over the secretKey otherwise workflow will be terminated with 403 error. 2. If the secret does not exist by the secretKey, it will be created and the value will be as per the secretValue +3. Only one secret can be updated at a time.