|
5543 | 5543 | "properties": {
|
5544 | 5544 | "tier_key": {
|
5545 | 5545 | "title": "Tier key",
|
5546 |
| - "description": "The header name containing the tier name. The string you provide is case-insensitive. If you need to take the value from a place that is not a header (a token, an API key), you must use propagate functions in the components that convert values to internal headers.\n\nSee: /docs/enterprise/service-settings/tiered-rate-limit/", |
| 5546 | + "description": "The header name containing the tier name. The string you provide is case-insensitive. If you need to take the value from a place that is not a header (a token, an API key), you must use propagate functions in the components that convert values to internal headers.\n\nSee: https://www.krakend.io/docs/enterprise/docs/enterprise/service-settings/tiered-rate-limit/", |
5547 | 5547 | "type": "string"
|
5548 | 5548 | },
|
5549 | 5549 | "tiers": {
|
5550 | 5550 | "title": "Tiers",
|
5551 |
| - "description": "The list of all tier definitions and limits for each. Each item in the list is a tier object.\n\nSee: /docs/enterprise/service-settings/tiered-rate-limit/", |
| 5551 | + "description": "The list of all tier definitions and limits for each. Each item in the list is a tier object.\n\nSee: https://www.krakend.io/docs/enterprise/docs/enterprise/service-settings/tiered-rate-limit/", |
5552 | 5552 | "type": "array",
|
5553 | 5553 | "items": {
|
5554 | 5554 | "type": "object",
|
5555 | 5555 | "properties": {
|
5556 | 5556 | "ratelimit": {
|
5557 | 5557 | "title": "Ratelimit",
|
5558 |
| - "description": "The rate limit definition. This is an object with the same attributes the [service rate limit](https://www.krakend.io/docs/enterprise/service-settings/service-rate-limit/) has.\n\nSee: /docs/enterprise/service-settings/tiered-rate-limit/", |
| 5558 | + "description": "The rate limit definition. This is an object with the same attributes the [service rate limit](https://www.krakend.io/docs/enterprise/service-settings/service-rate-limit/) has.\n\nSee: https://www.krakend.io/docs/enterprise/docs/enterprise/service-settings/tiered-rate-limit/", |
5559 | 5559 | "$ref": "#/definitions/https%3A~1~1www.krakend.io~1schema~1v2.8~1qos~1ratelimit~1router.json",
|
5560 | 5560 | "type": "object"
|
5561 | 5561 | },
|
5562 | 5562 | "redis_ratelimit": {
|
5563 | 5563 | "title": "Redis Ratelimit",
|
5564 |
| - "description": "The redis-backed rate limit definition.", |
| 5564 | + "description": "The stateful rate limit definition. This is an object with the same attributes the [stateful service rate limit](http://localhost:1313/docs/enterprise/throttling/global-rate-limit/) has.\n\nSee: https://www.krakend.io/docs/enterprise/docs/enterprise/service-settings/tiered-rate-limit/", |
5565 | 5565 | "$ref": "#/definitions/https%3A~1~1www.krakend.io~1schema~1v2.8~1qos~1ratelimit~1redis.json",
|
5566 | 5566 | "type": "object"
|
5567 | 5567 | },
|
5568 | 5568 | "tier_value": {
|
5569 | 5569 | "title": "Tier value",
|
5570 |
| - "description": "The tier value. When you use `literal`, it is the tier name. When you use `policy`, it is the expression you want to evaluate to determine if the user matches this tier or not (see security policies for syntax).\n\nSee: /docs/enterprise/service-settings/tiered-rate-limit/", |
| 5570 | + "description": "The tier value. When you use `literal`, it is the tier name. When you use `policy`, it is the expression you want to evaluate to determine if the user matches this tier or not (see security policies for syntax).\n\nSee: https://www.krakend.io/docs/enterprise/docs/enterprise/service-settings/tiered-rate-limit/", |
5571 | 5571 | "examples": [
|
5572 | 5572 | "gold",
|
5573 | 5573 | "silver",
|
|
5578 | 5578 | },
|
5579 | 5579 | "tier_value_as": {
|
5580 | 5580 | "title": "Tier value as",
|
5581 |
| - "description": "Determines how to parse the value found in the tier header. When `literal` is used, the exact value of the header is compared against the tier name. When `policy` is used, the value is used to evaluate a policy. When `*` is used, all values will match. Make sure to put the `*` as the last tier; otherwise the rest will be ignored.\n\nSee: /docs/enterprise/service-settings/tiered-rate-limit/", |
| 5581 | + "description": "Determines how to parse the value found in the tier header. When `literal` is used, the exact value of the header is compared against the tier name. When `policy` is used, the value is used to evaluate a policy. When `*` is used, all values will match. Make sure to put the `*` as the last tier; otherwise the rest will be ignored.\n\nSee: https://www.krakend.io/docs/enterprise/docs/enterprise/service-settings/tiered-rate-limit/", |
5582 | 5582 | "default": "literal",
|
5583 | 5583 | "enum": [
|
5584 | 5584 | "literal",
|
|
5664 | 5664 | },
|
5665 | 5665 | "max_retries": {
|
5666 | 5666 | "title": "Max retries",
|
5667 |
| - "description": "The maximum number of retries when the connection fails. Use `-1` to never retry (it might not be a good idea)", |
| 5667 | + "description": "The number of times you want to retry a Redis command using a different connection from the pool, applying a random delay between `min_retry_backoff` and `max_retry_backoff`. Use `-1` to never retry (it might not be a good idea)", |
5668 | 5668 | "default": 3,
|
5669 | 5669 | "type": "integer"
|
5670 | 5670 | },
|
|
5692 | 5692 | "description": "The connection pool name. This is an arbitrary name used to reference this connection in other parts of the configuration needing Redis.",
|
5693 | 5693 | "examples": [
|
5694 | 5694 | "shared_instance",
|
5695 |
| - "redis_for_ratelimit" |
| 5695 | + "Redis_for_ratelimit" |
5696 | 5696 | ],
|
5697 | 5697 | "type": "string"
|
5698 | 5698 | },
|
|
5743 | 5743 | },
|
5744 | 5744 | "pool_size": {
|
5745 | 5745 | "title": "Pool size",
|
5746 |
| - "description": "The pool size for this connection. When `0` it maps to its default 10", |
| 5746 | + "description": "The pool size defines the number of concurrent Redis commands that can be executed by this Redis pool. Take into account that this only saves the connection time to the server, but, Redis will still be a non-concurrent service. When `0` it maps to its default 10", |
5747 | 5747 | "default": 10,
|
5748 | 5748 | "type": "integer"
|
5749 | 5749 | },
|
|
5755 | 5755 | },
|
5756 | 5756 | "tls": {
|
5757 | 5757 | "title": "tls",
|
5758 |
| - "description": "An object with any [client TLS configuration](/docs/enterprise/service-settings/tls/#client-tls-settings) to this connection", |
| 5758 | + "description": "An object with any [client TLS configuration](/docs/enterprise/service-settings/tls/#client-tls-settings) to this connection", |
5759 | 5759 | "$ref": "#/definitions/https%3A~1~1www.krakend.io~1schema~1v2.8~1client_tls.json",
|
5760 | 5760 | "type": "object"
|
5761 | 5761 | },
|
|
0 commit comments