Skip to content

Commit

Permalink
fix: isUnlimited note added
Browse files Browse the repository at this point in the history
  • Loading branch information
Changolaxtra committed Dec 14, 2023
1 parent fba636d commit e505ceb
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ public class ApiApplication {
The library default policy can be overridden by adding the below configuration to
the `application.yaml` or `application.properties` file.

The default policy reads the `X-API-Key`, the **API Key** is `blank` and _only one request can be
The default policy reads the `X-API-Key` header in the HTTP Request, the **API Key** is `blank` and _only one request can be
processed by minute_.

**Note**: If `isUnlimited` is set as `true`, it means that all the request for that API Key will be processed and the other parameters will be ignored.

````yaml
rate-limiter:
apiKey-header-name: "X-API-Key"
Expand All @@ -51,6 +53,9 @@ This library allows to create more **API Key Policies**, by creating the model a

- Example of creating and adding one policy:

**Note**: If `isUnlimited` is set as `true`, it means that all the request for that API Key will be processed and the other parameters will be ignored.


````java
import com.changolaxtra.cloud.ratelimiter.core.PlanLimitBucket;
import com.changolaxtra.cloud.ratelimiter.core.policy.RateLimitPolicy;
Expand Down

0 comments on commit e505ceb

Please sign in to comment.