Rate limiter documentation

docs/user-guide/api-mediation/configuration-rate-limiter.md

@@ -0,0 +1,27 @@
+# Configuring custom rate limiter
+
+
+The API Gateway offers a way to customize rate limit per service by introducing a configurable rate limiter.
+Below is an example configuration:
+# >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+    apiml:
+        gateway: 
+            routing: 
+                rateLimiterCapacity: 20
+                rateLimiterTokens: 20
+                rateLimiterRefillDuration: 1
+                servicesToLimitRequestRate: apicatalog
+
+
+
+Description:
+1. Set rate limiting properties:
+
+* rateLimiterCapacity - Defines the total number of requests that can be allowed at one time per user.
+* rateLimiterTokens -  Defines the number of requests that are added to the service’s allowance at regular intervals. This controls how quickly requests are replenished after being consumed.
+* rateLimiterRefillDuration -  Sets the time interval (in minutes) at which new requests (or tokens) are added.
+
+2. Define services to limit:
+
+   Use servicesToLimitRequestRate to specify a list of services to limit.
+

docs/user-guide/api-mediation/configuration-routing.md

@@ -25,6 +25,8 @@ The Gateway retry policy, customizable through zowe.yaml, optimizes request hand
 
 To customize the Gateway retry policy, see [Customizing Gateway retry policy](./configuration-gateway-retry-policy.md).
 
+To configure a custom rate limiter, see [Configuring custom rate limiter](./configuration-rate-limiter.md).
+
 Additionally, API ML supports specific instance access and load balancer cache distribution, improving service identification and scalability. These configurations, including service ID adjustments for compatibility with Zowe v2, demonstrate Zowe's adaptability and robustness in API management.
 
 To configure a unique cookie name for each instance to prevent overwriting of the default cookie name in the case of multiple Zowe instances, or for more complex deployment strategies, see [Configuring a unique cookie name for a specific API ML instance](./configuration-unique-cookie-name-for-multiple-zowe-instances.md).