Commitc39447a

authored and

committed

[RateLimiter] Adding config reference for policy and lock_factory

1 parent064bb18 commitc39447aCopy full SHA for c39447a

File tree

+38

-0

lines changed

+38

-0

lines changed

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@ Symfony uses these rate limiters in built-in features like "login throttling",`
`16`	`16`	`which limits how many failed login attempts a user can make in a given period of`
`17`	`17`	`time, but you can use them for your own features too.`
`18`	`18`
	`19`	`+.. _rate-limiter-policies:`
	`20`	`+`
`19`	`21`	`Rate Limiting Policies`
`20`	`22`	`----------------------`
`21`	`23`

Lines changed: 36 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -211,6 +211,13 @@ Configuration`
`211`	`211`
`212`	`212`	*:ref:`enabled<reference-property-info-enabled>`
`213`	`213`
	`214`	+* `rate_limiter`_:
	`215`	`+`
	`216`	+ *:ref:`name<reference-rate-limiter-name>`
	`217`	`+`
	`218`	+ * `lock_factory`_
	`219`	+ * `policy`_
	`220`	`+`
`214`	`221`	* `request`_:
`215`	`222`
`216`	`223`	* `formats`_
`@@ -1220,6 +1227,35 @@ dsn`
`1220`	`1227`
`1221`	`1228`	`The DSN where to store the profiling information.`
`1222`	`1229`
	`1230`	`+rate_limiter`
	`1231`	`+~~~~~~~~~~~~`
	`1232`	`+`
	`1233`	`+.. _reference-rate-limiter-name:`
	`1234`	`+`
	`1235`	`+name`
	`1236`	`+....`
	`1237`	`+`
	`1238`	+type: ``prototype``
	`1239`	`+`
	`1240`	`+Name of the rate limiter you want to create.`
	`1241`	`+`
	`1242`	`+lock_factory`
	`1243`	`+""""""""""""`
	`1244`	`+`
	`1245`	+type: ``string`` default: ``lock.factory``
	`1246`	`+`
	`1247`	`+The service that is used to create a lock. The service has to implement the`
	`1248`	+:class:`Symfony\\Component\\Lock\\LockFactoryInterface`.
	`1249`	`+`
	`1250`	`+policy`
	`1251`	`+""""""`
	`1252`	`+`
	`1253`	+type: ``string`` required
	`1254`	`+`
	`1255`	+The name of the rate limiting algorithm to use. Example names are ``fixed_window``,
	`1256`	+``sliding_window`` and ``no_limit``. See:ref:`Rate Limiter Policies<rate-limiter-policies>`)
	`1257`	`+for more information.`
	`1258`	`+`
`1223`	`1259`	`request`
`1224`	`1260`	`~~~~~~~`
`1225`	`1261`

Comments

(0)