You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/04/10 00:41:58 UTC
[GitHub] [apisix] Firstsawyou commented on a change in pull request #4016: docs(admin-api): increase the introduction of the use of cookies
Firstsawyou commented on a change in pull request #4016:
URL: https://github.com/apache/apisix/pull/4016#discussion_r610963014
##########
File path: docs/en/latest/admin-api.md
##########
@@ -555,7 +559,7 @@ In addition to the basic complex equalization algorithm selection, APISIX's Upst
1. when it is `vars`, the `key` is required. The `key` can be any [Nginx builtin variables](http://nginx.org/en/docs/varindex.html), without the prefix '$'.
1. when it is `header`, the `key` is required. It is equal to "http_`key`".
-1. when it is `cookie`, the `key` is required. It is equal to "cookie_`key`".
+1. when it is `cookie`, the `key` is required. It is equal to "cookie_`key`". Note: The cookie name is case-sensitive. For example: "cookie\_`x_foo`" and "cookie\_`X_Foo`" means to get different `cookie`.
Review comment:
Updated.
##########
File path: docs/en/latest/admin-api.md
##########
@@ -94,7 +94,11 @@ Note: When the `Admin API` is enabled, it will occupy the API prefixed with `/ap
| create_time | False | Auxiliary | epoch timestamp in second, will be created automatically if missing | 1602883670 |
| update_time | False | Auxiliary | epoch timestamp in second, will be created automatically if missing | 1602883670 |
-For the same type of parameters, such as `host` and `hosts`, `remote_addr` and `remote_addrs` cannot exist at the same time, only one of them can be selected. If enabled at the same time, the API will respond with an error.
+There are three points that need special attention:
+
+- In addition to the required `uri`/`uris`, you must select at least one of the four categories `plugin`, `script`, `upstream`/`upstream_id` and `service_id`.
Review comment:
Thanks for reminding, it has been updated.
##########
File path: docs/en/latest/admin-api.md
##########
@@ -94,7 +94,11 @@ Note: When the `Admin API` is enabled, it will occupy the API prefixed with `/ap
| create_time | False | Auxiliary | epoch timestamp in second, will be created automatically if missing | 1602883670 |
| update_time | False | Auxiliary | epoch timestamp in second, will be created automatically if missing | 1602883670 |
-For the same type of parameters, such as `host` and `hosts`, `remote_addr` and `remote_addrs` cannot exist at the same time, only one of them can be selected. If enabled at the same time, the API will respond with an error.
+There are three points that need special attention:
+
+- In addition to the required `uri`/`uris`, you must select at least one of the four categories `plugin`, `script`, `upstream`/`upstream_id` and `service_id`.
+- For the same type of parameters, such as `host` and `hosts`, `remote_addr` and `remote_addrs` cannot exist at the same time, only one of them can be selected. If enabled at the same time, the API will respond with an error.
+- When using `vars`, obtaining the value of `cookie` is case-sensitive. For example: `var` is "cookie\_`x_foo`" and `var` is "cookie\_`X_Foo`" means to get different `cookie`.
Review comment:
Updated.
--
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