[GitHub] [apisix] tokers commented on a change in pull request #4244: feat: support uri encoding in redirect

[GitBox <gi...@apache.org>]

tokers commented on a change in pull request #4244:
URL: https://github.com/apache/apisix/pull/4244#discussion_r632220841



##########
File path: docs/en/latest/plugins/redirect.md
##########
@@ -41,8 +41,9 @@ URI redirect.
 | 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. |
 | regex_uri | array[string] | optional    |         |                   | Use regular expression to match URL from client, when the match is successful, the URL template will be redirected to. If the match is not successful, the URL from the client will be forwarded to the upstream. Only one of `uri` and `regex_uri` can be exist. For example: [" ^/iresty/(.*)/(.*)/(.*)", "/$1-$2-$3"], the first element represents the matching regular expression and the second element represents the URL template that is redirected to. |
 | ret_code      | integer | optional    | 302     |  [200, ...]     | Response code                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| encode_uri    | boolean | optional    | false   |       | When set to `true` the uri in `Location` header will be encoded.                                                                                                                                                                                                                         |

Review comment:
       We may tell people the encoding rule, for instance:
   
   ```suggestion
   | encode_uri    | boolean | optional    | false   |       | When set to `true` the uri in `Location` header will be encoded as per [RFC3986](https://datatracker.ietf.org/doc/html/rfc3986)|
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org