vasceannie/nhost
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix (docs): update rate-limit to reflect reality (#2870)

Browse Source 
### **PR Type**
Documentation


___

### **Description**
- Updated the rate limit for email sending endpoints in the
documentation
- Changed the limit from 50 per hour to 10 per hour for projects without
custom SMTP settings
- This change reflects the actual rate limit implemented in the system
- No other changes were made to the rate limits table or surrounding
text


___



### **Changes walkthrough** 📝
<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>rate-limits.mdx</strong><dd><code>Update email rate
limit in documentation</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; </dd></summary>
<hr>

docs/platform/rate-limits.mdx

<li>Updated the rate limit for email sending endpoints from 50/hour to
<br>10/hour for projects without custom SMTP settings<br>


</details>


  </td>
<td><a
href="https://github.com/nhost/nhost/pull/2870/files#diff-d6c7ab75a347c1217107fdcf841312df268708bc7d319f528ea67c7280f00284">+1/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>                    
</table></td></tr></tr></tbody></table>

___

> 💡 **PR-Agent usage**:
>Comment `/help` on the PR to get a list of all available PR-Agent tools
and their descriptions

---------

Co-authored-by: Hassan Ben Jobrane <hsanbenjobrane@gmail.com>
This commit is contained in:
David Barroso
2024-09-13 12:19:08 +02:00
committed by GitHub
parent 9735fa238b
commit db2f44d7c0
4 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.changeset/neat-carpets-play.md Normal file
View File

@@ -0,0 +1,5 @@
---
'@nhost/docs': patch
---
fix: update rate-limit to reflect reality

2
docs/platform/rate-limits.mdx
View File

@@ -45,7 +45,7 @@ Given that not all endpoints are equally sensitive, Auth supports more complex r
| Endpoints | Key | Limits | Description | Minimum version |
| ----------------------|-----|--------|-------------|-----------------|
| Any that sends emails<sup>1</sup> | Global | 50 / hour | Not configurable. This limit applies to any project without custom SMTP settings | 0.33.0 |
| Any that sends emails<sup>1</sup> | Global | 10 / hour | Not configurable. This limit applies to any project without custom SMTP settings | 0.33.0 |
| Any that sends emails<sup>1</sup> | Client IP | 10 / hour | Configurable. This limit applies to any project with custom SMTP settings and is configurable | 0.33.0 |
| Any that sends SMS<sup>2</sup> | Client IP | 10 / hour | Configurable. | 0.33.0 |
| Any endpoint that an attacker may try to brute-force. This includes sign-in and verify endpoints<sup>3</sup> | Client IP | 10 / 5 minutes | Configurable | 0.33.0 |

3
package.json
View File

@@ -155,7 +155,8 @@
"react": "18.2.0",
"react-dom": "18.2.0",
"@graphiql/react": "^0.22.3",
"send": "^0.19.0"
"send": "^0.19.0",
"dset": "^3.1.4"
}
}
}

11
pnpm-lock.yaml generated
View File

@@ -61,6 +61,7 @@ overrides:
react-dom: 18.2.0
'@graphiql/react': ^0.22.3
send: ^0.19.0
dset: ^3.1.4
importers:
@@ -6915,7 +6916,7 @@ packages:
dependencies:
'@graphql-typed-document-node/core': 3.2.0(graphql@16.8.1)
cross-inspect: 1.0.1
dset: 3.1.3
dset: 3.1.4
graphql: 16.8.1
tslib: 2.7.0
dev: true
@@ -6979,7 +6980,7 @@ packages:
'@graphql-typed-document-node/core': 3.2.0(graphql@16.8.1)
'@graphql-yoga/subscription': 2.2.3
'@whatwg-node/fetch': 0.3.2
dset: 3.1.3
dset: 3.1.4
graphql: 16.8.1
tslib: 2.7.0
transitivePeerDependencies:
@@ -17699,8 +17700,8 @@ packages:
engines: {node: '>=10'}
dev: true
/dset@3.1.3:
resolution: {integrity: sha512-20TuZZHCEZ2O71q9/+8BwKwZ0QtD9D8ObhrihJPr+vLLYlSuAU3/zL4cSlgbfeoGHTjCSJBa7NGcrF9/Bx/WJQ==}
/dset@3.1.4:
resolution: {integrity: sha512-2QF/g9/zTaPDc3BjNcVTGoBbXBgYfMTTceLaYcFJ/W9kggFUkhxD/hMEeuLKbugyef9SqAx8cpgwlIP/jinUTA==}
engines: {node: '>=4'}
/duplexer2@0.1.4:
@@ -20758,7 +20759,7 @@ packages:
'@graphql-yoga/subscription': 3.1.0
'@whatwg-node/fetch': 0.8.8
'@whatwg-node/server': 0.7.7
dset: 3.1.3
dset: 3.1.4
graphql: 16.8.1
lru-cache: 7.18.3
tslib: 2.7.0