Merge pull request #33 from eadwinCode/controller_throttle_doc

Doc update

Author: eadwinCode

docs/settings.md

@@ -9,6 +9,15 @@ NINJA_EXTRA = {
     'PAGINATION_CLASS':"ninja_extra.pagination.PageNumberPaginationExtra",
     'PAGINATION_PER_PAGE': 100,
     'INJECTOR_MODULES': [],
+    'THROTTLE_CLASSES': [
+        "ninja_extra.throttling.AnonRateThrottle",
+        "ninja_extra.throttling.UserRateThrottle",
+    ],
+    'THROTTLE_RATES': {
+        'user': '1000/day',
+        'anon': '100/day',
+    },
+    'NUM_PROXIES': None
 }
 ```
 You can override what you don't need. It is not necessary need to override everything.
@@ -30,3 +39,18 @@ default: `100`
 It contains a list of strings that defines the path to injector `Module`.
 default: `[]`
 
+`THROTTLE_CLASSES`
+=======================
+It contains a list of strings that defines the path default throttling classes.
+default: `[
+    "ninja_extra.throttling.AnonRateThrottle",
+    "ninja_extra.throttling.UserRateThrottle",
+]`
+
+`THROTTLE_RATES`
+=======================
+It contains a key-value pair of different throttling rates which are applies to different `THROTTLING_CLASSES`.
+default: `{
+    'user': '1000/day',
+    'anon': '100/day',
+}`

docs/tutorial/throttling.md

@@ -177,3 +177,43 @@ def get_user_by_id(request, id: int):
     return 'foo'
 ```
 Here, we dynamically applied `sustained` rates and `burst` rates to `get_users` and `get_user_by_id` respectively
+
+
+!!! info "new in v0.15.8"
+    You can throttle all controller endpoints actions at the controller class level
+
+## **Controller Throttling**
+
+```python
+# api.py
+from ninja_extra import (
+    NinjaExtraAPI, throttle, api_controller, ControllerBase,
+    http_get
+)
+from ninja_extra.throttling import DynamicRateThrottle
+api = NinjaExtraAPI()
+
+@api_controller("/throttled-controller")
+class ThrottlingControllerSample(ControllerBase):
+    throttling_classes = [
+        DynamicRateThrottle,
+    ]
+    throttling_init_kwargs = dict(scope="sustained")
+
+    @http_get("/endpoint_1")
+    @throttle(DynamicRateThrottle, scope='burst')
+    def endpoint_1(self, request):
+        # this will override the generally throttling applied at the controller
+        return "foo"
+
+    @http_get("/endpoint_2")
+    def endpoint_2(self, request):
+        return "foo"
+
+    @http_get("/endpoint_3")
+    def endpoint_3(self, request):
+        return "foo"
+
+
+api.register_controllers(ThrottlingControllerSample)
+```