doc: Add rate limiting extensions

TheThingsIndustries · Nov 21, 2023 · 3cdfc91 · 3cdfc91
1 parent d32eb35
commit 3cdfc91
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/doc/content/reference/rate-limiting/_index.md b/doc/content/reference/rate-limiting/_index.md
@@ -67,7 +67,7 @@ This section lists resources of {{% tts %}} on which a maximum rate limit can be
 
 {{< rate-limiting >}}
 
-{{< note >}} gRPC Requests support multiple classes. This is to enable overriding the generic rate limits for specific gRPC methods. {{</ note >}}
+{{< note >}} Both gRPC methods and HTTP endpoints support multiple classes. This enables overriding the generic rate limits for specific methods and endpoints. {{</ note >}}
 
 {{< warning >}} When {{% tts %}} HTTP and gRPC endpoints are served behind a reverse proxy, the `X-Forwarded-For` header is respected for the remote IP. The IP address of the reverse proxy must be trusted by {{% tts %}} for this to work, see [HTTP options]({{< ref "/reference/configuration/the-things-stack#http-options" >}}) and [gRPC Options]({{< ref "/reference/configuration/the-things-stack#grpc-options" >}}). {{</ warning >}}
 

diff --git a/doc/data/rate-limiting.yml b/doc/data/rate-limiting.yml
@@ -89,10 +89,11 @@
     - http:gcs:cups
     - http
 
-- resource: OAuth Server, Account App, Gateway Configuration Server, Interop Server, Metrics, Health, pprof
-  description: Limit number of HTTP requests by remote IP and request URL. `{{ Server }}` is `oauth`, `account`, `gcs`, `interop`, `metrics`, `health`, `pprof` respectively.
-  key: http:{{ Server }}:ip:{{ RemoteIP }}:url:{{ URL }}
+- resource: OAuth Server, Account App, Gateway Configuration Server, Interop Server, Metrics, Health, pprof, Azure IoT Central integration
+  description: Limit number of HTTP requests by remote IP and request URL. `{{ Server }}` is `oauth`, `account`, `gcs`, `interop`, `metrics`, `health`, `pprof` or `as:io:packages:azure:iotcentral` respectively. `{{ AuthInfo }}` is either `ip:{{ RemoteIP }}` or `token:{{ AuthTokenID }}` if the caller presents authentication information.
+  key: http:{{ Server }}:{{ AuthInfo }}:url:{{ URL }}
   example-key: http:oauth:ip:10.10.10.10:url:/authorize
   classes:
+    - http:{{ Server }}:{{ URLTemplate }}
     - http:{{ Server }}
     - http
diff --git a/doc/themes/the-things-stack/layouts/shortcodes/rate-limiting.html b/doc/themes/the-things-stack/layouts/shortcodes/rate-limiting.html
@@ -6,7 +6,7 @@ <h3 id="{{.resource | urlize}}">{{- .resource -}}</h3>
   <table class="fixed">
     <tbody>
       <tr>
-        <td><b>Description</b></td><td>{{ index . "description" }}</td>
+        <td><b>Description</b></td><td>{{ (index . "description") | transform.Markdownify }}</td>
       </tr>
       <tr>
         <td><b>Classes</b></td><td><code>{{- delimit (index . "classes") "</code> <code>" }}</code></td>