diff --git a/daprdocs/content/en/reference/api/secrets_api.md b/daprdocs/content/en/reference/api/secrets_api.md index 4403d80b9..d67489d00 100644 --- a/daprdocs/content/en/reference/api/secrets_api.md +++ b/daprdocs/content/en/reference/api/secrets_api.md @@ -34,8 +34,11 @@ Some secret stores have support for **optional** per-request metadata properties GET http://localhost:/v1.0/secrets//?metadata.version_id=15 ``` -Observe that not all secret stores support the same set of parameters. For instance, both Hashicorp Vault, GCP Secret Manager and AWS Secret Manager support the `version_id` parameter, but only AWS Secret Manager supports the `version_stage` parameter and only Kubernetes Secrets supports the `namespace` parameter. -Check each secret store's documentation for the list of supported parameters. +Observe that not all secret stores support the same set of parameters. For example: +- Hashicorp Vault, GCP Secret Manager, and AWS Secret Manager support the `version_id` parameter +- Only AWS Secret Manager supports the `version_stage` parameter +- Only Kubernetes Secrets supports the `namespace` parameter +Check each [secret store's documentation]({{< ref supported-secret-stores.md >}}) for the list of supported parameters. diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md index cfd73cb6a..39c4493a0 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md @@ -45,12 +45,12 @@ The above example uses secrets as plain strings. It is recommended to use a loca ## Optional per-request metadata properties -The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store: +The following [optional query parameters]({{< ref "secrets_api.md#query-parameters" >}}) can be provided when retrieving secrets from this secret store: Query Parameter | Description --------- | ----------- -`metadata.version_id` | version for the given secret key -`metadata.path` | (For bulk requests only) the path from the metadata. If not set means root path (all secrets). +`metadata.version_id` | Version for the given secret key +`metadata.path` | (For bulk requests only) The path from the metadata. If not set, defaults to root path (all secrets). ## Create an AlibabaCloud OOS Parameter Store instance diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/aws-secret-manager.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/aws-secret-manager.md index a0f2b9b01..1a7063880 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/aws-secret-manager.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/aws-secret-manager.md @@ -54,8 +54,8 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters" Query Parameter | Description --------- | ----------- -`metadata.version_id` | version for the given secret key -`metadata.version_stage` | version stage for the given secret key +`metadata.version_id` | Version for the given secret key. +`metadata.version_stage` | Version stage for the given secret key. ## Create an AWS Secrets Manager instance diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md index f008b2ff4..57286c1b3 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/azure-keyvault.md @@ -59,8 +59,8 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters" Query Parameter | Description --------- | ----------- -`metadata.version_id` | version for the given secret key -`metadata.maxresults` | (For bulk requests only) number of secrets to return after which the request will be truncated. +`metadata.version_id` | Version for the given secret key. +`metadata.maxresults` | (For bulk requests only) Number of secrets to return, after which the request will be truncated. ## Example diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/gcp-secret-manager.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/gcp-secret-manager.md index b485e6b42..c0e8ca400 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/gcp-secret-manager.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/gcp-secret-manager.md @@ -67,7 +67,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters" Query Parameter | Description --------- | ----------- -`metadata.version_id` | version for the given secret key +`metadata.version_id` | Version for the given secret key. ## Setup GCP Secret Manager instance diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md index a2f78b02a..d73ba7db0 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md @@ -72,7 +72,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters" Query Parameter | Description --------- | ----------- -`metadata.version_id` | version for the given secret key +`metadata.version_id` | Version for the given secret key. ## Setup Hashicorp Vault instance diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/huaweicloud-csms.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/huaweicloud-csms.md index effdda940..329a12961 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/huaweicloud-csms.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/huaweicloud-csms.md @@ -46,7 +46,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters" Query Parameter | Description --------- | ----------- -`metadata.version_id` | version for the given secret key +`metadata.version_id` | Version for the given secret key. ## Setup HuaweiCloud Cloud Secret Management Service (CSMS) instance