shreemaan-abhishek commented on code in PR #10874: URL: https://github.com/apache/apisix/pull/10874#discussion_r1498622795
##########
docs/en/latest/plugins/limit-req.md:
##########
@@ -33,16 +33,30 @@ The `limit-req` Plugin limits the number of requests to
your service using the [
## Attributes
-| Name | Type | Required | Default | Valid values
| Description
|
-|-------------------|---------|----------|---------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| rate | integer | True | | rate > 0
| Threshold for number of requests per second. Requests exceeding this rate
(and below `burst`) will be delayed to match this rate.
|
-| burst | integer | True | | burst >= 0
| Number of additional requests allowed to be delayed per second. If the
number of requests exceeds this hard limit, they will get rejected immediately.
|
-| key_type | string | False | "var" | ["var",
"var_combination"] | Type of user specified key to use.
|
-| key | string | True | | ["remote_addr",
"server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"] |
User specified key to base the request limiting on. If the `key_type` attribute
is set to `var`, the key will be treated as a name of variable, like
`remote_addr` or `consumer_name`. If the `key_type` is set to
`var_combination`, the key will be a combination of variables, like
`$remote_addr $consumer_name`. If the value of the key is empty, `remote_addr`
will be set as the default key. |
-| rejected_code | integer | False | 503 | [200,...,599]
| HTTP status code returned when the requests exceeding the threshold are
rejected.
|
-| rejected_msg | string | False | | non-empty
| Body of the response returned when the requests exceeding the threshold are
rejected.
|
-| nodelay | boolean | False | false |
| If set to `true`, requests within the burst threshold would not be delayed.
|
-| allow_degradation | boolean | False | false |
| When set to `true` enables Plugin degradation when the Plugin is temporarily
unavailable and allows requests to continue.
|
+| Name | Type | Required | Default | Valid values
| Description
|
+|--------------------------|---------| --------
|-------------|-----------------------------------|
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
+| conn | integer | True | | conn > 0
| Maximum number of concurrent requests allowed. Requests
exceeding this ratio (and below `conn` + `burst`) will be delayed (configured
by `default_conn_delay`).
|
Review Comment:
conn?
##########
docs/en/latest/plugins/limit-req.md:
##########
@@ -33,16 +33,30 @@ The `limit-req` Plugin limits the number of requests to
your service using the [
## Attributes
-| Name | Type | Required | Default | Valid values
| Description
|
-|-------------------|---------|----------|---------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| rate | integer | True | | rate > 0
| Threshold for number of requests per second. Requests exceeding this rate
(and below `burst`) will be delayed to match this rate.
|
-| burst | integer | True | | burst >= 0
| Number of additional requests allowed to be delayed per second. If the
number of requests exceeds this hard limit, they will get rejected immediately.
|
-| key_type | string | False | "var" | ["var",
"var_combination"] | Type of user specified key to use.
|
-| key | string | True | | ["remote_addr",
"server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"] |
User specified key to base the request limiting on. If the `key_type` attribute
is set to `var`, the key will be treated as a name of variable, like
`remote_addr` or `consumer_name`. If the `key_type` is set to
`var_combination`, the key will be a combination of variables, like
`$remote_addr $consumer_name`. If the value of the key is empty, `remote_addr`
will be set as the default key. |
-| rejected_code | integer | False | 503 | [200,...,599]
| HTTP status code returned when the requests exceeding the threshold are
rejected.
|
-| rejected_msg | string | False | | non-empty
| Body of the response returned when the requests exceeding the threshold are
rejected.
|
-| nodelay | boolean | False | false |
| If set to `true`, requests within the burst threshold would not be delayed.
|
-| allow_degradation | boolean | False | false |
| When set to `true` enables Plugin degradation when the Plugin is temporarily
unavailable and allows requests to continue.
|
+| Name | Type | Required | Default | Valid values
| Description
|
+|--------------------------|---------| --------
|-------------|-----------------------------------|
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
+| conn | integer | True | | conn > 0
| Maximum number of concurrent requests allowed. Requests
exceeding this ratio (and below `conn` + `burst`) will be delayed (configured
by `default_conn_delay`).
|
+| burst | integer | True | | burst >= 0
| Number of additional concurrent requests allowed to be
delayed per second. If the number exceeds this hard limit, they will get
rejected immediately.
|
Review Comment:
please check the docs, it has unrelated changes
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
