Skip to content

docs: add rate limits section to API reference#5230

Merged
varonix0 merged 2 commits intomainfrom
ENG-4141
Jan 22, 2026
Merged

docs: add rate limits section to API reference#5230
varonix0 merged 2 commits intomainfrom
ENG-4141

Conversation

@x032205
Copy link
Member

@x032205 x032205 commented Jan 22, 2026

Context

Add rate limits section to API reference

Screenshots

image

Type

  • Fix
  • Feature
  • Improvement
  • Breaking
  • Docs
  • Chore

Checklist

  • Title follows the conventional commit format: type(scope): short description (scope is optional, e.g., fix: prevent crash on sync or fix(api): handle null response).
  • Tested locally
  • Updated docs (if needed)
  • Read the contributing guide

@maidul98
Copy link
Collaborator

maidul98 commented Jan 22, 2026

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 22, 2026

Greptile Summary

Added new Rate Limits section to API reference documentation explaining the three types of rate limits (Read, Write, Secret). However, the documented default values don't match the actual implementation in the backend code.

  • The documentation states defaults are 300 for read and secret operations, and 200 for write operations
  • Backend implementation shows different values depending on deployment type (cloud: 60/40/200, database schema: 600/60/200, self-hosted: 60/60/200)

The documentation needs correction to reflect accurate default values and clarify which values apply to cloud versus self-hosted deployments.

Confidence Score: 2/5

  • Documentation contains factual inaccuracies that will mislead users about actual rate limit behavior
  • The PR adds useful documentation but contains incorrect default values that don't match the backend implementation. This creates a documentation-code mismatch that could confuse users and lead to incorrect assumptions about API behavior.
  • Pay close attention to docs/api-reference/overview/introduction.mdx - verify correct rate limit values before merging

Important Files Changed

Filename Overview
docs/api-reference/overview/introduction.mdx Added rate limits section with inaccurate default values - documented limits (300/300/200) don't match implementation (60/60/200 for cloud, 600/60/200 for DB schema)

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

@varonix0 varonix0 merged commit 60e1fc4 into main Jan 22, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants