[RateLimiter] Adding config reference for policy and lock_factory

Nyholm · javiereguiluz · commit c39447ab9ddd · 2020-12-28T15:21:25.000+01:00
diff --git a/rate_limiter.rst b/rate_limiter.rst
@@ -16,6 +16,8 @@ Symfony uses these rate limiters in built-in features like "login throttling",
 which limits how many failed login attempts a user can make in a given period of
 time, but you can use them for your own features too.
 
+.. _rate-limiter-policies:
+
 Rate Limiting Policies
 ----------------------
 
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
@@ -211,6 +211,13 @@ Configuration
 
   * :ref:`enabled <reference-property-info-enabled>`
 
+* `rate_limiter`_:
+
+  * :ref:`name <reference-rate-limiter-name>`
+
+    * `lock_factory`_
+    * `policy`_
+
 * `request`_:
 
   * `formats`_
@@ -1220,6 +1227,35 @@ dsn
 
 The DSN where to store the profiling information.
 
+rate_limiter
+~~~~~~~~~~~~
+
+.. _reference-rate-limiter-name:
+
+name
+....
+
+**type**: ``prototype``
+
+Name of the rate limiter you want to create.
+
+lock_factory
+""""""""""""
+
+**type**: ``string`` **default:** ``lock.factory``
+
+The service that is used to create a lock. The service has to implement the
+:class:`Symfony\\Component\\Lock\\LockFactoryInterface`.
+
+policy
+""""""
+
+**type**: ``string`` **required**
+
+The name of the rate limiting algorithm to use. Example names are ``fixed_window``,
+``sliding_window`` and ``no_limit``. See :ref:`Rate Limiter Policies <rate-limiter-policies>`)
+for more information.
+
 request
 ~~~~~~~
 
