-
Notifications
You must be signed in to change notification settings - Fork 477
Add rate limit to CCAPI doc #20356
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add rate limit to CCAPI doc #20356
Conversation
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
Files changed: |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
laurenbarker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I fully missed that comment by not scrolling down in the Jira... so I'll add that in a sec! |
a1dbd36 to
9e46d11
Compare
| {{site.data.alerts.end}} | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| The Cloud API is rate-limited to 10 requests per second per user. When a request exceeds this limit, it receives an HTTP response with the `Retry-After` header and a "rate limit exceeded" message. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would also be nice to mention the response code. It should be an http 429. https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/429
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds like the code used may be inconsistent as a bug, opting to keep generic for now
https://cockroachlabs.atlassian.net/browse/DOC-14635