tokers commented on a change in pull request #4395:
URL: https://github.com/apache/apisix/pull/4395#discussion_r648204533
##########
File path: docs/en/latest/plugins/limit-req.md
##########
@@ -42,6 +42,7 @@ limit request rate using the "leaky bucket" method.
| burst | integer | required | | burst >= 0
| the number of excessive
requests per second allowed to be delayed. Requests exceeding this hard limit
will get rejected immediately. |
| key | string | required | | ["remote_addr",
"server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"] | the
user specified key to limit the rate, now accept those as key:
"remote_addr"(client's IP), "server_addr"(server's IP),
"X-Forwarded-For/X-Real-IP" in request header, "consumer_name"(consumer's
username). |
| rejected_code | integer | optional | 503 | [200,...,599]
| The HTTP status code returned
when the request exceeds the threshold is rejected.
|
+| nodelay | boolean | optional | false |
| If nodelay flag is true, the
specified request will not get delayed |
Review comment:
```suggestion
| nodelay | boolean | optional | false |
| If nodelay flag is true,
bursted requests will not get delayed |
```
##########
File path: docs/zh/latest/plugins/limit-req.md
##########
@@ -42,6 +42,7 @@ title: limit-req
| burst | integer | 必须 | | burst >= 0
| t请求速率超过 （`rate` + `brust`）的请求会被直接拒绝。
|
| key | string | 必须 | | ["remote_addr", "server_addr",
"http_x_real_ip", "http_x_forwarded_for", "consumer_name"] | 用来做请求计数的依据，当前接受的
key 有："remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For"
或 "X-Real-IP"，"consumer_name"(consumer 的 username)。 |
| rejected_code | integer | 可选 | 503 | [200,...,599]
| 当请求超过阈值被拒绝时，返回的 HTTP 状态码。
|
+| nodelay | boolean | 可选 | false |
| 如果nodelay为false， 则满足条件的请求不会加上延迟 |
Review comment:
`满足条件` is too general, could you use some more detailed descriptions?
--
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:
[email protected]
