Apply suggestions from code review

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>
This commit is contained in:
Tiago Alves Macambira 2023-07-05 13:33:12 -07:00 committed by GitHub
parent 4920dfd830
commit 6e088d1659
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 15 additions and 12 deletions

View File

@ -34,8 +34,11 @@ Some secret stores have support for **optional** per-request metadata properties
GET http://localhost:<daprPort>/v1.0/secrets/<secret-store-name>/<name>?metadata.version_id=15 GET http://localhost:<daprPort>/v1.0/secrets/<secret-store-name>/<name>?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. Observe that not all secret stores support the same set of parameters. For example:
Check each secret store's documentation for the list of supported parameters. - 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.

View File

@ -45,12 +45,12 @@ The above example uses secrets as plain strings. It is recommended to use a loca
## Optional per-request metadata properties ## 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 Query Parameter | Description
--------- | ----------- --------- | -----------
`metadata.version_id` | version for the given secret key `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.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 ## Create an AlibabaCloud OOS Parameter Store instance

View File

@ -54,8 +54,8 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters"
Query Parameter | Description Query Parameter | Description
--------- | ----------- --------- | -----------
`metadata.version_id` | version for the given secret key `metadata.version_id` | Version for the given secret key.
`metadata.version_stage` | version stage for the given secret key `metadata.version_stage` | Version stage for the given secret key.
## Create an AWS Secrets Manager instance ## Create an AWS Secrets Manager instance

View File

@ -59,8 +59,8 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters"
Query Parameter | Description Query Parameter | Description
--------- | ----------- --------- | -----------
`metadata.version_id` | version for the given secret key `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.maxresults` | (For bulk requests only) Number of secrets to return, after which the request will be truncated.
## Example ## Example

View File

@ -67,7 +67,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters"
Query Parameter | Description 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 ## Setup GCP Secret Manager instance

View File

@ -72,7 +72,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters"
Query Parameter | Description 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 ## Setup Hashicorp Vault instance

View File

@ -46,7 +46,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters"
Query Parameter | Description 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 ## Setup HuaweiCloud Cloud Secret Management Service (CSMS) instance