From a683bfdc7aa25a3de061a213874ffd3fc749ba91 Mon Sep 17 00:00:00 2001
From: Andrew Valleteau <avallete@users.noreply.github.com>
Date: Thu, 6 Mar 2025 13:16:19 +0100
Subject: [PATCH] feat(docs): document ratelimits configurations (#33830)

* feat(docs): document ratelimits configurations

* chore: fix fields name

* chore: update auth.rate_limit api
---
 apps/docs/spec/cli_v1_config.yaml | 66 +++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)

diff --git a/apps/docs/spec/cli_v1_config.yaml b/apps/docs/spec/cli_v1_config.yaml
index 857b222f7d3..0d858465f2d 100644
--- a/apps/docs/spec/cli_v1_config.yaml
+++ b/apps/docs/spec/cli_v1_config.yaml
@@ -736,6 +736,72 @@ parameters:
       - name: 'Auth Server configuration'
         link: 'https://supabase.com/docs/reference/auth'
 
+  - id: 'auth.rate_limit.email_sent'
+    title: 'auth.rate_limit.email_sent'
+    tags: ['auth']
+    required: false
+    default: '2'
+    description: |
+      Number of emails that can be sent per hour. Requires auth.email.smtp to be enabled.
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'auth.rate_limit.sms_sent'
+    title: 'auth.rate_limit.sms_sent'
+    tags: ['auth']
+    required: false
+    default: '30'
+    description: |
+      Number of SMS messages that can be sent per hour. Requires auth.sms to be enabled.
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'auth.rate_limit.anonymous_users'
+    title: 'auth.rate_limit.anonymous_users'
+    tags: ['auth']
+    required: false
+    default: '30'
+    description: |
+      Number of anonymous sign-ins that can be made per hour per IP address. Requires enable_anonymous_sign_ins = true.
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'auth.rate_limit.token_refresh'
+    title: 'auth.rate_limit.token_refresh'
+    tags: ['auth']
+    required: false
+    default: '150'
+    description: |
+      Number of sessions that can be refreshed in a 5 minute interval per IP address.
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'auth.rate_limit.sign_in_sign_ups'
+    title: 'auth.rate_limit.sign_in_sign_ups'
+    tags: ['auth']
+    required: false
+    default: '30'
+    description: |
+      Number of sign up and sign-in requests that can be made in a 5 minute interval per IP address (excludes anonymous users).
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'auth.rate_limit.token_verifications'
+    title: 'auth.rate_limit.token_verifications'
+    tags: ['auth']
+    required: false
+    default: '30'
+    description: |
+      Number of OTP / Magic link verifications that can be made in a 5 minute interval per IP address.
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
   - id: 'auth.enable_signup'
     title: 'auth.enable_signup'
     tags: ['auth']