This is an automated email from the ASF dual-hosted git repository.
traky pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new c8db32045 docs: update description for hide_cache_headers (#11026)
c8db32045 is described below
commit c8db32045e10b82458916fd081cc4c6fb1996f4e
Author: Traky Deng <[email protected]>
AuthorDate: Tue Mar 12 11:55:07 2024 -0600
docs: update description for hide_cache_headers (#11026)
---
docs/en/latest/plugins/proxy-cache.md | 2 +-
docs/zh/latest/plugins/proxy-cache.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/en/latest/plugins/proxy-cache.md
b/docs/en/latest/plugins/proxy-cache.md
index 8b31baa46..2cd5ec5ca 100644
--- a/docs/en/latest/plugins/proxy-cache.md
+++ b/docs/en/latest/plugins/proxy-cache.md
@@ -41,7 +41,7 @@ The data to be cached can be filtered with response codes,
request modes, or mor
| cache_bypass | array[string] | False | |
| Conditions in which response from cache is bypassed.
Whether to skip cache retrieval. If at least one value of the string parameters
is not empty and is not equal to `0` then the response will not be taken from
the cache. For example, `["$arg_bypass"]`.
|
| cache_method | array[string] | False | ["GET", "HEAD"] |
["GET", "POST", "HEAD"] | Request methods for which the response will be
cached.
|
| cache_http_status | array[integer] | False | [200, 301, 404] |
[200, 599] | HTTP status codes of the Upstream response for which
the response will be cached.
|
-| hide_cache_headers | boolean | False | false |
| When set to `true` adds the `Expires` and
`Cache-Control` headers to the client response.
|
+| hide_cache_headers | boolean | False | false |
| When set to `true`, hide the `Expires` and
`Cache-Control` response headers.
|
| cache_control | boolean | False | false |
| When set to `true`, complies with Cache-Control
behavior in the HTTP specification. Used only for memory strategy.
|
| no_cache | array[string] | False | |
| Conditions in which the response will not be cached.
If at least one value of the string parameters is not empty and is not equal to
`0` then the response will not be saved.
|
| cache_ttl | integer | False | 300 seconds |
| Time that a response is cached until it is deleted or
refreshed. Comes in to effect when the `cache_control` attribute is not enabled
or the proxied server does not return cache header. Used only for memory
strategy.
|
diff --git a/docs/zh/latest/plugins/proxy-cache.md
b/docs/zh/latest/plugins/proxy-cache.md
index ca4bea58b..b39f3990f 100644
--- a/docs/zh/latest/plugins/proxy-cache.md
+++ b/docs/zh/latest/plugins/proxy-cache.md
@@ -40,7 +40,7 @@ description: 本文介绍了 Apache APISIX proxy-cache 插件的相关操作,
| cache_bypass | array[string] | 否 | |
|
当该属性的值不为空或者非 `0` 时则会跳过缓存检查,即不在缓存中查找数据,可以使用变量,例如:`["$arg_bypass"]`。 |
| cache_method | array[string] | 否 | ["GET", "HEAD"] |
["GET", "POST", "HEAD"] | 根据请求 method 决定是否需要缓存。
|
| cache_http_status | array[integer] | 否 | [200, 301, 404] |
[200, 599]
| 根据 HTTP 响应码决定是否需要缓存。
|
-| hide_cache_headers | boolean | 否 | false |
|
当设置为 `true` 时将 `Expires` 和 `Cache-Control` 响应头返回给客户端。
|
+| hide_cache_headers | boolean | 否 | false |
|
当设置为 `true` 时不将 `Expires` 和 `Cache-Control` 响应头返回给客户端。
|
| cache_control | boolean | 否 | false |
|
当设置为 `true` 时遵守 HTTP 协议规范中的 `Cache-Control` 的行为。
|
| no_cache | array[string] | 否 | |
|
当此参数的值不为空或非 `0` 时将不会缓存数据,可以使用变量。
|
| cache_ttl | integer | 否 | 300 秒 |
| 当选项
`cache_control` 未开启或开启以后服务端没有返回缓存控制头时,提供的默认缓存时间。 |