You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2021/03/31 02:34:54 UTC
[apisix] branch master updated: docs: ret_code type in plugin
redirect should be integer (#3940)
This is an automated email from the ASF dual-hosted git repository.
spacewander 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 562841b docs: ret_code type in plugin redirect should be integer (#3940)
562841b is described below
commit 562841ba30c2dc24b39a6f5f7635a6a31b59c95e
Author: Dashuang Li <ld...@gmail.com>
AuthorDate: Wed Mar 31 10:34:43 2021 +0800
docs: ret_code type in plugin redirect should be integer (#3940)
---
docs/en/latest/plugins/redirect.md | 2 +-
docs/zh/latest/plugins/redirect.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/en/latest/plugins/redirect.md b/docs/en/latest/plugins/redirect.md
index e6f867d..d04ee65 100644
--- a/docs/en/latest/plugins/redirect.md
+++ b/docs/en/latest/plugins/redirect.md
@@ -39,7 +39,7 @@ URI redirect.
| ------------- | ------- | ----------- | ------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| http_to_https | boolean | optional | false | | When it is set to `true` and the request is HTTP, will be automatically redirected to HTTPS with 301 response code, and the URI will keep the same as client request. |
| uri | string | optional | | | New URL which can contain Nginx variable, eg: `/test/index.html`, `$uri/index.html`. You can refer to variables in a way similar to `${xxx}` to avoid ambiguity, eg: `${uri}foo/index.html`. If you just need the original `$` character, add `\` in front of it, like this one: `/\$foo/index.html`. If you refer to a variable name that does not exist, this will not produce an error, and it will be used as an empty string. |
-| ret_code | string | optional | 302 | [200, ...] | Response code |
+| ret_code | integer | optional | 302 | [200, ...] | Response code |
Only one of `http_to_https` or `uri` can be specified.
diff --git a/docs/zh/latest/plugins/redirect.md b/docs/zh/latest/plugins/redirect.md
index 277d76c..f20e379 100644
--- a/docs/zh/latest/plugins/redirect.md
+++ b/docs/zh/latest/plugins/redirect.md
@@ -29,7 +29,7 @@ URI 重定向插件。
| ------------- | ------- | ----------- | ------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| http_to_https | boolean | 可选 | false | | 当设置为 `true` 并且请求是 http 时，会自动 301 重定向为 https，uri 保持不变 |
| uri | string | 可选 | | | 可以包含 Nginx 变量的 URI，例如：`/test/index.html`, `$uri/index.html`。你可以通过类似于 `$ {xxx}` 的方式引用变量，以避免产生歧义，例如：`${uri}foo/index.html`。若你需要保留 `$` 字符，那么使用如下格式：`/\$foo/index.html` |
-| ret_code | string | 可选 | 302 | [200, ...] | 请求响应码 |
+| ret_code | integer | 可选 | 302 | [200, ...] | 请求响应码 |
`http_to_https` 和 `uri` 两个中只能配置一个。