Merge branch 'docs-secret' of https://github.com/HuanXin-Chen/apisix …

…into docs-secret
apache · Sep 17, 2024 · 9396f39 · 9396f39
2 parents 13e1f9a + 1348982
commit 9396f39
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md
@@ -1459,7 +1459,7 @@ Secret resource request address: /apisix/admin/secrets/{secretmanager}/{id}
 
 ### Request Body Parameters
 
-When `{secretmanager}` is `vault`:
+#### When Secret Manager is Vault
 
 | Parameter   | Required | Type        | Description                                                                                                        | Example                                          |
 | ----------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |
@@ -1497,15 +1497,15 @@ HTTP/1.1 200 OK
 {"key":"\/apisix\/secrets\/vault\/test2","value":{"id":"vault\/test2","token":"apisix","prefix":"apisix","update_time":1669625828,"create_time":1669625828,"uri":"http:\/\/xxx\/get"}}
 ```
 
-When `{secretmanager}` is `aws`:
+#### When Secret Manager is AWS
 
 | Parameter | Required | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | access_key_id | True | string | AWS Access Key ID |  |
 | secret_access_key | True | string | AWS Secret Access Key |  |
 | session_token | False | string | Temporary access credential information |  |
 | region | False | string | AWS Region |  |
-| endpoint_url | False | URI | AWS Secret Manager URL | https://secretsmanagerus-east-1.amazonaws.com |
+| endpoint_url | False | URI | AWS Secret Manager URL | https://secretsmanager.{region}.amazonaws.com |
 
 Example Configuration:
 
@@ -1540,7 +1540,7 @@ HTTP/1.1 200 OK
 {"value":{"create_time":1726069970,"endpoint_url":"http://127.0.0.1:4566","region":"us-east-1","access_key_id":"access","secret_access_key":"secret","id":"aws/test3","update_time":1726069970,"session_token":"token"},"key":"/apisix/secrets/aws/test3"}
 ```
 
-When `{secretmanager}` is `gcp`:
+#### When Secret Manager is GCP
 
 | Parameter | Required | Type | Description | Example |
 | --- | --- | --- | --- | --- |

diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md
@@ -1469,7 +1469,7 @@ Secret 资源请求地址：/apisix/admin/secrets/{secretmanager}/{id}
 
 ### body 请求参数 {#secret-config-body-requset-parameters}
 
-当 `{secretmanager}` 是 `vault` 时：
+#### 当 Secret Manager 是 Vault 时
 
 | 名称  | 必选项 | 类型        | 描述                                                                                                        | 例子                                          |
 | ----------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |
@@ -1508,7 +1508,7 @@ HTTP/1.1 200 OK
 {"key":"\/apisix\/secrets\/vault\/test2","value":{"id":"vault\/test2","token":"apisix","prefix":"apisix","update_time":1669625828,"create_time":1669625828,"uri":"http:\/\/xxx\/get"}}
 ```
 
-当 `{secretmanager}` 是 `aws` 时：
+#### 当 Secret Manager 是 AWS 时
 
 | 名称 | 必选项 | 默认值 | 描述 |
 | --- | --- | --- | --- |
@@ -1552,7 +1552,7 @@ HTTP/1.1 200 OK
 {"value":{"create_time":1726069970,"endpoint_url":"http://127.0.0.1:4566","region":"us-east-1","access_key_id":"access","secret_access_key":"secret","id":"aws/test3","update_time":1726069970,"session_token":"token"},"key":"/apisix/secrets/aws/test3"}
 ```
 
-当 `{secretmanager}` 是 `gcp` 时：
+#### 当 Secret Manager 是 GCP 时
 
 | 名称                     | 必选项   | 默认值                                           | 描述                                                                                                                             |
 | ----------------------- | -------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------  |