Add rate limits info to docs #1836
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bastienbeurier
approved these changes
Mar 11, 2024
bodinsamuel
approved these changes
Mar 11, 2024
| - `X-RateLimit-Remaining` shows how many requests are remaining before the limit is reached. | ||
| - `X-RateLimit-Reset` provides a Unix timestamp representing the time at which the current rate limit window resets, and the remaining request count is replenished. | ||
|
|
||
| If a client exceeds the rate limit, the API will respond with a 429 `Too Many Requests` status code. In this case, the `Retry-After` header is included, indicating the number of seconds the client should wait before making another request to avoid being rate-limited. |
There was a problem hiding this comment.
No documentation about the actual limit?
There was a problem hiding this comment.
The point of the headers is to specify the actual limit. It is easier not to mention the limit imho so docs doesn't have to be changed when we modify the limit or if we start implementing different limits for different endpoints/group of endpoints.
TBonnin
force-pushed
the
tbonnin/NAN-536/document-rate-limits
branch
from
3880bf9
to
8dc9f2f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Adding docs to describe global rate limiting
Issue ticket number and link
https://linear.app/nango/issue/NAN-536/document-global-rate-limit